Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation for Listener Callbacks #4700

Open
nibanks opened this issue Dec 10, 2024 · 4 comments
Open

Improve Documentation for Listener Callbacks #4700

nibanks opened this issue Dec 10, 2024 · 4 comments
Labels
Milestone

Comments

@nibanks
Copy link
Member

nibanks commented Dec 10, 2024

Discussed in #4698

Originally posted by Streamlet December 10, 2024
The documents for quic functions is very detail, but there is few for callbacks.
Would you add more documents for each parameters of each kind of callbacks?

@nibanks nibanks added Area: Documentation external Proposed by non-MSFT labels Dec 10, 2024
@nibanks nibanks added this to the Future milestone Dec 10, 2024
@Streamlet
Copy link

Not only listener callbacks, but also Connection callnacks and Stream callacks

@Streamlet
Copy link

Streamlet commented Dec 11, 2024

QUIC_LISTENER_EVENT_NEW_CONNECTION      = 0,
QUIC_LISTENER_EVENT_STOP_COMPLETE       = 1,





QUIC_CONNECTION_EVENT_CONNECTED                         = 0,
QUIC_CONNECTION_EVENT_SHUTDOWN_INITIATED_BY_TRANSPORT   = 1,
QUIC_CONNECTION_EVENT_SHUTDOWN_INITIATED_BY_PEER        = 2,
QUIC_CONNECTION_EVENT_SHUTDOWN_COMPLETE                 = 3,
QUIC_CONNECTION_EVENT_LOCAL_ADDRESS_CHANGED             = 4,
QUIC_CONNECTION_EVENT_PEER_ADDRESS_CHANGED              = 5,
QUIC_CONNECTION_EVENT_PEER_STREAM_STARTED               = 6,
QUIC_CONNECTION_EVENT_STREAMS_AVAILABLE                 = 7,
QUIC_CONNECTION_EVENT_PEER_NEEDS_STREAMS                = 8,
QUIC_CONNECTION_EVENT_IDEAL_PROCESSOR_CHANGED           = 9,
QUIC_CONNECTION_EVENT_DATAGRAM_STATE_CHANGED            = 10,
QUIC_CONNECTION_EVENT_DATAGRAM_RECEIVED                 = 11,
QUIC_CONNECTION_EVENT_DATAGRAM_SEND_STATE_CHANGED       = 12,
QUIC_CONNECTION_EVENT_RESUMED                           = 13,
QUIC_CONNECTION_EVENT_RESUMPTION_TICKET_RECEIVED        = 14,
QUIC_CONNECTION_EVENT_PEER_CERTIFICATE_RECEIVED         = 15,
QUIC_CONNECTION_EVENT_RELIABLE_RESET_NEGOTIATED         = 16,
QUIC_CONNECTION_EVENT_ONE_WAY_DELAY_NEGOTIATED          = 17,
QUIC_CONNECTION_EVENT_NETWORK_STATISTICS                = 18,





QUIC_STREAM_EVENT_START_COMPLETE            = 0,
QUIC_STREAM_EVENT_RECEIVE                   = 1,
QUIC_STREAM_EVENT_SEND_COMPLETE             = 2,
QUIC_STREAM_EVENT_PEER_SEND_SHUTDOWN        = 3,
QUIC_STREAM_EVENT_PEER_SEND_ABORTED         = 4,
QUIC_STREAM_EVENT_PEER_RECEIVE_ABORTED      = 5,
QUIC_STREAM_EVENT_SEND_SHUTDOWN_COMPLETE    = 6,
QUIC_STREAM_EVENT_SHUTDOWN_COMPLETE         = 7,
QUIC_STREAM_EVENT_IDEAL_SEND_BUFFER_SIZE    = 8,
QUIC_STREAM_EVENT_PEER_ACCEPTED             = 9,
QUIC_STREAM_EVENT_CANCEL_ON_LOSS            = 10,

@Streamlet
Copy link

and members of these structures:

QUIC_LISTENER_EVENT
QUIC_CONNECTION_EVENT
QUIC_STREAM_EVENT

@Streamlet
Copy link

and return values for each callback.

for QUIC_STREAM_EVENT_RECEIVE, QUIC_STATUS_CONTINUE can be returned, as Using Streams says.

simply return QUIC_STATUS_SUCCESS for all other cases? is there any special cases like QUIC_STREAM_EVENT_RECEIVE?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants