View Source Sippet.Message.RequestLine (Sippet v1.0.16)

A SIP Request-Line struct, composed by the Method, Request-URI and SIP-Version.

The start_line of requests are represented by this struct. The RFC 3261 represents the Request-Line as:

Request-Line  =  Method SP Request-URI SP SIP-Version CRLF

The above Method is represented by atoms, when the method is a known one, or by binaries, when the method is unknown. Known ones are :ack, :invite, :register, :cancel, :message and all others returned by the function Sippet.Message.known_methods/0.

The Request-URI is represented by a Sippet.URI struct, breaking down the SIP-URI in more useful parts for processing.

The SIP-Version is a {major, minor} tuple, which assumes the value {2, 0} in standard implementations.

Summary

Types

method()
t()
uri()
version()

Functions

new(method, request_uri)

Creates a Request-Line struct.

to_iodata(request_line)

Returns an iodata which corresponds to the text representation of the given Request-Line.

to_string(value)

Returns a binary which corresponds to the text representation of the given Request-Line.

Types

Link to this type

method()

View Source 
@type method() :: Sippet.Message.method()
Link to this type

t()

View Source 
@type t() :: %Sippet.Message.RequestLine{
  method: method(),
  request_uri: uri(),
  version: version()
}
Link to this type

uri()

View Source 
@type uri() :: Sippet.URI.t()
Link to this type

version()

View Source 
@type version() :: {integer(), integer()}

Functions

Link to this function

new(method, request_uri)

View Source 
@spec new(method(), uri() | binary()) :: t()

Creates a Request-Line struct.

The version will assume the default value {2, 0}.

Link to this function

to_iodata(request_line)

View Source 
@spec to_iodata(t()) :: iodata()

Returns an iodata which corresponds to the text representation of the given Request-Line.

It does not includes an ending line CRLF.

Link to this function

to_string(value)

View Source 
@spec to_string(t()) :: binary()

Returns a binary which corresponds to the text representation of the given Request-Line.

It does not includes an ending line CRLF.