Struct Gathering 

pub struct Gathering {
    pub credentials: Credentials,
    pub offerer: bool,
    pub tiebreaker: u64,
    pub stun_server: Option<SocketAddr>,
    pub stun_timeout: Duration,
    pub agent: Config,
}

Everything gathering needs that the sockets do not already supply.

Fields

credentials: Credentials

Our short-term credentials for this ICE session (RFC 8839 §5.4), which go in the offer or the answer and key every check in both directions (spec §11.2).

offerer: bool

Whether sipx sent the initial offer — RFC 8445 §6.1.1’s role determination between two full agents.

tiebreaker: u64

§7.1.3’s 64-bit tiebreaker, drawn once per ICE session.

stun_server: Option<SocketAddr>

The STUN server to ask for a server-reflexive candidate (§5.1.1.2). None gathers host candidates alone, which is the right answer on a network with no NAT and the only answer when no server is configured.

stun_timeout: Duration

How long to keep asking it before giving up.

Gathering that never finishes is an offer that never goes out, so this is a deadline and not a retry count: whatever has been gathered when it expires is what is offered, and a STUN server that is down costs one call setup this long and nothing else.

agent: Config

The agent’s own configuration — §14’s timers and §6.1.2.5’s pair limit.

Implementations

impl Gathering

pub fn new(credentials: Credentials, offerer: bool) -> Self

Gather host candidates only, with a fresh tiebreaker.

The tiebreaker is drawn here rather than taken because §7.1.3 wants a random one per ICE session and a caller that has no opinion should not have to have one; a caller that does — a test walking §7.3.1.1’s T = V row — sets the field afterwards.

Trait Implementations

impl Clone for Gathering

fn clone(&self) -> Gathering

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gathering

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.