Struct StreamSocket 

pub struct StreamSocket { /* private fields */ }

STREAM socket - raw TCP bridging without ZMTP handshake.

Accepts plain TCP connections and multiplexes them through a ZeroMQ-style routing-ID interface. Each accepted connection is assigned a unique 8-byte routing ID; all subsequent sends and receives for that connection use the same ID to route messages.

Unlike other socket types, StreamSocket performs no ZMTP handshake - it speaks plain TCP bytes, making it suitable for bridging to HTTP servers, legacy services, and command-line tools such as nc and curl.

Implementations

impl StreamSocket

pub async fn bind(addr: impl ToSocketAddrsAsync) -> Result<StreamSocket, Error>

Bind a STREAM socket to a TCP address.

The returned socket is ready to accept raw (non-ZMTP) TCP connections via accept_raw().

Errors

Returns an error if the address cannot be bound (e.g., port in use).

pub async fn accept_raw(&mut self) -> Result<Bytes, Error>

Accept the next raw TCP connection and register it as a new peer.

Spawns background reader and writer tasks for the connection. Returns the routing ID assigned to this peer; the same ID is used to address messages to this peer via send().

The caller will also receive a connection notification from recv(): [routing_id, "", ""] with an empty data frame.

Errors

Returns an error if the accept() system call fails.

pub async fn recv(&mut self) -> Result<Option<Vec<Bytes>>, Error>

Receive the next message from any connected peer.

Returns [routing_id, empty, data]. An empty data frame signals a connection event (connect or disconnect) for routing_id.

Returns Ok(None) only if the socket’s inbound channel has been closed (i.e., the StreamSocket itself is being dropped).

Errors

Returns an error if the underlying channel has an unexpected failure.

pub async fn send(&mut self, msg: Vec<Bytes>) -> Result<(), Error>

Send raw bytes to a specific peer.

msg must contain at least one frame (the routing ID). A 3-frame layout is expected: [routing_id, empty, data]. The routing ID selects the destination; remaining frames are flattened and written as raw bytes to the TCP stream.

If the peer is not found (e.g., already disconnected), the message is silently dropped.

Errors

Returns an error if the message has no frames or if the peer’s send channel has disconnected.

Returns WouldBlock when the peer’s send queue has reached the configured send_hwm limit.

pub fn close_peer(&mut self, routing_id: &Bytes) -> bool

Close a single peer, removing it from the routing table and cancelling its background reader and writer tasks.

Dropping the peer’s internal PeerHandle closes both the outbound and the shutdown channels, so the writer exits and the reader’s shutdown branch fires. Both tasks then release their TCP halves and file descriptors, rather than the reader lingering until the remote closes the connection.

After this call, messages addressed to routing_id are silently dropped. Returns true if a peer was present and removed.

pub fn disconnect(&mut self, routing_id: &Bytes)

Disconnect a peer explicitly. Alias for close_peer.

pub fn peer_count(&self) -> usize

Number of currently tracked (connected) peers.

pub fn local_addr(&self) -> Result<SocketAddr, Error>

The local address this socket is bound to.

pub const fn options(&self) -> &SocketOptions

Get a reference to the socket options.

pub fn options_mut(&mut self) -> &mut SocketOptions

Get a mutable reference to the socket options.