Struct Conn 

pub struct Conn { /* private fields */ }

Connection state shared across role-specific FSMs.

Implementations

impl Conn

pub fn new(transport: Box<dyn Transport>, role: ConnRole) -> Self

Build a new connection wrapping transport and tagged with role.

The connection starts with empty mbuf chains, no in-flight messages, and the default consistency knobs (DcOne). Role-specific drivers in this module set extra fields (the dnode peer paths set same_dc, dyn_mode, etc.) before invoking Conn::run.

Examples

use dynomite::io::reactor::{ConnRole, TcpTransport};
use dynomite::net::Conn;
use tokio::net::TcpStream;
let s = TcpStream::connect("127.0.0.1:6379").await.unwrap();
let _ = Conn::new(Box::new(TcpTransport::new(s, ConnRole::Server)), ConnRole::Server);

pub fn handle(&self) -> ConnHandle

Stable connection handle.

pub fn role(&self) -> ConnRole

Connection role.

pub fn peer_addr(&self) -> Option<SocketAddr>

Remote address, if the transport could surface one.

pub fn stats(&self) -> &ConnStats

Borrow the rolling counters.

pub fn recv_chain(&self) -> &MbufQueue

Borrow the recv mbuf chain.

pub fn recv_chain_mut(&mut self) -> &mut MbufQueue

Mutably borrow the recv mbuf chain.

pub fn send_chain(&self) -> &MbufQueue

Borrow the send mbuf chain.

pub fn send_chain_mut(&mut self) -> &mut MbufQueue

Mutably borrow the send mbuf chain.

pub fn imsg_q(&self) -> &MsgQueue

Borrow the in-queue.

pub fn imsg_q_mut(&mut self) -> &mut MsgQueue

Mutably borrow the in-queue.

pub fn omsg_q(&self) -> &MsgQueue

Borrow the out-queue.

pub fn omsg_q_mut(&mut self) -> &mut MsgQueue

Mutably borrow the out-queue.

pub fn rmsg(&self) -> Option<&Msg>

Borrow the partially-received message, if any.

pub fn rmsg_mut(&mut self) -> Option<&mut Msg>

Mutably borrow the partially-received message.

pub fn take_rmsg(&mut self) -> Option<Msg>

Take ownership of the partially-received message, leaving the slot empty.

pub fn set_rmsg(&mut self, msg: Option<Msg>)

Install the partially-received message slot.

pub fn smsg(&self) -> Option<&Msg>

Borrow the partially-sent message, if any.

pub fn take_smsg(&mut self) -> Option<Msg>

Take the partially-sent message.

pub fn set_smsg(&mut self, msg: Option<Msg>)

Install the partially-sent message slot.

pub fn is_eof(&self) -> bool

True when the peer has closed its half of the connection.

pub fn set_eof(&mut self)

Mark the peer half as closed.

pub fn is_done(&self) -> bool

True when the connection has finished (either side closed and all queued work drained).

pub fn set_done(&mut self)

Mark the connection as done.

pub fn err(&self) -> Option<&str>

Last recorded error, if any.

pub fn set_err<S: Into<String>>(&mut self, msg: S)

Record a transport-level error string.

pub fn read_consistency(&self) -> ConsistencyLevel

Read consistency level applied to incoming reads on this connection.

pub fn write_consistency(&self) -> ConsistencyLevel

Write consistency level applied to incoming writes on this connection.

pub fn set_read_consistency(&mut self, c: ConsistencyLevel)

Update the read consistency level.

pub fn set_write_consistency(&mut self, c: ConsistencyLevel)

Update the write consistency level.

pub fn same_dc(&self) -> bool

True for peer connections inside the local datacenter.

pub fn set_same_dc(&mut self, on: bool)

Set the same-DC bit. The dnode-peer drivers update this after consulting the snitch.

pub fn dyn_mode(&self) -> bool

True when the connection participates in the dnode peer plane.

pub fn dnode_secured(&self) -> bool

True when the dnode handshake exchanged a per-connection AES key.

pub fn set_dnode_secured(&mut self, on: bool)

Mark the connection as secured (the handshake completed).

pub fn crypto_key_sent(&self) -> bool

True when the local end has emitted the encrypted AES key.

pub fn set_crypto_key_sent(&mut self, on: bool)

Mark the AES key as sent.

pub fn aes_key(&self) -> Option<&[u8; 32]>

Return the per-connection AES key, if one has been installed.

pub fn set_aes_key(&mut self, key: [u8; 32])

Install (or replace) the per-connection AES key.

pub fn outstanding(&self) -> &HashMap<MsgId, MsgId>

Borrow the outstanding-msg map.

pub fn outstanding_mut(&mut self) -> &mut HashMap<MsgId, MsgId>

Mutably borrow the outstanding-msg map.

pub fn mbuf_pool(&self) -> &MbufPool

Borrow the pool used for fresh mbuf chunks.

pub fn set_mbuf_pool(&mut self, pool: MbufPool)

Replace the mbuf pool. Useful when the embedding application wants every connection to share a single pool.

pub fn take_transport(&mut self) -> Option<Box<dyn Transport>>

Take ownership of the underlying transport, leaving the connection in a half-closed state. Returns None if the transport has already been moved out (typically by Conn::run).

pub fn set_transport(&mut self, transport: Box<dyn Transport>)

Reinstall a transport. Used by reconnect logic in crate::net::ConnPool.

pub fn has_transport(&self) -> bool

True when a transport is currently installed.

pub fn transport_mut(&mut self) -> Option<&mut Box<dyn Transport>>

Mutably borrow the transport. Driver loops use this to drive AsyncRead / AsyncWrite directly.

pub fn enqueue_in(&mut self, msg: Msg) -> Result<(), NetError>

Enqueue a request onto the in-queue.

Errors

Returns NetError::PoolExhausted when the queue is at MAX_CONN_QUEUE_SIZE.

pub fn enqueue_out(&mut self, msg: Msg) -> Result<(), NetError>

Enqueue a message onto the out-queue.

Errors

Returns NetError::PoolExhausted when the queue is at MAX_CONN_QUEUE_SIZE.

pub fn close(&mut self)

Drop the transport and mark the connection as done.

pub fn run(&mut self) -> Result<(), NetError>

Idle no-op driver hook.

Stage 9 wires the PROXY / CLIENT / SERVER / DNODE_PEER_* roles into dedicated drivers in the sibling modules. Calling run on a Conn without first installing a driver does nothing: the connection idles until Conn::close is invoked. Real drivers (for example super::client::client_loop) take a &mut Conn directly.

Errors

Returns NetError::Closed when the transport has already been moved out, e.g. by an earlier driver.

pub fn record_recv(&mut self, bytes: usize)

Bump the recv-bytes counter.

pub fn record_send(&mut self, bytes: usize)

Bump the send-bytes counter.

Trait Implementations

impl Debug for Conn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.