Struct UtpStream

pub struct UtpStream { /* private fields */ }

A structure that represents a uTP (Micro Transport Protocol) stream between a local socket and a remote socket.

The connection will be closed when the value is dropped (either explicitly or when it goes out of scope).

The default maximum retransmission retries is 5, which translates to about 16 seconds. It can be changed by calling set_max_retransmission_retries. Notice that the initial congestion timeout is 500 ms and doubles with each timeout.

Examples

use async_std_utp::UtpStream;
use async_std::prelude::*;

let mut stream = UtpStream::bind("127.0.0.1:1234").await.expect("Error binding stream");
let _ = stream.write(&[1]).await;
let _ = stream.read(&mut [0; 1000]).await;

Implementations

impl UtpStream

pub async fn bind<A: ToSocketAddrs>(addr: A) -> Result<UtpStream>

Creates a uTP stream listening on the given address.

The address type can be any implementer of the ToSocketAddr trait. See its documentation for concrete examples.

If more than one valid address is specified, only the first will be used.

pub async fn connect<A: ToSocketAddrs>(dst: A) -> Result<UtpStream>

Opens a uTP connection to a remote host by hostname or IP address.

The address type can be any implementer of the ToSocketAddr trait. See its documentation for concrete examples.

If more than one valid address is specified, only the first will be used.

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

Gracefully closes connection to peer.

This method allows both peers to receive all packets still in flight.

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the socket address of the local half of this uTP connection.

pub fn peer_addr(&self) -> Result<SocketAddr>

Returns the socket address of the remote half of this uTP connection.

pub async fn set_max_retransmission_retries(&mut self, n: u32)

Changes the maximum number of retransmission retries on the underlying socket.

Trait Implementations

impl AsyncRead for UtpStream

fn poll_read( self: Pin<&mut Self>, cx: &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 UtpStream

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

Attempt to write bytes from buf into the object.

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

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

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 Clone for UtpStream

fn clone(&self) -> UtpStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UtpStream

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

Formats the value using the given formatter.

impl From<UtpSocket> for UtpStream

fn from(socket: UtpSocket) -> Self

Converts to this type from the input type.

impl Send for UtpStream