Skip to main content

DataChannel

Struct DataChannel 

Source
pub struct DataChannel { /* private fields */ }
Expand description

A channel that sends and receives typed protocol messages.

Wraps a raw Channel and provides automatic serialization via ProtocolMessage::encode and ProtocolMessage::decode. Tracks message counts for monitoring.

Implementations§

Source§

impl DataChannel

Source

pub fn new(channel: Arc<dyn Channel>, node_name: String) -> Self

Create a new DataChannel wrapping the given raw channel.

§Arguments
  • channel - The underlying channel for byte transport.
  • node_name - The name of the peer node on this channel.
Source

pub fn send_message(&self, msg: &ProtocolMessage) -> Result<()>

Send a protocol message through the channel.

The message is encoded to bytes via ProtocolMessage::encode and sent through the underlying channel.

Source

pub fn receive_message( &self, timeout: Duration, ) -> Result<Option<ProtocolMessage>>

Receive a protocol message with a timeout.

Blocks until a message is available or the timeout expires. Returns Ok(None) on timeout.

Source

pub fn get_node_name(&self) -> &str

Get the peer node name.

Source

pub fn messages_sent(&self) -> u64

Get the total number of messages sent.

Source

pub fn messages_received(&self) -> u64

Get the total number of messages received.

Source

pub fn close(&self) -> Result<()>

Close the underlying channel.

Source

pub fn is_open(&self) -> bool

Check if the underlying channel is open.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V