Struct tari_comms::memsocket::MemorySocket

pub struct MemorySocket { /* fields omitted */ }

An in-memory stream between two local sockets.

A MemorySocket can either be created by connecting to an endpoint, via the connect method, or by accepting a connection from a listener. It can be read or written to using the AsyncRead, AsyncWrite, and related extension traits in futures::io.

Examples

use futures::prelude::*;
use tari_comms::memsocket::MemorySocket;

let (mut socket_a, mut socket_b) = MemorySocket::new_pair();

socket_a.write_all(b"stormlight").await?;
socket_a.flush().await?;

let mut buf = [0; 10];
socket_b.read_exact(&mut buf).await?;
assert_eq!(&buf, b"stormlight");

Implementations

impl MemorySocket

pub fn new_pair() -> (Self, Self)

Construct both sides of an in-memory socket.

Examples

use tari_comms::memsocket::MemorySocket;

let (socket_a, socket_b) = MemorySocket::new_pair();

pub fn connect(port: u16) -> Result<MemorySocket>

Create a new in-memory Socket connected to the specified port.

This function will create a new MemorySocket socket and attempt to connect it to the port provided.

Examples

use tari_comms::memsocket::MemorySocket;

let socket = MemorySocket::connect(16)?;

Trait Implementations

impl AsyncRead for MemorySocket

fn poll_read(
    self: Pin<&mut Self>,
    context: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for MemorySocket

fn poll_write(
    self: Pin<&mut Self>,
    context: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize>>

Attempt to write bytes from buf into the outgoing channel.

fn poll_flush(
    self: Pin<&mut Self>,
    _context: &mut Context<'_>
) -> Poll<Result<()>>

Attempt to flush the channel. Cannot Fail.

fn poll_close(
    self: Pin<&mut Self>,
    _context: &mut Context<'_>
) -> Poll<Result<()>>

Attempt to close the channel. Cannot Fail.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for MemorySocket

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

Formats the value using the given formatter.