View Source ExICE.Candidate (ex_ice v0.6.1)

ICE candidate representation.

Summary

Types

@type t() :: %ExICE.Candidate{
  address: :inet.ip_address(),
  base_address: :inet.ip_address() | nil,
  base_port: :inet.port_number() | nil,
  foundation: integer(),
  id: integer(),
  port: :inet.port_number(),
  priority: integer(),
  socket: :inet.socket() | nil,
  transport: :udp,
  type: type()
}
@type type() :: :host | :srflx | :prflx | :relay

Functions

@spec family(t()) :: :ipv4 | :ipv6
@spec marshal(t()) :: String.t()
Link to this function

new(type, address, port, base_address, base_port, socket, opts \\ [])

View Source
@spec new(
  type(),
  :inet.ip_address(),
  :inet.port_number(),
  :inet.ip_address() | nil,
  :inet.port_number() | nil,
  :inet.socket() | nil,
  [{:priority, integer()}]
) :: t()
@spec priority(type()) :: integer()
@spec unmarshal(String.t()) :: {:ok, t()} | {:error, term()}