Packages
sippet
0.2.2
1.0.16
1.0.15
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.6.4
0.6.3
0.6.2
0.6.1
0.6.0
0.5.9
0.5.8
0.5.7
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
An Elixir Session Initiation Protocol (SIP) stack.
Current section
Files
Jump to
Current section
Files
lib/sippet/core.ex
defmodule Sippet.Core do
@moduledoc """
A behaviour module for implementing the `Sippet.Core`.
The `Sippet.Core` designates a particular type of SIP entity, i.e., specific
to either a stateful or stateless proxy, a user agent or registrar.
"""
alias Sippet.Message, as: Message
alias Sippet.Transactions, as: Transactions
@doc """
Receives a new incoming request from a remote host, or ACK.
The `server_transaction` indicates the name of the transaction created when
the request was received. If it is an ACK, then the `server_transaction` is
`nil`.
The function `receive_request/2` is called from the server transaction
process when the parameter `server_transaction` is not `nil`, and from the
transport process (possibly a `poolboy` worker process), when the
`server_transaction` is `nil`.
"""
@callback receive_request(incoming_request :: Message.request,
server_transaction :: Transactions.Server.t | nil)
:: any
@doc """
Receives a response for a sent request.
The `client_transaction` indicates the name of the transaction created when
the request was sent using `Sippet.Transactions.send_request/1`.
The function `receive_response/2` is called from the client transaction
process when the parameter `client_transaction` is not `nil`, and from the
transport process (possibly a `poolboy` worker process), when the
`client_transaction` is `nil`.
"""
@callback receive_response(incoming_response :: Message.response,
client_transaction :: Transactions.Client.t | nil)
:: any
@doc """
Receives an error from the server or client transaction.
The function `receive_error/2` is called from the client or server
transaction process created when sending or receiving requests.
"""
@callback receive_error(reason :: term,
client_or_server_transaction ::
Transactions.Client.t |
Transactions.Server.t)
:: any
@doc """
Dispatches the received request to the registered `Sippet.Core`
implementation.
"""
@spec receive_request(Message.request, Transactions.Server.t | nil) :: any
def receive_request(incoming_request, server_transaction) do
args = [incoming_request, server_transaction]
apply(get_module!(), :receive_request, args)
end
defp get_module!() do
module = Application.get_env(:sippet, __MODULE__)
if module == nil do
raise RuntimeError, message: "Sippet.Core is not registered"
else
module
end
end
@doc """
Dispatches the received response to the registered `Sippet.Core`
implementation.
"""
@spec receive_response(Message.response, Transactions.Client.t | nil) :: any
def receive_response(incoming_response, client_transaction) do
args = [incoming_response, client_transaction]
apply(get_module!(), :receive_response, args)
end
@doc """
Dispatches the network transport error to the registered `Sippet.Core`
implementation.
"""
@spec receive_error(reason :: term,
Transactions.Client.t | Transactions.Server.t) :: any
def receive_error(reason, client_or_server_transaction) do
args = [reason, client_or_server_transaction]
apply(get_module!(), :receive_error, args)
end
defmacro __using__(_opts) do
quote location: :keep do
@behaviour Sippet.Core
end
end
end