Sippet v0.2.5 Sippet.Transports

The Sippet.Transports is responsible for the actual transmission of requests and responses over network transports.

Network transport protocols are implemented following the Sippet.Transports.Plug behavior, and they are configured as:

config :sippet, Sippet.Transports,
  udp: Sippet.Transports.UDP.Plug

Whenever a message is received by a plug, the Sippet.Transports.Queue is used to process, validate and route it through the transaction layer or core.

Summary

Functions

reliable?(message)

Verifies if the transport protocol used to send the given message is reliable

send_message(message, transaction \\ nil)

Sends a message to the network

start_link()

Starts the transport process hierarchy

Functions

reliable?(message)

reliable?(Sippet.Message.t) :: boolean

Verifies if the transport protocol used to send the given message is reliable.

send_message(message, transaction \\ nil)

send_message(Sippet.Message.t, GenServer.server | nil) :: :ok

Sends a message to the network.

If specified, the transaction will receive the transport error if occurs. See Sippet.Transactions.receive_error/2.

This function may block the caller temporarily due to resource constraints.

start_link()

start_link() :: Supervisor.on_start

Starts the transport process hierarchy.