AbstractOutbound streams are opened by the local node, inbound streams are opened by the remote
Unique identifier for a stream. Identifiers are not unique across muxers.
ReadonlylogThe stream logger
User defined stream metadata
OptionalprotocolThe protocol negotiated for this stream
The current status of the readable end of the stream
The current status of the stream
Lifecycle times for the stream
The current status of the writable end of the stream
Optionalerr: ErrorOptionalerr: ErrorOptionalerr: ErrorClose immediately for reading and writing and send a reset message (local error)
Closes the stream for reading and writing.
Any buffered data in the source can still be consumed and the stream will end normally.
This will cause a CLOSE message to be sent to the remote, unless the sink has already ended.
The sink and the source will return normally.
Optionaloptions: AbortOptionsCloses the stream for reading. If iterating over the source of this stream in a for await of loop, it will return (exit the loop) after any buffered data has been consumed.
This function is called automatically by the muxer when it receives a CLOSE message from the remote.
The source will return normally, the sink will continue to consume.
Closes the stream for writing. If iterating over the source of this stream in a for await of loop, it will return (exit the loop) after any buffered data has been consumed.
The source will return normally, the sink will continue to consume.
The underlying muxer has closed, no more messages can be sent or will be received, close immediately to free up resources
ProtectedonOptionalerr: ErrorProtectedonOptionalerr: ErrorThe remote closed for reading so we should not send any more messages
The remote closed for writing so we should expect to receive no more messages
Receive a reset message - close immediately for reading and writing (remote error)
AbstractsendSend a message to the remote muxer, informing them no more data messages will be read by this end of the stream
Optionaloptions: AbortOptionsAbstractsendSend a message to the remote muxer, informing them no more data messages will be sent by this end of the stream
Optionaloptions: AbortOptionsAbstractsendSend a data message to the remote muxer
Optionaloptions: AbortOptionsAbstractsendSend a message to the remote muxer informing them a new stream is being opened
Optionaloptions: AbortOptionsAbstractsendSend a reset message to the remote muxer
Optionaloptions: AbortOptionsWhen an extending class reads data from it's implementation-specific source, call this method to allow the stream consumer to read the data.
Returns the amount of unread data - can be used to prevent large amounts of data building up when the stream consumer is too slow.
A Stream is a data channel between two peers that can be written to and read from at both ends.
It may be encrypted and multiplexed depending on the configuration of the nodes.