Skip to content

Commit

Permalink
Expand ConnectionOpen docs. (microsoft#1625)
Browse files Browse the repository at this point in the history
  • Loading branch information
anrossi authored May 21, 2021
1 parent 0640aed commit dba07db
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/api/ConnectionOpen.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,13 @@ The function returns a [QUIC_STATUS](QUIC_STATUS.md). The app may use `QUIC_FAIL
# Remarks
**TODO**
`ConnectionOpen` is used to create a connection in the client application. In server applications, [ListenerOpen](ListenerOpen.md) and [ListenerStart](ListenerStart.md) must be called to listen for incoming connection attempts, and the server side Connection is created in the `QUIC_LISTENER_EVENT_NEW_CONNECTION` event.
'ConnectionOpen' only allocates the resources for the connection, it does not start the connection. To start the connect, the application must call [ConnectionStart](ConnectionStart.md).
Once `ConnectionOpen` completes successfully, the application may create streams, and queue data for sending. This is when 0-RTT streams and data **MUST** be created and queued. See [StreamOpen](StreamOpen.md), and [StreamStart](StreamStart.md).
Once the connection has been shutdown, it must be cleaned up with a call to [ConnectionClose](ConnectionClose.md).
# See Also
Expand Down

0 comments on commit dba07db

Please sign in to comment.