Build a SIP request.

Build a SIP response.

Creates an unique local branch (72-bit random string, 7+12 characters long).

Creates an unique Call-ID (120-bit random string, 20 characters long).

Creates a local tag (48-bit random string, 8 characters long).

Deletes all header values in message.

Deletes the last value of header in message.

Deletes the first value of header in message.

Drops all given headers from message.

Fetches all values for a specific header and returns it in a tuple.

If the header does not exist, returns :error.

Fetches all values for a specific header in the given message, erroring out if message doesn’t contain header.

If message contains the given header, all corresponding values are returned in a list. If message doesn’t contain the header, a KeyError exception is raised.

Fetches the last value of a specific header and returns it in a tuple.

If the header does not exist, returns :error. If the header exists but it is an empty list, returns {:ok, nil}.

Fetches the last value of a specific header in the given message, erroring out if message doesn’t contain header.

If message contains the given header, the last value is returned, which may be nil case the values list is empty. If message doesn’t contain the header, a KeyError exception is raised.

Fetches the first value of a specific header and returns it in a tuple.

If the header does not exist, returns :error. If the header exists but it is an empty list, returns {:ok, nil}.

Fetches the first value of a specific header in the given message, erroring out if message doesn’t contain header.

If message contains the given header, the first value is returned, which may be nil case the values list is empty. If message doesn’t contain the header, a KeyError exception is raised.

Gets the values from header and updates it, all in one pass.

fun is called with the current values under header in message (or nil if key is not present in message) and must return a two-element tuple: the “get” value (the retrieved values, which can be operated on before being returned) and the new values to be stored under header in the resulting new message. fun may also return :pop, which means all current values shall be removed from message and returned (making this function behave like Sippet.Message.pop_header(message, header). The returned value is a tuple with the “get” value returned by fun and a new message with the updated values under header.

Gets the last value from header and updates it, all in one pass.

fun is called with the current last value under header in message (or nil if key is not present in message) and must return a two-element tuple: the “get” value (the retrieved value, which can be operated on before being returned) and the new value to be stored under header in the resulting new message. fun may also return :pop, which means the current value shall be removed from message and returned (making this function behave like Sippet.Message.pop_header_back(message, header). The returned value is a tuple with the “get” value returned by fun and a new message with the updated values under header.

Gets the first value from header and updates it, all in one pass.

fun is called with the current first value under header in message (or nil if key is not present in message) and must return a two-element tuple: the “get” value (the retrieved value, which can be operated on before being returned) and the new value to be stored under header in the resulting new message. fun may also return :pop, which means the current value shall be removed from message and returned (making this function behave like Sippet.Message.pop_header_front(message, header). The returned value is a tuple with the “get” value returned by fun and a new message with the updated values under header.

Returns whether a given header exists in the given message.

Returns a list of all known methods, as a list of uppercase strings.

Example:

iex> Sippet.Message.known_methods()
["ACK", "BYE", "CANCEL", "INFO", "INVITE", "MESSAGE", "NOTIFY", "OPTIONS",
 "PRACK", "PUBLISH", "PULL", "PUSH", "REFER", "REGISTER", "STORE", "SUBSCRIBE",
 "UPDATE"]

Returns a list of all known transport protocols, as a list of uppercase strings.

Example:

iex> Sippet.Message.known_protocols()
["AMQP", "DCCP", "DTLS", "SCTP", "STOMP", "TCP", "TLS", "UDP", "WS", "WSS"]

Parses a SIP message header block as received by the transport layer.

In order to correctly set the message body, you have to verify the :content_length header; if it exists, it reflects the body size and you have to set it manually on the returned message.

Parses a SIP message header block as received by the transport layer.

Raises if the string is an invalid SIP header.

In order to correctly set the message body, you have to verify the :content_length header; if it exists, it reflects the body size and you have to set it manually on the returned message.

Puts the value under header on the message.

Puts the value under header on the message, as last element.

If the parameter value is nil, then the empty list will be appended to the header.

Puts the value under header on the message, as front element.

If the parameter value is nil, then the empty list will be prefixed to the header.

Puts the value under header on the message unless the header already exists.

Evaluates fun and puts the result under header in message unless header is already present.

This function is useful in case you want to compute the value to put under header only if header is not already present (e.g., the value is expensive to calculate or generally difficult to setup and teardown again).

Shortcut to check if the message is a request.

Shortcut to check if the message is a response.

Returns the iodata representation of the given Sippet.Message struct.

Converts a string representing a known method into an atom, otherwise as an uppercase string.

Example:

iex> Sippet.Message.to_method("INVITE")
:invite
iex> Sippet.Message.to_method("InViTe")
:invite
iex> Sippet.Message.to_method("aaa")
"AAA"

Converts a string representing a known protocol into an atom, otherwise as an uppercase string.

Example:

iex> Sippet.Message.to_protocol("UDP")
:udp
iex> Sippet.Message.to_protocol("uDp")
:udp
iex> Sippet.Message.to_protocol("aaa")
"AAA"

Returns the string representation of the given Sippet.Message struct.

Checks whether a message is valid.

Checks whether a message is valid, also checking if it corresponds to the indicated incoming transport tuple {protocol, host, port}.