Struct NetcodeSocket

pub struct NetcodeSocket(/* private fields */);

A wrapper around UdpSocket that implements the Transceiver trait for use in the netcode protocol.

NetcodeSocket is responsible for creating and managing a UDP socket, handling non-blocking send and receive operations, and providing the local address of the socket.

Note

This is a lower-level component and should not be used directly unless you have a specific use case. For most applications, it is recommended to use higher-level abstractions such as Client::new or Client::with_config to create and manage clients.

Example

use netcode::NetcodeSocket;
use std::net::SocketAddr;

let addr = "127.0.0.1:41235";
let send_buf_size = 256 * 1024;
let recv_buf_size = 256 * 1024;
let socket = NetcodeSocket::new(addr, send_buf_size, recv_buf_size).unwrap();

Implementations

impl NetcodeSocket

pub fn new( addr: impl ToSocketAddrs, send_buf_size: usize, recv_buf_size: usize, ) -> Result<Self, Error>

Trait Implementations

impl Transceiver for NetcodeSocket

type IntoError = Error

fn addr(&self) -> SocketAddr

Returns the local address of the socket (i.e. the address it is bound to).

fn recv(&self, buf: &mut [u8]) -> Result<Option<(usize, SocketAddr)>, Error>

Receives a packet from the socket, if one is available.

fn send(&self, buf: &[u8], addr: SocketAddr) -> Result<usize, Error>

Sends a packet to the specified address.