Struct internet2::transport::ftcp::Stream

pub struct Stream(_);

Wrapper type around TCP stream for implementing FTCP-specific traits

Trait Implementations

impl Bipolar for Stream

type Left = Stream

First separable type (like reader)

type Right = Stream

Second separable type (like writer)

fn join(left: Self::Left, right: Self::Right) -> Self

Reconstruct the type from the halves

fn split(self) -> (Self::Left, Self::Right)

Split the type into two

impl Debug for Stream

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

Formats the value using the given formatter.

impl Duplex for Stream

fn as_receiver(&mut self) -> &mut dyn RecvFrame

fn as_sender(&mut self) -> &mut dyn SendFrame

fn split(self) -> (Box<dyn RecvFrame + Send>, Box<dyn SendFrame + Send>)

impl From<TcpStream> for Stream

fn from(v: TcpStream) -> Self

Converts to this type from the input type.

impl RecvFrame for Stream

fn recv_frame(&mut self) -> Result<Vec<u8>, Error>

Receive a single frame of data structured as a byte string. The frame contains LNP framing prefix, which is used by upstream session-level protocols.

fn recv_raw(&mut self, len: usize) -> Result<Vec<u8>, Error>

Try to receive len number of bytes and pack them as a frame. The actual amount of bytes received may differ for some protocols, like ZMQ, so the function should be used with caution!

fn recv_routed(&mut self) -> Result<RoutedFrame, Error>

Receive frame like with RecvFrame::recv_frame, but only originating from the specified remote address.

impl SendFrame for Stream

fn send_frame(&mut self, data: &[u8]) -> Result<usize, Error>

Sends a single frame of data structured as a byte string. The frame must already contain LNP framing prefix with size data. The function must check that the provided data frame length is below the limit defined with MAX_FRAME_SIZE constant.

fn send_raw(&mut self, data: &[u8]) -> Result<usize, Error>

Sends a single frame of data structured as a byte string. The frame must already contain LNP framing prefix with size data.

fn send_routed(
    &mut self,
    _source: &[u8],
    _route: &[u8],
    _address: &[u8],
    _data: &[u8]
) -> Result<usize, Error>

Sends a single frame of data structured as a byte string to a specific receiver with remote_id. Function works like RecvFrame::recv_frame and is used for the underlying protocols supporting multipeer connectivity. The frame must already contain LNP framing prefix with size data. The function must check that the provided data frame length is below the limit defined with MAX_FRAME_SIZE constant.

impl Stream for Stream