Struct libutp_rs::UtpContext

pub struct UtpContext { /* fields omitted */ }

A UTP context

The UtpContext is the core of a UTP application. It sets up the backing UDP socket and provides methods for initiating and accepting connections.

Implementations

impl UtpContext

pub fn bind(addr: SocketAddr) -> Result<UtpContext>

Creates the backing UDP socket and returns a new UtpContext

Example

use libutp_rs::UtpContext;

let ctx = UtpContext::bind("127.0.0.1:5000".parse().unwrap()).unwrap();

pub fn listener(&self) -> UtpListener

Returns a [Stream] of incoming connections.

Example

use libutp_rs::UtpContext;
use std::error::Error;
use futures::stream::StreamExt;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let ctx = UtpContext::bind("127.0.0.1:5000".parse()?)?;
    let mut listener = ctx.listener();
    let socket = listener.next().await.unwrap()?;
    Ok(())
}

pub fn connect(&self, addr: SocketAddr) -> Connect

Initiates a connection.

Returns a Connect future which resolves to a UtpSocket if successful.

Example

use libutp_rs::UtpContext;
use std::error::Error;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let ctx = UtpContext::bind("127.0.0.1:5000".parse()?)?;
    let socket = ctx.connect("127.0.0.1:5001".parse()?).await?;
    Ok(())
}

pub fn set_udp_mtu(&self, mtu: u16)

pub fn clear_mtu(&self)