Skip to content

Commit fde9bf3

Browse files
docs: Adds note about serialization error case (#5617)
Co-authored-by: Carol Yeh <caroljye@amazon.com>
1 parent 2a871e3 commit fde9bf3

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

api/s2n.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3915,7 +3915,10 @@ S2N_API int s2n_connection_serialization_length(struct s2n_connection *conn, uin
39153915
* s2n_config object associated with this connection before this connection began its TLS handshake.
39163916
* @note Call `s2n_connection_serialization_length` to retrieve the amount of memory needed for the
39173917
* buffer parameter.
3918-
* @note This API will error if the handshake is not yet complete.
3918+
* @note This API will error if the handshake is not yet complete. Additionally it will error if there
3919+
* is still application data in the IO buffers given that this data does not get serialized by s2n-tls.
3920+
* You can use `s2n_send` to drain the send buffer and `s2n_peek` + `s2n_recv` to drain the read buffer.
3921+
* @note Serialization is unsupported for SSLv3 connections. See: https://github.com/aws/s2n-tls/issues/5538.
39193922
*
39203923
* @param conn A pointer to the connection object.
39213924
* @param buffer A pointer to the buffer where the serialized connection will be written.

0 commit comments

Comments
 (0)