Events for streams and connections when they close

[timprepscius]

Hey there again,

This is probably in some doc, but I have not found it.

So let's say that I create a connection, and then immediately create a stream (without the connection first establishing itself).

Then let's say:

1. The connection dies without establishing

Is either: QUIC_STREAM_EVENT_PEER_SEND_SHUTDOWN, or QUIC_STREAM_EVENT_PEER_SEND_ABORTED or QUIC_STREAM_EVENT_SHUTDOWN_COMPLETE signaled?

Is QUIC_CONNECTION_EVENT_SHUTDOWN_INITIATED_BY_TRANSPORT signaled?

2. Let's say the connection is established, but dies before the stream is created

Are any stream events signaled?
I assume the connection shutdown events are signaled.

3. Let's say the connection is established, and the stream is established.

I would assume both the stream events and the connection events are signaled. True?

Thanks so much.

This library is really clear so far. I wish it did the simultaneous server+client on a socket, but since this doesn't actually solve all the edge cases, maybe it is better it doesn't work at all.

[nibanks]

I've been working on stream API documentation all day. Some of it is still in PR and some of it is merged. What you want is in the StreamStart.md and StreamShutdown.md files. Essentially, If a stream isn't successfully started, then it won't get any events delivered to it. It has to do with a race condition between calling StreamOpen and an event firing. Since that's hard/impossible to handle, events aren't delivered until the app calls StreamStart; but if you don't call it, you get no events. Please let me know if you need additional clarification.

[nibanks]

The only tried and true solution is testing. Write tests that explicitly exercise all known code paths. I know of no other real solution that will give you confidence in the code.

[timprepscius]

For this library do you write your tests before writing code, or after code, or both?

[nibanks]

At the same time. If a PR fixes a bug that was previously uncaught, it should include a test the validates the fix. Any new feature work also needs to include corresponding tests. Tests are extremely important.

[nibanks]

https://github.com/microsoft/msquic/blob/main/.github/CONTRIBUTING.md#tests

[timprepscius]

Cool, interesting. Thanks again.