Closes the stream for reading and writing. This should be called when a local error has occurred.
Note, if called without an error any buffered data in the source can still be consumed and the stream will end normally.
This will cause a RESET message to be sent to the remote, unless the sink has already ended.
The sink will return and the source will throw if an error is passed or return normally if not.
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.
Closes 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.
Unique identifier for a stream. Identifiers are not unique across muxers.
User defined stream metadata
Closes the stream immediately for reading and writing. This should be called when a remote error has occurred.
This function is called automatically by the muxer when it receives a RESET message from the remote.
The sink will return and the source will throw.
Stats about this stream
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.