SSL_GET_STREAM_READ_STATE(3ossl)

💖 SSL_GET_STREAM_READ_STATE ✨

okay so bestie, real talk — this is OpenSSL, manual section 3ossl, and we're about to get so cozy with QUIC stream state. Like, what is your stream actually doing right now? Is it healthy? Is it done? Did somebody reset it? Did the whole connection ghost you? We're gonna find out. 🦋

---

🌸 NAME 🌸

SSL_get_stream_read_state, SSL_get_stream_write_state, SSL_get_stream_read_error_code, SSL_get_stream_write_error_code, SSL_STREAM_STATE_NONE, SSL_STREAM_STATE_OK, SSL_STREAM_STATE_WRONG_DIR, SSL_STREAM_STATE_FINISHED, SSL_STREAM_STATE_RESET_LOCAL, SSL_STREAM_STATE_RESET_REMOTE, SSL_STREAM_STATE_CONN_CLOSED — get QUIC stream state 💅

---

✨ SYNOPSIS ✨

#include <openssl/ssl.h>

#define SSL_STREAM_STATE_NONE
#define SSL_STREAM_STATE_OK
#define SSL_STREAM_STATE_WRONG_DIR
#define SSL_STREAM_STATE_FINISHED
#define SSL_STREAM_STATE_RESET_LOCAL
#define SSL_STREAM_STATE_RESET_REMOTE
#define SSL_STREAM_STATE_CONN_CLOSED

int SSL_get_stream_read_state(SSL *ssl);
int SSL_get_stream_write_state(SSL *ssl);

int SSL_get_stream_read_error_code(SSL *ssl, uint64_t *app_error_code);
int SSL_get_stream_write_error_code(SSL *ssl, uint64_t *app_error_code);

---

👑 DESCRIPTION 👑

so SSL_get_stream_read_state() and SSL_get_stream_write_state() are your little vibe-checkers 💅 — they pull the overall state of the receiving and sending parts of a QUIC stream respectively. Receiving part, sending part, two separate girls, two separate moods.

They both hand you back one of these:

• SSL_STREAM_STATE_NONE — bestie this is the "no thoughts, head empty" answer 🫠 you get it when you call this on a non-QUIC SSL object, or on a QUIC connection SSL object that doesn't have a default stream attached.
• SSL_STREAM_STATE_OK — everything's giving healthy and unbothered ✨ the stream hasn't been concluded and it's still in good shape.
• SSL_STREAM_STATE_WRONG_DIR — you went the wrong way down a one-way street 😭 this one shows up if you call SSL_get_stream_read_state() on a locally-initiated (and therefore send-only) unidirectional stream, or, flip side, if you call SSL_get_stream_write_state() on a remotely-initiated (and therefore receive-only) unidirectional stream.
• SSL_STREAM_STATE_FINISHED — the finale 🎀
  • for SSL_get_stream_read_state(), you get this when the remote peer has signalled the end of the receiving part of the stream. heads up though: there may still be residual data available to read via SSL_read(3) when this state comes back 👀
  • for SSL_get_stream_write_state(), you get this when the local application has concluded the stream using SSL_stream_conclude(3). Future SSL_write(3) calls will not succeed. it's over, it's done, periodt.
• SSL_STREAM_STATE_RESET_LOCAL — you did the resetting, main character energy 💅 this one shows when the applicable stream part was reset by the local application.
  • for SSL_get_stream_read_state(), this means the receiving part of the stream was aborted using a locally transmitted QUIC STOP_SENDING frame. It may or may not still be possible to obtain any residual data which remains to be read by calling SSL_read(3) — no promises, it's giving maybe.
  • for SSL_get_stream_write_state(), this means the sending part of the stream was aborted, for example because the application called SSL_stream_reset(3), or because a QUIC stream SSL object with an un-concluded sending part was freed using SSL_free(3). Calls to SSL_write(3) will fail. 💀
  • when this value is returned, the application error code which was signalled can be obtained by calling SSL_get_stream_read_error_code() or SSL_get_stream_write_error_code() as appropriate. get the receipts, girlie 🧾
• SSL_STREAM_STATE_RESET_REMOTE — they did the resetting, not you, we're innocent 🙈 this one shows when the applicable stream part was reset by the remote peer.
  • for SSL_get_stream_read_state(), this means the peer sent a QUIC RESET_STREAM frame for the receiving part of the stream; the receiving part of the stream was logically aborted by the peer.
  • for SSL_get_stream_write_state(), this means the peer sent a QUIC STOP_SENDING frame for the sending part of the stream; the peer has indicated that it does not wish to receive further data on the sending part of the stream. Calls to SSL_write(3) will fail. 💀
  • when this value is returned, the application error code which was signalled can be obtained by calling SSL_get_stream_read_error_code() or SSL_get_stream_write_error_code() as appropriate.
• SSL_STREAM_STATE_CONN_CLOSED — the whole connection the stream belongs to was closed 🚪😭 you can obtain information about the circumstances of this closure using SSL_get_conn_close_info(3). There may still be residual data available to read via SSL_read(3) when this state is returned. Calls to SSL_write(3) will fail. And here's the iconic little detail: SSL_get_stream_read_state() will return this state if and only if SSL_get_stream_write_state() will also return this state. matching outfits, always 👯

SSL_get_stream_read_error_code() and SSL_get_stream_write_error_code() provide the application error code which was signalled during non-normal termination of the receiving or sending parts of a stream, respectively. On success, the application error code is written to *app_error_code. there it is. in your variable. slay.

---

🫶 NOTES 🫶

If a QUIC connection is closed, the stream state for all streams transitions to SSL_STREAM_STATE_CONN_CLOSED, but no application error code can be retrieved using SSL_get_stream_read_error_code() or SSL_get_stream_write_error_code(), because the QUIC connection closure process does not cause an application error code to be associated with each individual stream still existing at the time of connection closure. like, the group chat got deleted, so no individual DMs survived, iykyk 😭

However, you can obtain the overall error code associated with the connection closure using SSL_get_conn_close_info(3). 💖

---

🌈 RETURN VALUES 🌈

SSL_get_stream_read_state() and SSL_get_stream_write_state() return one of the SSL_STREAM_STATE values. If called on a non-QUIC SSL object, or a QUIC connection SSL object without a default stream, SSL_STREAM_STATE_NONE is returned.

SSL_get_stream_read_error_code() and SSL_get_stream_write_error_code() return 1 on success and 0 if the stream was terminated normally. They return -1 on error — for example:

• if the stream is still healthy,
• or was still healthy at the time of connection closure,
• or if called on a stream for which the respective stream part does not exist (e.g. on a unidirectional stream),
• or if called on a non-QUIC object or a QUIC connection SSL object without a default stream attached.

ngl -1 is the "girl what" return value 😭 it means something above went sideways.

---

🦋 SEE ALSO 🦋

SSL_stream_conclude(3), SSL_stream_reset(3), SSL_new_stream(3), SSL_accept_stream(3), SSL_get_conn_close_info(3)

---

⭐ HISTORY ⭐

These functions were added in OpenSSL 3.2. they're not ancient, they're just babygirl ✨

---

💜 COPYRIGHT 💜

Copyright 2002-2023 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.

---

and that's the whole page bestie!! 💖 this was page SSL_GET_STREAM_READ_STATE(3ossl) from OpenSSL version 3.5.9, dated 2026-09-29 — go forth and check your stream states, you absolute icon 👑🦋💅