Function openthread_sys::otTcpSendEndOfStream

source ·
pub unsafe extern "C" fn otTcpSendEndOfStream(
    aEndpoint: *mut otTcpEndpoint,
) -> otError
Expand description

Informs the connection peer that this TCP endpoint will not send more data.

This should be used when the application has no more data to send to the connection peer. For this connection, future reads on the connection peer will result in the “end of stream” condition, and future writes on this connection endpoint will fail.

The “end of stream” condition only applies after any data previously provided to the TCP stack to send out has been received by the connection peer.

@param[in] aEndpoint A pointer to the TCP endpoint structure representing the TCP endpoint to shut down.

@retval OT_ERROR_NONE Successfully queued the “end of stream” condition for transmission. @retval OT_ERROR_FAILED Failed to queue the “end of stream” condition for transmission.