Skip to main content

Puncher

Struct Puncher 

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

NAT hole punching coordinator.

Puncher manages the hole punching process, tracking attempts and adapting strategies based on NAT type and previous results.

§Examples

use rust_p2p_core::punch::Puncher;

let puncher = Puncher::new(None, None);

Implementations§

Source§

impl Puncher

Source

pub fn new( udp_socket_manager: Option<Arc<UdpSocketManager>>, tcp_socket_manager: Option<Arc<TcpSocketManager>>, ) -> Puncher

Creates a new Puncher with the given socket managers.

§Arguments
  • udp_socket_manager - Optional UDP socket manager for UDP punching
  • tcp_socket_manager - Optional TCP socket manager for TCP punching
Source§

impl Puncher

Source

pub fn need_punch(&self, punch_info: &PunchInfo) -> bool

Determines whether hole punching is needed for a peer.

Call this method periodically. It uses adaptive frequency based on previous attempts to avoid excessive punching.

§Arguments
  • punch_info - Information about the peer to punch
§Returns

true if punching should be attempted, false otherwise.

§Examples
if puncher.need_punch(&punch_info) {
    // Perform punching
}
Source

pub async fn punch(&self, buf: &[u8], punch_info: PunchInfo) -> Result<()>

Attempts hole punching if needed (convenience method).

This combines need_punch and punch_now into a single call.

§Arguments
  • buf - The data to send during punching
  • punch_info - Information about the peer to punch
§Examples
let punch_info = PunchInfo::default();
puncher.punch(b"punch_data", punch_info).await?;
Source

pub async fn punch_now( &self, tcp_buf: Option<&[u8]>, udp_buf: &[u8], punch_info: PunchInfo, ) -> Result<()>

Performs hole punching immediately without checking if it’s needed.

Attempts both TCP and UDP hole punching based on available socket managers and the peer’s NAT information.

§Arguments
  • tcp_buf - Optional TCP punch data
  • udp_buf - UDP punch data
  • punch_info - Information about the peer to punch
§Examples
let punch_info = PunchInfo::default();
puncher.punch_now(Some(b"tcp"), b"udp", punch_info).await?;

Trait Implementations§

Source§

impl Clone for Puncher

Source§

fn clone(&self) -> Puncher

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl From<&TunnelDispatcher> for Puncher

Source§

fn from(value: &TunnelDispatcher) -> Self

Converts to this type from the input type.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> FromRef<T> for U
where T: Clone, U: From<T>,

Source§

fn from_ref(val_ref: &T) -> U

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, U> RefInto<T> for U
where U: Into<T> + Clone,

Source§

fn ref_into(&self) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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