Struct PushPeer 

pub struct PushPeer<Prev: Pusher> { /* private fields */ }

Available on crate feature ovpn only.

Implementations

impl<Prev: Pusher> PushPeer<Prev>

pub fn new(prev: Prev) -> Self

pub fn end_nested(self) -> Prev

pub fn push_id(self, value: u32) -> Self

The unique ID of the peer in the device context. To be used to identify peers during operations for a specific device. Also used to match packets received from this peer.

pub fn push_remote_ipv4(self, value: Ipv4Addr) -> Self

The remote IPv4 address of the peer

pub fn push_remote_ipv6(self, value: &[u8]) -> Self

The remote IPv6 address of the peer

pub fn push_remote_ipv6_scope_id(self, value: u32) -> Self

The scope id of the remote IPv6 address of the peer (RFC2553)

pub fn push_remote_port(self, value: u16) -> Self

The remote port of the peer

pub fn push_socket(self, value: u32) -> Self

The socket to be used to communicate with the peer

pub fn push_socket_netnsid(self, value: i32) -> Self

The ID of the netns the socket assigned to this peer lives in

pub fn push_vpn_ipv4(self, value: Ipv4Addr) -> Self

The IPv4 address assigned to the peer by the server

pub fn push_vpn_ipv6(self, value: &[u8]) -> Self

The IPv6 address assigned to the peer by the server

pub fn push_local_ipv4(self, value: Ipv4Addr) -> Self

The local IPv4 to be used to send packets to the peer (UDP only)

pub fn push_local_ipv6(self, value: &[u8]) -> Self

The local IPv6 to be used to send packets to the peer (UDP only)

pub fn push_local_port(self, value: u16) -> Self

The local port to be used to send packets to the peer (UDP only)

pub fn push_keepalive_interval(self, value: u32) -> Self

The number of seconds after which a keep alive message is sent to the peer

pub fn push_keepalive_timeout(self, value: u32) -> Self

The number of seconds from the last activity after which the peer is assumed dead

pub fn push_del_reason(self, value: u32) -> Self

The reason why a peer was deleted

Associated type: DelPeerReason (enum)

pub fn push_vpn_rx_bytes(self, value: u32) -> Self

Number of bytes received over the tunnel

pub fn push_vpn_tx_bytes(self, value: u32) -> Self

Number of bytes transmitted over the tunnel

pub fn push_vpn_rx_packets(self, value: u32) -> Self

Number of packets received over the tunnel

pub fn push_vpn_tx_packets(self, value: u32) -> Self

Number of packets transmitted over the tunnel

pub fn push_link_rx_bytes(self, value: u32) -> Self

Number of bytes received at the transport level

pub fn push_link_tx_bytes(self, value: u32) -> Self

Number of bytes transmitted at the transport level

pub fn push_link_rx_packets(self, value: u32) -> Self

Number of packets received at the transport level

pub fn push_link_tx_packets(self, value: u32) -> Self

Number of packets transmitted at the transport level

pub fn push_tx_id(self, value: u32) -> Self

The ID value used when transmitting packets to this peer. This way outgoing packets can have a different ID than incoming ones. Useful in multipeer-to-multipeer connections, where each peer will advertise the tx-id to be used on the link.

Trait Implementations

impl<Prev: Pusher> Drop for PushPeer<Prev>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<Prev: Pusher> Pusher for PushPeer<Prev>

fn as_vec_mut(&mut self) -> &mut Vec<u8>

fn as_vec(&self) -> &Vec<u8>

fn as_rec(&self) -> &Vec<u8>

👎Deprecated:

Use .as_vec() instead (rec -> vec)

fn as_rec_mut(&mut self) -> &mut Vec<u8>

👎Deprecated:

Use .as_vec_mut() instead (rec -> vec)