# `Caracola.Via`
[🔗](https://github.com/netkubes/caracola/blob/v0.1.0-rc.1/lib/caracola/via.ex#L1)

Via header entry. Port of NkSIP's `nksip_parse_via`.

`transport` is an atom for known transports or the raw string otherwise.
`port` is `nil` when absent. Parameters are `{name, value}` tuples, with
`nil` value for flags (like `rport`).

# `t`

```elixir
@type t() :: %Caracola.Via{
  domain: String.t(),
  params: [Caracola.URI.param()],
  port: :inet.port_number() | nil,
  transport: transport()
}
```

A Via header.

# `transport`

```elixir
@type transport() :: :udp | :tcp | :tls | :sctp | :ws | :wss | String.t()
```

A transport of a Via header.

# `encode`

```elixir
@spec encode(t()) :: iodata()
```

Serializes a Via entry.

# `get_param`

```elixir
@spec get_param(t(), String.t()) :: {:ok, String.t() | nil} | :error
```

Gets a parameter, case-insensitively.

# `parse`

```elixir
@spec parse(binary() | [binary()]) :: {:ok, [t()]} | :error
```

Parses a comma-separated list of Via entries, or a list of such binaries.

    iex> {:ok, [via]} = Caracola.Via.parse("SIP/2.0/UDP host:5060;branch=z9hG4bK1;rport")
    iex> {via.transport, via.domain, via.port, via.params}
    {:udp, "host", 5060, [{"branch", "z9hG4bK1"}, {"rport", nil}]}

---

*Consult [api-reference.md](api-reference.md) for complete listing*
