Module stream 

Tor stream handling.

A stream is an anonymized conversation; multiple streams can be multiplexed over a single circuit.

Modules

cmdcheck 🔒

Declare a “command checker” trait that checks whether a given relay message is acceptable on a given stream.

flow_ctrl 🔒

Stream flow control.

incoming 🔒

Incoming data stream cell handlers, shared by the relay and onion service implementations.

queue 🔒

Queues for stream messages.

raw 🔒

Declare the lowest level of stream: a stream that operates on raw cells.

Structs

IncomingStream

A pending request from the other end of the circuit for us to open a new stream.

IncomingStreamRequestContext

Information about a stream request, as passed to an IncomingStreamRequestFilter.

StreamComponents 🔒

A collection of components that can be combined to implement a Tor stream, or anything that requires a stream ID.

StreamReceiver

The read part of a stream on a particular circuit.

StreamTarget 🔒

Internal handle, used to implement a stream on a particular tunnel.

Enums

CloseStreamBehavior 🔒

A behavior to perform when closing a stream.

IncomingStreamRequest

The allowed incoming messages on an IncomingStream.

IncomingStreamRequestDisposition

What action to take with an incoming stream request.

Tunnel 🔒

A client or relay tunnel.

Constants

RECV_WINDOW_INIT 🔒

Initial value for inbound flow-control window on streams.

SEND_WINDOW_INIT 🔒

Initial value for outbound flow-control window on streams.

STREAM_READER_BUFFER 🔒

Size of the buffer used between the reactor and a StreamReader.

Traits

IncomingStreamRequestFilter

A callback that can check whether a given stream request is acceptable immediately on its receipt.

Functions

msg_streamid 🔒

Return the stream ID of msg, if it has one.

Type Aliases

StreamMpscReceiver 🔒

MPSC queue relating to a stream (either inbound or outbound), receiver

StreamMpscSender 🔒

MPSC queue relating to a stream (either inbound or outbound), sender