Struct snarkos_network::message::channel::Channel

pub struct Channel {
    pub address: SocketAddr,
    pub reader: Arc<Mutex<TcpStream>>,
    pub writer: Arc<Mutex<TcpStream>>,
}

A Channel for reading and writing messages to a peer. Storing two streams allows for simultaneous reading/writing. Each stream is protected by an Arc + Mutex to allow for channel cloning.

Fields

address: SocketAddr

reader: Arc<Mutex<TcpStream>>

writer: Arc<Mutex<TcpStream>>

Implementations

impl Channel

pub async fn new(
    address: SocketAddr,
    reader: Arc<Mutex<TcpStream>>,
    writer: Arc<Mutex<TcpStream>>
) -> Result<Self, ConnectError>

pub async fn new_write_only(address: SocketAddr) -> Result<Self, ConnectError>

Returns a new channel with a writer only stream.

pub fn new_read_only(reader: TcpStream) -> Result<Self, ConnectError>

Returns a new channel with a reader only stream.

pub fn update_address(&self, address: SocketAddr) -> Self

Returns a new channel with the specified address.

pub fn update_reader(&self, reader: Arc<Mutex<TcpStream>>) -> Self

Returns a new channel with the specified reader stream.

pub async fn update_writer<'_>(
    &'_ self,
    address: SocketAddr
) -> Result<Self, ConnectError>

Returns a new channel with the specified address and new writer stream.

pub async fn write<M: Message, '_, '_>(
    &'_ self,
    message: &'_ M
) -> Result<(), ConnectError>

Writes a message header + message.

pub async fn read<'_>(&'_ self) -> Result<(MessageName, Vec<u8>), ConnectError>

Reads a message header + message.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.