Skip to main content

SnapTunNgSocket

Struct SnapTunNgSocket 

Source
pub struct SnapTunNgSocket { /* private fields */ }
Expand description

A SNAP tun ng socket.

Implementations§

Source§

impl SnapTunNgSocket

Source

pub async fn new( static_private: StaticSecret, peer_public: PublicKey, underlay_socket: Arc<UdpSocket>, dataplane_address: SocketAddr, receive_queue_capacity: usize, ) -> Result<Self, SnapTunNgSocketError>

Creates a new SNAP tunnel and waits for the handshake to complete.

§Arguments
  • static_private - The client’s static private key
  • peer_public - The server’s static public key (needed for handshake)
  • rate_limiter - Rate limiter for the tunnel
  • underlay_socket - UDP socket for sending/receiving packets
  • dataplane_address - Address of the remote server
  • receive_queue_capacity - Capacity of the receive queue
Source

pub async fn send(&self, payload: BytesMut) -> Result<()>

Send a packet to the remote server.

Source

pub fn try_send(&self, payload: BytesMut) -> Result<()>

Try to send a packet to the remote server. Returns error of try_send_to.

Source

pub async fn recv(&self) -> Result<Bytes, SnapTunNgSocketError>

Receive a packet from the remote server.

Source

pub fn poll_recv( &self, cx: &mut Context<'_>, ) -> Poll<Result<Bytes, SnapTunNgSocketError>>

Poll for a packet from the remote server.

Source

pub fn local_addr(&self) -> SocketAddr

Get the local socket address. Assigned by the remote server.

Source

pub async fn writable(&self) -> Result<()>

Check if the socket is writable.

Trait Implementations§

Source§

impl Drop for SnapTunNgSocket

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more