ExICE.Candidate (ex_ice v0.16.0)

View Source

ICE candidate representation.

Summary

Types

t()

@type t() :: %ExICE.Candidate{
  address: :inet.ip_address() | String.t(),
  base_address: :inet.ip_address() | nil,
  base_port: :inet.port_number() | nil,
  foundation: String.t(),
  id: integer(),
  port: :inet.port_number(),
  priority: integer(),
  tcp_type: tcp_type() | nil,
  transport: :udp | :tcp,
  type: type()
}

tcp_type()

@type tcp_type() :: :active | :passive | :so

type()

@type type() :: :host | :srflx | :prflx | :relay

Functions

family(candidate)

@spec family(t()) :: :ipv4 | :ipv6

marshal(cand)

@spec marshal(t()) :: String.t()

tcp_type(candidate)

@spec tcp_type(t()) :: tcp_type() | nil

unmarshal(string)

@spec unmarshal(String.t()) :: {:ok, t()} | {:error, term()}