diff options
| author | Hugo Landau <hlandau@openssl.org> | 2023-08-30 13:09:13 +0100 |
|---|---|---|
| committer | Hugo Landau <hlandau@openssl.org> | 2023-09-01 14:02:50 +0100 |
| commit | d2e9e12b23fe331b71abe8c201f2610266090dde (patch) | |
| tree | e9dae0b3942a2dd2d6b995f5430847c9799e0801 /doc | |
| parent | 8d7f034622c0235d06f4d6526f71dcab2f71b0c6 (diff) | |
QUIC APL: Allow stream origin to be queried
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21905)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/SSL_get_stream_id.pod | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/doc/man3/SSL_get_stream_id.pod b/doc/man3/SSL_get_stream_id.pod index 86ec2d9621..42ee08c814 100644 --- a/doc/man3/SSL_get_stream_id.pod +++ b/doc/man3/SSL_get_stream_id.pod @@ -3,8 +3,8 @@ =head1 NAME SSL_get_stream_id, SSL_get_stream_type, SSL_STREAM_TYPE_NONE, -SSL_STREAM_TYPE_READ, SSL_STREAM_TYPE_WRITE, SSL_STREAM_TYPE_BIDI - get QUIC -stream ID and stream type information +SSL_STREAM_TYPE_READ, SSL_STREAM_TYPE_WRITE, SSL_STREAM_TYPE_BIDI, +SSL_is_stream_local - get QUIC stream ID and stream type information =head1 SYNOPSIS @@ -18,6 +18,8 @@ stream ID and stream type information #define SSL_STREAM_TYPE_WRITE int SSL_get_stream_type(SSL *ssl); + int SSL_is_stream_local(SSL *ssl); + =head1 DESCRIPTION The SSL_get_stream_id() function returns the QUIC stream ID for a QUIC stream @@ -55,12 +57,16 @@ from. =back +The SSL_is_stream_local() function determines whether a stream was locally +created. + =head1 NOTES While QUICv1 assigns specific meaning to the low two bits of a QUIC stream ID, QUIC stream IDs in future versions of QUIC are not required to have the same semantics. Do not determine stream properties using these bits. Instead, use -SSL_get_stream_type() to determine the stream type. +SSL_get_stream_type() to determine the stream type and SSL_get_stream_origin() +to determine the stream initiator. The SSL_get_stream_type() identifies the type of a QUIC stream based on its identity, and does not indicate whether an operation can currently be @@ -79,6 +85,11 @@ always below 2**62. SSL_get_stream_type() returns one of the B<SSL_STREAM_TYPE> values. +SSL_is_stream_local() returns 1 if called on a QUIC stream SSL object which +represents a stream which was locally initiated. It returns 0 if called on a +QUIC stream SSL object which represents a stream which was remotely initiated by +a peer, and -1 if called on any other kind of SSL object. + =head1 SEE ALSO L<SSL_new_stream(3)>, L<SSL_accept_stream(3)> |