Skip to main content

Channel

Struct Channel 

Source
pub struct Channel {
    pub opened: bool,
    pub setup: bool,
    pub initiator: bool,
    pub xml_reader: XmlReader,
    pub outbox: VecDeque<Vec<u8>>,
}
Expand description

Communication channel between nodes in the propagation tree.

A Channel manages XML-based message exchange over a transport (typically an SSH pipe). It uses an XmlReader for incoming messages and XML generation for outgoing messages.

Fields§

§opened: bool

Whether the channel has been opened (received StartMessage).

§setup: bool

Whether the channel setup is complete (received ACK to config).

§initiator: bool

Whether this end initiated the channel.

§xml_reader: XmlReader

The XML reader for parsing incoming data.

§outbox: VecDeque<Vec<u8>>

Outgoing message buffer.

Implementations§

Source§

impl Channel

Source

pub fn new(initiator: bool) -> Self

Create a new Channel.

§Arguments
  • initiator - true if this end is initiating the channel
Source

pub fn init_xml(&self) -> Vec<u8> ⓘ

Generate the XML document header.

Source

pub fn open_xml(&self, version: &str) -> Vec<u8> ⓘ

Generate the opening <channel> tag.

Source

pub fn close_xml(&self) -> Vec<u8> ⓘ

Generate the closing </channel> tag.

Source

pub fn send(&mut self, msg: &Message)

Serialize a message and enqueue it for sending.

Source

pub fn feed( &mut self, data: &str, ) -> Result<Vec<Message>, MessageProcessingError>

Feed incoming data to the XML reader and return any parsed messages.

Source

pub fn take_outgoing(&mut self) -> Option<Vec<u8>>

Take the next outgoing message from the outbox.

Trait Implementations§

Source§

impl Debug for Channel

Source§

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

Formats the value using the given formatter. Read more

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.