View Source ExICE.Candidate (ex_ice v0.9.0)

ICE candidate representation.

Summary

Types

t()

type()

Functions

family(candidate)

marshal(cand)

unmarshal(string)

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: integer(),
  id: integer(),
  port: :inet.port_number(),
  priority: integer(),
  transport: :udp | :tcp,
  type: type()
}

type()

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

Functions

family(candidate)

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

marshal(cand)

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

unmarshal(string)

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