SIP SIMPLE Client SDK

h1. SIP Core API

h2. Introduction

This chapter describes the internal architecture and API of the SIP core of the @sipsimple@ library.

@sipsimple@ is a Python package, the core of which wraps the PJSIP C library, which handles SIP signaling and audio media for the SIP SIMPLE client.

SIP stands for 'Sessions Initiation Protocol', an IETF standard described by "RFC 3261":http://tools.ietf.org/html/rfc3261. SIP is an application-layer control protocol that can establish,

modify and terminate multimedia sessions such as Internet telephony calls

(VoIP). Media can be added to (and removed from) an existing session.

SIP transparently supports name mapping and redirection services, which

supports personal mobility, users can maintain a single externally visible

address identifier, which can be in the form of a standard email address or

E.164 telephone number regardless of their physical network location.

SIP allows the endpoints to negotiate and combine any type of session they

mutually understand like video, instant messaging (IM), file transfer,

desktop sharing and provides a generic event notification system with

real-time publications and subscriptions about state changes that can be

used for asynchronous services like presence, message waiting indicator and

busy line appearance.

For a comprehensive overview of SIP related protocols and use cases visit http://www.tech-invite.com

h2. PJSIP library

@sipsimple@ builds on PJSIP http://www.pjsip.org, a set of static libraries, written in C, which provide SIP signaling and media capabilities.

PJSIP is considered to be the most mature and advanced open source SIP stack available.

The following diagram, taken from the PJSIP documentation, illustrates the library stack of PJSIP:

!{ nolink}http://www.pjsip.org/images/diagram.jpg!

The diagram shows that there is a common base library, and two more or less independent stacks of libraries, one for SIP signaling and one for SIP media.

The latter also includes an abstraction layer for the sound-card.

Both of these stracks are integrated in the high level library, called PJSUA.

PJSIP itself provides a high-level "Python wrapper for PJSUA":http://www.pjsip.org/python/pjsua.htm.

Despite this, the choice was made to bypass PJSUA and write the SIP core of the @sipsimple@ package as a Python wrapper, which directly uses the PJSIP and PJMEDIA libraries.

The main reasons for this are the following:

* PJSUA assumes a session with exactly one audio stream, whilst for the SIP SIMPLE client more advanced (i.e. low-level) manipulation of the SDP is needed.

* What is advertised as SIMPLE functionality, it is minimal and incomplete subset of it. Only page mode messaging using SIP MESSAGE method and basic device status presence are possible, while session mode IM and rich presence are desired.

* PJSUA integrates the decoding and encoding of payloads (e.g. presence related XML documents), while in the SIP SIMPLE client this should be done at a high level, not by the SIP stack.

PJSIP itself is by nature asynchronous.

In the case of PJSIP it means that in general there will be one thread which handles reception and transmission of SIP signaling messages by means of a polling function which is continually called by the application.

Whenever the application performs some action through a function, this function will return immediately.

If PJSIP has a result for this action, it will notify the application by means of a callback function in the context of the polling function thread.

> NOTE: Currently the core starts the media handling as a separate C thread to avoid lag caused by the GIL.

> The sound-card also has its own C thread.

h2. Architecture

The @sipsimple@ core wrapper itself is mostly written using "Cython":http://cython.org/ (formerly "Pyrex":http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/).

It allows a Python-like file with some added C manipulation statements to be compiled to C.

This in turn compiles to a Python C extension module, which links with the PJSIP static libraries.

The SIP core part of the @sipsimple@ Python library resides in the @sipsimple.core@ package. This package aggregates three modules, @sipsimple.core._core@, @sipsimple.core._engine@ and @sipsimple.core._primitives@. The former is a Python C extension module which makes wrappers around PJSIP objects available in Python, while the latter two contain SIP core objects written in Python. All core objects should be accessed from the enclosing @sipsimple.core@ module. The following list enumerates the various SIP core objects available:

* The @Engine@ class which is a Python wrapper around the low-level @PJSIPUA@ class. The latter represents the SIP endpoint and manages the initialization and destruction of all the PJSIP libraries. It is also the central management point to the SIP core. The application should not use the @PJSIPUA@ class directly, but rather through the wrapping @Engine@, which is a singleton class.

* Utility classes used throughout the core:

*** @frozenlist@ and @frozendict@: classes which relate respectively to @list@ and @dict@ similarly to how the standard @frozenset@ relates to @set@.

* Helper classes which represent a structured collection of data which is used throughout the core:

*** @BaseSIPURI@, @SIPURI@ and @FrozenSIPURI@

*** @BaseCredentials@, @Credentials@ and @FrozenCredentials@

* SDP manipulation classes, which directly wrap the PJSIP structures representing either the parsed or to be generated SDP:

*** @BaseSDPSession@, @SDPSession@ and @FrozenSDPSession@

*** @BaseSDPMediaStream@, @SDPMediaStream@ and @FrozenSDPMediaStream@

*** @BaseSDPConnection@, @SDPConnection@ and @FrozenSDPConnection@

*** @SDPAttributeList@ and @FrozenSDPAttributeList@

*** @BaseSDPAttribute@, @SDPAttribute@ and @FrozenSDPAttribute@

* Audio handling classes:

*** @AudioMixer@

*** @MixerPort@

*** @WaveFile@

*** @RecordingWaveFile@

*** @ToneGenerator@

* Media transport handling classes, using the functionality built into PJMEDIA:

*** @RTPTransport@

*** @AudioTransport@

* SIP signalling related classes:

*** @Request@ and @IncomingRequest@: low-level transaction support

*** @Invitation@: INVITE-dialog support

*** @Subscription@ and @IncomingSubscription@: SUBSCRIBE-dialog support (including NOTIFY handling within the SUBSCRIBE dialog)

*** @Referral@ and @IncomingReferral@: REFER-dialog support (including NOTIFY handling within the dialog)

*** @Registration@: Python object based on @Request@ for REGISTER support

*** @Message@: Python object based on @Request@ for MESSAGE support

*** @Publication@: Python object based on @Request@ for PUBLISH support

* Exceptions:

*** @SIPCoreError@: generic error used throught the core

*** @PJSIPError@: subclass of @SIPCoreError@ which offers more information related to errors from PJSIP

*** @PJSIPTLSError@: subclass of @PJSIPError@ to distinguish between TLS-related errors and the rest

*** @SIPCoreInvalidStateError@: subclass of @SIPCoreError@ used by objects which are based on a state-machine

Most of the objects cannot be used until the @Engine@ has been started. The following diagram illustrates these classes:

!{ nolink}sipsimple-core-classes.png!

Most of the SIP core does not allow duck-typing due to the nature of the integration between it and PJSIP. If these checks had not been employed, any errors could have resulted in a segmentation fault and a core dump. This also explains why several objects have a *Frozen* counterpart: the frozen objects are simply immutable versions of their non-frozen variants which make sure that low-level data is kept consistent and cannot be modified from Python. The *Base* versions are just base classes for the frozen and non-frozen versions provided mostly for convinience: they cannot be instantiated.

h2. Integration

The core itself has one Python dependency, the "application":http://pypi.python.org/pypi/python-application module, which in turn depends on the "zope.interface":http://pypi.python.org/pypi/zope.interface module.

These modules should be present on the system before the core can be used.

An application that uses the SIP core must use the notification system provided by the @application@ module in order to receive notifications from it.

It does this by creating one or more classes that act as an observer for particular messages and registering it with the @NotificationCenter@, which is a singleton class.

This means that any call to instance an object from this class will result in the same object.

As an example, this bit of code will create an observer for logging messages only:

<pre>

from zope.interface import implements

from application.notification import NotificationCenter, IObserver

class SIPEngineLogObserver(object):

    implements(IObserver)

    def handle_notification(self, notification):

        print "%(timestamp)s (%(level)d) %(sender)14s: %(message)s" % notification.data.__dict__

log_observer = SIPEngineLogObserver()

notification_center = NotificationCenter()

notification_center.add_observer(log_observer, name="SIPEngineLog")

</pre>

Each notification object has three attributes:

*sender*

>The object that sent the notification.

>For generic notifications the sender will be the @Engine@ instance, otherwise the relevant object.

*name*

>The name describing the notification.

>Most of the notifications in the core have the prefix "SIP".

*data*

>An instance of @application.notification.NotificationData@ or a subclass of it.

>The attributes of this object provide additional data about the notification.

>Notifications described in this document will also have the data attributes described.

Besides setting up the notification observers, the application should import the relevant objects from the @sipsimple.core@ module.

It can then instantiate the @Engine@ class, which is also a singleton, and start the PJSIP worker thread by calling @Engine.start()@, optionally providing a number of initialization options.

Most of these options can later be changed at runtime, by setting attributes of the same name on the @Engine@ object.

The application may then instantiate one of the SIP primitive classes and perform operations on it.

When starting the @Engine@ class, the application can pass a number of keyword arguments that influence the behaviour of the SIP endpoint.

For example, the SIP network ports may be set through the @local_udp_port@, @local_tcp_port@ and @local_tls_port@ arguments.

The UDP/RTP ports are described by a range of ports through @rtp_port_range@, two of which will be randomly selected for each @RTPTransport@ object and effectively each audio stream.

The methods called on the SIP primitive objects and the @Engine@ object (proxied to the @PJSIPUA@ instance) may be called from any thread.

They will return immediately and any delayed result, such as results depending on network traffic, will be returned later using a notification.

In this manner the SIP core continues the asynchronous pattern of PJSIP.

If there is an error in processing the request, an instance of @SIPCoreError@, or its subclass @PJSIPError@ will be raised.

The former will be raised whenever an error occurs inside the core, the latter whenever an underlying PJSIP function returns an error.

The @PJSIPError@ object also contains a status attribute, which is the PJSIP errno as an integer.

As a very basic example, one can @REGISTER@ for a sip account by typing the following lines on a Python console:

<pre>

from sipsimple.core import ContactHeader, Credentials, Engine, Registration, RouteHeader, SIPURI

e = Engine()

e.start()

identity = FromHeader(SIPURI(user="alice", host="example.com"), display_name="Alice")

cred = Credentials("alice", "mypassword")

reg = Registration(identity, credentials=cred)

reg.register(ContactHeader(SIPURI("127.0.0.1",port=12345)), RouteHeader(SIPURI("1.2.3.4", port=5060)))

</pre>

Note that in this example no observer for notifications from this @Registration@ object are registered, so the result of the operation cannot be seen.

Also note that this will not keep the registration registered when it is about to expire, as it is the application's responsibility.

See the @Registration@ documentation for more details.

Another convention that is worth mentioning at this point is that the SIP core will never perform DNS lookups.

For the sake of flexibility, it is the responsibility of the application to do this and pass the result to SIP core objects using the @RouteHeader@ object, indicating the destination IP address, port and transport the resulting SIP request should be sent to. The [[SipMiddlewareApi#Lookup|@sipsimple.lookup@]] module of the middleware can be used to perform DNS lookups according to RFC3263.

h2. Components

h3. Engine

As explained above, this singleton class needs to be instantiated by the application using the SIP core of @sipsimple@ and represents the whole SIP core stack.

Once the @start()@ method is called, it instantiates the @core.PJSIPUA@ object and will proxy attribute and methods from it to the application.

h4. attributes

*default_start_options* (class attribute)

>This dictionary is a class attribute that describes the default values for the initialization options passed as keyword arguments to the @start()@ method.

>Consult this method for documentation of the contents.

*is_running*

>A boolean property indicating if the @Engine@ is running and if it is safe to try calling any proxied methods or attributes on it.

h4. methods

*<notextile>__init__</notextile>*(_self_)

>This will either create the @Engine@ if it is called for the first time or return the one @Engine@ instance if it is called subsequently.

*start*(_self_, ***kwargs*)

>Initialize all PJSIP libraries based on the keyword parameters provided and start the PJSIP worker thread.

>If this fails an appropriate exception is raised.

>After the @Engine@ has been started successfully, it can never be started again after being stopped.

>The keyword arguments will be discussed here.

>Many of these values are also readable as (proxied) attributes on the Engine once the @start()@ method has been called.

>Many of them can also be set at runtime, either by modifying the attribute or by calling a particular method.

>This will also be documented for each argument in the following list of options.

>+_udp_port_+: (Default: @0@)

>The local UDP port to listen on for UDP datagrams.

>If this is 0, a random port will be chosen.

>If it is @None@, the UDP transport is disabled, both for incoming and outgoing traffic.

>As an attribute, this value is read-only, but it can be changed at runtime using the @set_udp_port()@ method.

>+_tcp_port_+: (Default: @0@)

>The local TCP port to listen on for new TCP connections.

>If this is 0, a random port will be chosen.

>If it is @None@, the TCP transport is disabled, both for incoming and outgoing traffic.

>As an attribute, this value is read-only, but it can be changed at runtime using the @set_tcp_port()@ method.

>+_tls_port_+: (Default: @0@)

>The local TCP port to listen on for new TLS over TCP connections.

>If this is 0, a random port will be chosen.

>If it is @None@, the TLS transport is disabled, both for incoming and outgoing traffic.

>As an attribute, this value is read-only, but it can be changed at runtime using the @set_tls_options()@ method, as internally the TLS transport needs to be restarted for this operation.

>+_tls_protocol_+: (Default: "TLSv1")

>This string describes the (minimum) TLS protocol that should be used. 

>Its values should be either @None@, "SSLv2", "SSLv23", "SSLv3" or "TLSv1". 

>If @None@ is specified, the PJSIP default will be used, which is currently "TLSv1". 

>+_tls_verify_server_+: (Default: @False@)

>This boolean indicates whether PJSIP should verify the certificate of the server against the local CA list when making an outgoing TLS connection.

>As an attribute, this value is read-only, but it can be changed at runtime using the @set_tls_options()@ method, as internally the TLS transport needs to be restarted for this operation.

>+_tls_ca_file_+: (Default: @None@)

>This string indicates the location of the file containing the local list of CA certificates, to be used for TLS connections.

>If this is set to @None@, no CA certificates will be read. 

>As an attribute, this value is read-only, but it can be changed at runtime using the @set_tls_options()@ method, as internally the TLS transport needs to be restarted for this operation. 

>+_tls_cert_file_+: (Default: @None@)

>This string indicates the location of a file containing the TLS certificate to be used for TLS connections. 

>If this is set to @None@, no certificate file will be read. 

>As an attribute, this value is read-only, but it can be changed at runtime using the @set_tls_options()@ method, as internally the TLS transport needs to be restarted for this operation. 

>+_tls_privkey_file_+: (Default: @None@)

>This string indicates the location of a file containing the TLS private key associated with the above mentioned certificated to be used for TLS connections. 

>If this is set to @None@, no private key file will be read. 

>As an attribute, this value is read-only, but it can be changed at runtime using the @set_tls_options()@ method, as internally the TLS transport needs to be restarted for this operation. 

>+_tls_timeout_+: (Default: 1000)

>The timeout value for a TLS negotiation in milliseconds. 

>Note that this value should be reasonably small, as a TLS negotiation blocks the whole PJSIP polling thread. 

>As an attribute, this value is read-only, but it can be changed at runtime using the @set_tls_options()@ method, as internally the TLS transport needs to be restarted for this operation.

>+_user_agent_+: (Default: @"sipsimple-%version-pjsip-%pjsip_version-r%pjsip_svn_revision"@)

>This value indicates what should be set in the @User-Agent@ header, which is included in each request or response sent.

>It can be read and set directly as an attribute at runtime.

>+_log_level_+: (Default: 5)

>This integer dictates the maximum log level that may be reported to the application by PJSIP through the @SIPEngineLog@ notification.

>By default the maximum amount of logging information is reported.

>This value can be read and set directly as an attribute at runtime.

>+_trace_sip_+: (Default: @False@)

>This boolean indicates if the SIP core should send the application SIP messages as seen on the wire through the @SIPEngineSIPTrace@ notification.

>It can be read and set directly as an attribute at runtime.

>+_rtp_port_range_+: (Default: (40000, 40100))

>This tuple of two integers indicates the range to select UDP ports from when creating a new @RTPTransport@ object, which is used to transport media.

>It can be read and set directly as an attribute at runtime, but the ports of previously created @RTPTransport@ objects remain unaffected.

>+_codecs_+: (Default: @["speex", "G722", "PCMU", "PCMA", "iLBC", "GSM"]@)

>This list specifies the codecs to use for audio sessions and their preferred order.

>It can be read and set directly as an attribute at runtime.

>Note that this global option can be overridden by an argument passed to @AudioTransport.__init__()@.

>The strings in this list is case insensitive.

>+_events_+: (Default: <some sensible events>)

>PJSIP needs a mapping between SIP SIMPLE event packages and content types.

>This dictionary provides some default packages and their event types.

>As an attribute, this value is read-only, but it can be changed at runtime using the @add_event()@ method.

>+_incoming_events_+: (Default: @set()@)

>A list that specifies for which SIP SIMPLE event packages the application wishes to receive @IncomingSubscribe@ objects.

>When a @SUBSCRIBE@ request is received containing an event name that is not in this list, a 489 "Bad event" response is internally generated.

>When the event is in the list, an @IncomingSubscribe@ object is created based on the request and passed to the application by means of a notification.

>Note that each of the events specified here should also be a key in the @events@ dictionary argument.

>As an attribute, this value is read-only, but it can be changed at runtime using the @add_incoming_event()@ and @remove_incoming_event()@ methods.

>+_incoming_requests_+: (Default: @set()@)

>A set of methods for which @IncomingRequest@ objects are created and sent to the application if they are received.

>Note that receiving requests using the @INVITE@, @SUBSCRIBE@, @ACK@ or @BYE@ methods in this way is not allowed.

>Requests using the @OPTIONS@ or @MESSAGE@ method are handled internally, but may be overridden.

*stop*(_self_)

>Stop the PJSIP worker thread and unload all PJSIP libraries.

>Note that after this all references to SIP core objects can no longer be used, these should be properly removed by the application itself before stopping the @Engine@.

>Also note that, once stopped the @Engine@ cannot be started again.

>This method is automatically called when the Python interpreter exits.

h4. proxied attributes

Besides all the proxied attributes described for the @__init__@ method above, thse other attributes are provided once the @Engine@ has been started.

*input_devices*

>This read-only attribute is a list of strings, representing all audio input devices on the system that can be used.

>One of these device names can be passed as the @input_device@ argument when creating a @AudioMixer@ object.

*output_devices*

>This read-only attribute is a list of strings, representing all audio output devices on the system that can be used.

>One of these device names can be passed as the @output_device@ argument when creating a @AudioMixer@ object.

*sound_devices*

>This read-only attribute is a list of strings, representing all audio sound devices on the system that can be used.

*available_codecs*

>A read-only list of codecs available in the core, regardless of the codecs configured through the @codecs@ attribute.

h4. proxied methods

*add_event*(_self_, *event*, *accept_types*)

>Couple a certain event package to a list of content types.

>Once added it cannot be removed or modified.

*add_incoming_event*(_self_, *event*)

>Adds a SIP SIMPLE event package to the set of events for which the @Engine@ should create an @IncomingSubscribe@ object when a @SUBSCRIBE@ request is received.

>Note that this event should be known to the @Engine@ by means of the @events@ attribute.

*remove_incoming_event*(_self_, *event*)

>Removes an event from the @incoming_events@ attribute.

>Incoming @SUBSCRIBE@ requests with this event package will automatically be replied to with a 489 "Bad Event" response.

*add_incoming_request*(_self_, *method*)

>Add a method to the set of methods for which incoming requests should be turned into @IncomingRequest@ objects.

>For the rules on which methods are allowed, see the description of the Engine attribute above.

*remove_incoming_request*(_self_, *method*)

>Removes a method from the set of methods that should be received.

*detect_nat_type*(_self_, *stun_server_address*, *stun_server_port*=3478, *user_data*=None)

>Will start a series of STUN requests which detect the type of NAT this host is behind.

>The @stun_server_address@ parameter indicates the IP address or hostname of the STUN server to be used and @stun_server_port@ specifies the remote UDP port to use.

>When the type of NAT is detected, this will be reported back to the application by means of a @SIPEngineDetectedNATType@ notification, including the user_data object passed with this method.

*set_udp_port*(_self_, *value*)

>Update the @local_udp_port@ attribute to the newly specified value.

*set_tcp_port*(_self_, *value*)

>Update the @local_tcp_port@ attribute to the newly specified value.

*set_tls_options*(_self_, *local_port*=@None@, *protocol*="TLSv1", *verify_server*=@False@, *ca_file*=@None@, *cert_file*=@None@, *privkey_file*=@None@, *timeout*=1000) 

>Calling this method will (re)start the TLS transport with the specified arguments, or stop it in the case that the *local_port* argument is set to @None@. 

>The semantics of the arguments are the same as on the @start()@ method. 

h4. notifications

Notifications sent by the @Engine@ are notifications that are related to the @Engine@ itself or unrelated to any SIP primitive object.

They are described here including the data attributes that is included with them.

*SIPEngineWillStart*

>This notification is sent when the @Engine@ is about to start.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

*SIPEngineDidStart*

>This notification is sent when the @Engine@ is has just been started.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

*SIPEngineDidFail*

>This notification is sent whenever the @Engine@ has failed fatally and either cannot start or is about to stop.

>It is not recommended to call any methods on the @Engine@ at this point.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

*SIPEngineWillEnd*

>This notification is sent when the @Engine@ is about to stop because the application called the @stop()@ method.

>Methods on the @Engine@ can be called at this point, but anything that has a delayed result will probably not return any notification.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

*SIPEngineDidEnd*

>This notification is sent when the @Engine@ was running and is now stopped, either because of failure or because the application requested it.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

*SIPEngineLog*

>This notification is a wrapper for PJSIP logging messages.

>It can be used by the application to output PJSIP logging to somewhere meaningful, possibly doing filtering based on log level.

>+_timestamp_+:

>A @datetime.datetime@ object representing the time when the log message was output by PJSIP.

>+_sender_+:

>The PJSIP module that originated this log message.

>+_level_+:

>The logging level of the message as an integer.

>Currently this is 1 through 5, 1 being the most critical.

>+_message_+:

>The actual log message.

*SIPEngineSIPTrace*

>Will be sent only when the @do_siptrace@ attribute of the @Engine@ instance is set to @True@.

>The notification data attributes will contain the SIP messages as they are sent and received on the wire.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

>+_received_+:

>A boolean indicating if this message was sent from or received by PJSIP (i.e. the direction of the message).

>+_source_ip_+:

>The source IP address as a string.

>+_source_port_+:

>The source port of the message as an integer.

>+_destination_ip_+:

>The destination IP address as a string.

>+_source_port_+:

>The source port of the message as an integer.

>+_data_+:

>The contents of the message as a string.

> For received message the destination_ip and for sent messages the source_ip may not be reliable.

*SIPEngineDetectedNATType*

>This notification is sent some time after the application request the NAT type this host behind to be detected using a STUN server.

>Note that there is no way to associate a request to do this with a notification, although every call to the @detect_nat_type()@ method will generate exactly one notification.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

>+_succeeded_+:

>A boolean indicating if the NAT detection succeeded.

>+_user_data_+:

>The @user_data@ argument passed while calling the @detect_nat_type()@ method.

>This can be any object and could be used for matching requests to responses.

>+_nat_type_+:

>A string describing the type of NAT found.

>This value is only present if NAT detection succeeded.

>+_error_+:

>A string indicating the error that occurred while attempting to detect the type of NAT.

>This value only present if NAT detection did not succeed.

*SIPEngineGotException*

>This notification is sent whenever there is an unexpected exception within the PJSIP working thread.

>The application should show the traceback to the user somehow.

>An exception need not be fatal, but if it is it will be followed by a *SIPEngineDidFail* notification.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

>+_traceback_+:

>A string containing the traceback of the exception.

>In general this should be printed on the console.

*SIPEngineGotMessage*

>This notification is sent whenever the Engine receives a @MESSAGE@ request.

>+_request_uri_+:

>The request URI of the @MESSAGE@ request as a @SIPURI@ object.

>+_from_header_+:

>The From header of the @MESSAGE@ request as a @FrozenFromHeader@ object.

>+_to_header_+:

>The To header of the @MESSAGE@ request as a @FrozenToHeader@ object.

>+_content_type_+:

>The Content-Type header value of the @MESSAGE@ request as a @ContentType@ object.

>+_headers_+:

>The headers of the @MESSAGE@ request as a dict.

>Each SIP header is represented in its parsed for as long as PJSIP supports it.

>The format of the parsed value depends on the header.

>+_body_+:

>The body of the @MESSAGE@ request as a string, or @None@ if no body was included.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

h3. SIPURI

These are helper objects for representing a SIP URI.

This object needs to be used whenever a SIP URI should be specified to the SIP core.

It supports comparison to other @SIPURI@ objects using the == and != expressions.

As all of its attributes are set by the @__init__@ method, the individual attributes will not be documented here. The FrozenSIPURI object does not allow any of its attributes to be changed after initialization.

h4. methods

*<notextile>__init__</notextile>*(_self_, *host*, *user*=@None@, *port*=@None@, *display*=@None@, *secure*=@False@, *parameters*=@None@, *headers*=@None@)

>Creates the SIPURI object with the specified parameters as attributes.

  @host@ is the only mandatory attribute.

>+_host_+:

>The host part of the SIP URI as a string.

>+_user_+:

>The username part of the SIP URI as a string, or None if not set.

>+_port_+:

>The port part of the SIP URI as an int, or None or 0 if not set.

>+_display_+:

>The optional display name of the SIP URI as a string, or None if not set.

>+_secure_+:

>A boolean indicating whether this is a SIP or SIPS URI, the latter being indicated by a value of @True@.

>+_parameters_+:

>The URI parameters. represented by a dictionary.

>+_headers_+:

>The URI headers, represented by a dictionary.

*<notextile>__str__</notextile>*(_self_)

>The special Python method to represent this object as a string, the output is the properly formatted SIP URI.

*new*(_cls_, _sipuri_)

>Classmethod that returns an instance of the class on which it has been called which is a copy of the @sipuri@ object (which must be either a SIPURI or a FrozenSIPURI).

*parse*(_cls_, _uri_str_)

>Classmethod that returns an instance of the class on which it has been called which is represents the parsed version of the URI provided as a string. A SIPCoreError is raised if the string is invalid or if the Engine has not been started yet.

*matches*(_self_, _address_)

>This method returns @True@ or @False@ depending on whether the string address contains a SIP address whose components are a subset of the components of self. For example, @SIPURI.parse('sip:alice@example.org:54321;transport=tls').matches('alice@example.org')@ returns @True@ while @SIPURI.parse('sip:alice@example.org;transport=tls').matches('sips:alice@example.org')@ returns @False@.

h3. Credentials

The @Credentials@ and @FrozenCredentails@ simple objects represent authentication credentials for a particular SIP account.

These can be included whenever creating a SIP primitive object that originates SIP requests.

The attributes of this object are the same as the arguments to the @__init__@ method.

Note that the domain name of the SIP account is not stored on this object.

h4. methods

*<notextile>__init__</notextile>*(_self_, *username*, *password*)

>Creates the Credentials object with the specified parameters as attributes.

>Each of these attributes can be accessed and changed on the object once instanced.

>+_username_+:

>A string representing the username of the account for which these are the credentials.

>+_password_+:

>The password for this SIP account as a string.

*new*(_cls_, _credentials_)

>Classmethod that returns an instance of the class on which it has been called which is a copy of the @credentials@ object (which must be either a Credentials or a FrozenCredentials).

h3. Invitation

The @Invitation@ class represents an @INVITE@ session, which governs a complete session of media exchange between two SIP endpoints from start to finish.

It is implemented to be agnostic to the media stream or streams negotiated, which is achieved by using the @SDPSession@ class and its companion classes, which directly represents the parsed SDP.

The @Invitation@ class represents both incoming and outgoing sessions.

The state machine contained in each @Invitation@ object is based on the one used by the underlying PJSIP "pjsip_inv_session":http://www.pjsip.org/pjsip/docs/html/group+PJSIP+INV.htm object.

In order to represent re-@INVITE@s and user-requested disconnections, three more states have been added to this state machine.

The progression through this state machine is fairly linear and is dependent on whether this is an incoming or an outgoing session.

State changes are triggered either by incoming or by outgoing SIP requests and responses.

The states and the transitions between them are shown in the following diagram:

!{ nolink}sipsimple-core-invite-state-machine.png!

The state changes of this machine are triggered by the following:

# An @Invitation@ object is newly created, either by the application for an outgoing session, or by the core for an incoming session.

# The application requested an outgoing session by calling the @send_invite()@ method and and initial @INVITE@ request is sent.

# A new incoming session is received by the core.

    The application should look out for state change to this state in order to be notified of new incoming sessions.

# A provisional response (1xx) is received from the remove party.

# A provisional response (1xx) is sent to the remote party, after the application called the @respond_to_invite_provisionally()@ method.

# A positive final response (2xx) is received from the remote party.

# A positive final response (2xx) is sent to the remote party, after the application called the @accept_invite()@ method.

# A positive final response (2xx) is sent or received, depending on the orientation of the session.

# An @ACK@ is sent or received, depending on the orientation of the session.

    If the @ACK@ is sent from the local to the remote party, it is initiated by PJSIP, not by a call from the application.

# The local party sent a re-@INVITE@ to the remote party by calling the @send_reinvite()@ method.

# The remote party has sent a final response to the re-@INVITE@.

# The remote party has sent a re-@INVITE@.

# The local party has responded to the re-@INVITE@ by calling the @respond_to_reinvite()@ method.

# The application requests that the session ends by calling the @end()@ method.

# A response is received from the remote party to whichever message was sent by the local party to end the session.

# A message is received from the remote party which ends the session.

The application is notified of a state change in either state machine through the @SIPInvitationChangedState@ notification, which has as data the current and previous states.

If the event is triggered by and incoming message, extensive data about that message, such as method/code, headers and body, is also included with the notification.

The application should compare the previous and current states and perform the appropriate action.

An @Invitiation@ object also emits the @SIPInvitationGotSDPUpdate@ notification, which indicates that SDP negotiation between the two parties has been completed.

This will occur (at least) once during the initial session negotiation steps, during re-@INVITE@s in both directions and whenever an @UPDATE@ request is received.

In the last case, the @Invitation@ object will automatically include the current local SDP in the response.

h4. attributes

*state*

>The state the @Invitation@ state machine is currently in.

>See the diagram above for possible states.

>This attribute is read-only.

*sub_state*

>The sub-state the @Invitation@ state machine is currently in.

>See the diagram above for possible states.

>This attribute is read-only.

*directing*

>A string with the values @"incoming"@ or @"outgoing"@ depending on the direction of the original INVITE request.

*credentials*

>The SIP credentials needed to authenticate at the SIP proxy in the form of a @FrozenCredentials@ object.

>If this @Invitation@ object represents an incoming @INVITE@ session this attribute will be @None@.

>On an outgoing session this attribute will be @None@ if it was not specified when the object was created.

>This attribute is set on object instantiation and is read-only.

*from_header*

>The From header of the caller represented by a @FrozenFromHeader@ object.

>If this is an outgoing @INVITE@ session, this is the from_header from the @send_invite()@ method.

>Otherwise the URI is taken from the @From:@ header of the initial @INVITE@.

>This attribute is set on object instantiation and is read-only.

*to_header*

>The To header of the callee represented by a @FrozenToHeader@ object.

>If this is an outgoing @INVITE@ session, this is the to_header from the @send_invite()@ method.

>Otherwise the URI is taken from the @To:@ header of the initial @INVITE@.

>This attribute is set on object instantiation and is read-only.

*local_identity*

>The From or To header representing the local identity used in this session.

>If the original @INVITE@ was incoming, this is the same as @to_header@, otherwise it will be the same as @from_header@.

*remote_identity*

>The From or To header representing the remote party in this session.

>If the original @INVITE@ was incoming, this is the same as @from_header@, otherwise it will be the same as @to_header@.

*route_header*

>The outbound proxy that was requested to be used in the form of a @FrozenRouteHeader@ object, including the desired transport.

>If this @Invitation@ object represents an incoming @INVITE@ session this attribute will always be @None@.

>This attribute is set on object instantiation and is read-only.

*call_id*

>The call ID of the @INVITE@ session as a read-only string.

>In the @NULL@ and @DISCONNECTED@ states, this attribute is @None@.

*transport*

>A string indicating the transport used for the application.

>This can be "udp", "tcp" or "tls".

*local_contact_header*

>The Contact header that the local side provided to the remote side within this @INVITE@ session as a @FrozenContactHeader@ object.

>Note that this can either be set on object creation or updated using the @send_reinvite()@ method.

*remote_contact_header*

>The Contact header that the remote side provided to us within this @INVITE@ session as a @FrozenContactHeader@ object.

*call_id*

>A string representing the Call-Id header value of this INVITE dialog.

*remote_user_agent*

>A string representing the remote user agent taken from the User-Agent or Server headers (depending on the direction of the original INVITE).

*sdp.proposed_local*

>The currently proposed sdp by the local party in the form of a @FrozenSDPSession@ object. This attribute is None when an SDP proposal is not in progress.

*sdp.proposed_remote*

>The currently proposed sdp by the remote party in the form of a @FrozenSDPSession@ object. This attribute is None when an SDP proposal is not in progress.

*sdp.active_local*

>The currently active sdp of the local party in the form of a @FrozenSDPSession@ object. This attribute is None if no SDP proposal has succeeded before.

*sdp.active_remote*

>The currently active sdp of the remote party in the form of a @FrozenSDPSession@ object. This attribute is None if no SDP proposal has succeeded before.

*peer_address*

>This read-only attribute contains the remote endpoint IP and port information. It can be accessed by accessing this object's @ip@ and @port@ attributes.

h4. methods

*<notextile>__init__</notextile>*(_self_)

>Creates a new @Invitation@ object.

*send_invite*(_self_, *request_uri*,*from_header*, *to_header*, *route_header*, *contact_header*, *sdp*, *credentials*=@None@, *extra_headers*=@[]@, *timeout*=None)

>+_request_uri_+:

>Request URI to be set inthe outgoing INVITE request.

>+_from_header_+:

>The identity of the local account in the form of a @FromHeader@ object.

>+_to_header_+:

>The identity we want to send the @INVITE@ to, represented as a @ToHeader@ object.

>+_route_header_+:

>The outbound proxy to use in the form of a @RouteHeader@ object.

>This includes the desired transport to use.

>+_contact_header_+:

>The Contact header to include in the @INVITE@ request, a @ContactHeader@ object.

>+_sdp_+:

>The SDP to send as offer to the remote party.

>+_credentials_+:

>The optional SIP credentials needed to authenticate at the SIP proxy in the form of a @Credentials@ object.

>+_extra_headers_+:

>Any extra headers that should be included in the @INVITE@ request in the form of a list of header objects.

>+_timeout_+:

>How many seconds to wait for the remote party to reply before changing the state to @DISCONNECTED@ and internally replying with a 408, as an int or a float.

>If this is set to @None@, the default PJSIP timeout will be used, which appears to be slightly longer than 30 seconds.

*send_response*(_self_, *code*, *reason*, *contact_header*, *sdp*, *extra_headers*)

>Send a response to a INVITE request. 

>+_code_+:

>The code of the response to use as an int.

>+_reason_+:

>The reason of the response as a str.

>+_contact_header_+:

>The Contact header to include in the response, a @ContactHeader@ object.

>+_sdp_+:

>The SDP to send as offer/response to the remote party.

>+_extra_headers_+:

>Any extra headers that should be included in the response in the form of a list of header objects.

*send_reinvite*(_self_, *contact_header*=@None@, *sdp*=@None@, *extra_header*=@[]@)

>+_contact_header_+:

>The Contact header if it needs to be changed by the re-INVITE or None if it shouldn't be changed; a @BaseContactHeader@ object.

>+_sdp_+:

>The SDP to send as offer to the remote party or None if the re-INVITE should not change the SDP; a @BaseSDPSession@ object.

>+_extra_headers_+:

>Any extra headers that should be included in the response in the form of a list of header objects.

*cancel_reinvite*(_self_)

>Send a CANCEL after a re-INVITE has been sent to cancel the action of the re-INVITE.

*end*(_self_, *extra_headers*=@[]@, *timeout*=@None@)

>This moves the @INVITE@ state machine into the @DISCONNECTING@ state by sending the necessary SIP request.

>When a response from the remote party is received, the state machine will go into the @DISCONNECTED@ state.

>Depending on the current state, this could be a CANCEL or a BYE request.

>+_extra_headers_+:

>Any extra headers that should be included in the request or response in the form of a dict.

>+_timeout_+:

>How many seconds to wait for the remote party to reply before changing the state to @DISCONNECTED@, as an int or a float.

>If this is set to @None@, the default PJSIP timeout will be used, which currently appears to be 3.5 seconds for an established session.

h4. notifications

*SIPInvitationChangedState*

>This notification is sent by an @Invitation@ object whenever its state machine changes state.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

>+_prev_state_+:

>The previous state of the INVITE state machine.

>+_prev_sub_state_+:

>THe previous sub-state of the INVITE state machine.

>+_state_+:

>The new state of the INVITE state machine, which may be the same as the previous state.

>+_sub_state_+:

>The new sub-state of teh INVITE state machine, which may be the same as the previous sub-state.

>+_method_+: (only if the state change got triggered by an incoming SIP request)

>The method of the SIP request as a string.

>+_request_uri_+: (only if the state change got triggered by an incoming SIP request)

>The request URI of the SIP request as a @SIPURI@ object.

>+_code_+: (only if the state change got triggered by an incoming SIP response or internal timeout or error)

>The code of the SIP response or error as an int.

>+_reason_+: (only if the state change got triggered by an incoming SIP response or internal timeout or error)

>The reason text of the SIP response or error as a string.

>+_headers_+: (only if the state change got triggered by an incoming SIP request or response)

>The headers of the SIP request or response as a dict.

>Each SIP header is represented in its parsed for as long as PJSIP supports it.

>The format of the parsed value depends on the header.

>+_body_+: (only if the state change got triggered by an incoming SIP request or response)

>The body of the SIP request or response as a string, or @None@ if no body was included.

>The content type of the body can be learned from the @Content-Type:@ header in the headers argument.

*SIPInvitationGotSDPUpdate*

>This notification is sent by an @Invitation@ object whenever SDP negotiation has been performed.

>It should be used by the application as an indication to start, change or stop any associated media streams.

>+_timestamp_+:

>A @datetime.datetime@ object indicating when the notification was sent.

>+_succeeded_+:

>A boolean indicating if the SDP negotiation has succeeded.

>+_error_+: (only if SDP negotiation did not succeed)

>A string indicating why SDP negotiation failed.

>+_local_sdp_+: (only if SDP negotiation succeeded)

>A SDPSession object indicating the local SDP that was negotiated.

>+_remote_sdp_+: (only if SDP negotiation succeeded)

>A SDPSession object indicating the remote SDP that was negotiated.

h3. SDPSession

SDP stands for Session Description Protocol. Session Description Protocol (SDP) is a format for describing streaming media initialization parameters in an ASCII string. SDP is intended for describing multimedia communication sessions for the purposes of session announcement, session invitation, and other forms of multimedia session initiation. It is an IETF standard described by "RFC 4566":http://tools.ietf.org/html/rfc4566. "RFC 3264":http://tools.ietf.org/html/rfc3264 defines an Offer/Answer Model with the Session Description Protocol (SDP), a mechanism by which two entities can make use of the Session Description Protocol (SDP) to arrive at a common view of a multimedia session between them. 

@SDPSession@ and @FrozenSDPSession@ objects directly represent the contents of a SDP body, as carried e.g. in an INVITE request, and is a simple wrapper for the PJSIP "pjmedia_sdp_session":http://www.pjsip.org/pjmedia/docs/html/structpjmedia+sdp+session.htm structure.

They can be passed to those methods of an @Invitation@ object that result in transmission of a message that includes SDP, or are passed to the application through a notification that is triggered by reception of a message that includes SDP.

A @(Frozen)SDPSession@ object may contain @(Frozen)SDPMediaStream@, @(Frozen)SDPConnection@ and @(Frozen)SDPAttribute@ objects.

It supports comparison to other @(Frozen)SDPSession@ objects using the == and != expressions.

As all the attributes of the @(Frozen)SDPSession@ class are set by attributes of the @__init__@ method, they will be documented along with that method.

h4. methods

*<notextile>__init__</notextile>*(_self_, *address*, *id*=@None@, *version*=@None@, *user=*"-", net_type="IN", *address_type*="IP4", *name*=" ", *info*=@None@, *connection*=@None@, *start_time*=0, *stop_time*=0, *attributes*=@None@, *media*=@None@)

>Creates the SDPSession object with the specified parameters as attributes.

>Each of these attributes can be accessed and changed on the object once instanced.

>+_address_+:

>The address that is contained in the "o" (origin) line of the SDP as a string.

>+_id_+:

>The session identifier contained in the "o" (origin) line of the SDP as an int.

>If this is set to @None@ on init, a session identifier will be generated.

>+_version_+:

>The version identifier contained in the "o" (origin) line of the SDP as an int.

>If this is set to @None@ on init, a version identifier will be generated.

>+_user_+:

>The user name contained in the "o" (origin) line of the SDP as a string.

>+_net_type_+:

>The network type contained in the "o" (origin) line of the SDP as a string.

>+_address_type_+:

>The address type contained in the "o" (origin) line of the SDP as a string.

>+_name_+:

>The contents of the "s" (session name) line of the SDP as a string.

>+_info_+:

>The contents of the session level "i" (information) line of the SDP as a string.

>If this is @None@ or an empty string, the SDP has no "i" line.

>+_connection_+:

>The contents of the "c" (connection) line of the SDP as a @(Frozen)SDPConnection@ object.

>If this is set to @None@, the SDP has no session level "c" line.

>+_start_time_+:

>The first value of the "t" (time) line of the SDP as an int.

>+_stop_time_+:

>The second value of the "t" (time) line of the SDP as an int.

>+_attributes_+:

>The session level "a" lines (attributes) in the SDP represented by a list of @(Frozen)SDPAttribute@ objects.

>+_media_+:

>The media sections of the SDP represented by a list of @(Frozen)SDPMediaStream@ objects.

*new*(_cls_, _sdp_session_)

>Classmethod that returns an instance of the class on which it has been called which is a copy of the @sdp_session@ object (which must be either a SDPSession or a FrozenSDPSession).

h4. attributes

*has_ice_proposal*

>This read-only attribute returns @True@ if the SDP contains any attributes which indicate the existence of an ice proposal and @False@ otherwise.

h3. SDPMediaStream

The @SDPMediaStream@ and @FrozenSDPMediaStream@ objects represent the contents of a media section of a SDP body, i.e. a "m" line and everything under it until the next "m" line.

It is a simple wrapper for the PJSIP "pjmedia_sdp_media":http://www.pjsip.org/pjmedia/docs/html/structpjmedia+sdp+media.htm structure.

One or more @(Frozen)SDPMediaStream@ objects are usually contained in a @(Frozen)SDPSession@ object.

It supports comparison to other @(Frozen)SDPMedia@ objects using the == and != expressions.

As all the attributes of this class are set by attributes of the @__init__@ method, they will be documented along with that method.

h4. methods

*<notextile>__init__</notextile>*(_self_, *media*, *port*, *transport*, *port_count*=1, *formats*=@None@, *info*=@None@, *connection*=@None@, *attributes*=@None@)

>Creates the SDPMedia object with the specified parameters as attributes.

>Each of these attributes can be accessed and changed on the object once instanced.

>+_media_+:

>The media type contained in the "m" (media) line as a string.

>+_port_+:

>The transport port contained in the "m" (media) line as an int.

>+_transport_+:

>The transport protocol in the "m" (media) line as a string.

>+_port_count_+:

>The port count in the "m" (media) line as an int.

>If this is set to 1, it is not included in the SDP.

>+_formats_+:

>The media formats in the "m" (media) line represented by a list of strings.

>+_info_+:

>The contents of the "i" (information) line of this media section as a string.

>If this is @None@ or an empty string, the media section has no "i" line.

>+_connection_+:

>The contents of the "c" (connection) line that is somewhere below the "m" line of this section as a @(Frozen)SDPConnection@ object.

>If this is set to @None@, this media section has no "c" line.

>+_attributes_+:

>The "a" lines (attributes) that are somewhere below the "m" line of this section represented by a list of @(Frozen)SDPAttribute@ objects.

*new*(_cls_, _sdp_media_)

>Classmethod that returns an instance of the class on which it has been called which is a copy of the @sdp_media@ object (which must be either a SDPMediaStream or a FrozenSDPMediaStream).

h4. attributes

*direction*

>This is a convenience read-only attribute that goes through all the attributes of the media section and returns the direction, which is either "sendrecv", "sendonly", "recvonly" or "inactive".

>If none of these attributes is present, the default direction is "sendrecv".

h3. SDPConnection

The @SDPConnection@ and @FrozenSDPConnection@ objects represents the contents of a "c" (connection) line of a SDP body, either at the session level or for an individual media stream.

It is a simple wrapper for the PJSIP "pjmedia_sdp_conn":http://www.pjsip.org/pjmedia/docs/html/structpjmedia+sdp+conn.htm structure.

A @(Frozen)SDPConnection@ object can be contained in a @(Frozen)SDPSession@ object or @(Frozen)SDPMediaStream@ object.

It supports comparison to other @(Frozen)SDPConnection@ objects using the == and != expressions.

As all the attributes of this class are set by attributes of the @__init__@ method, they will be documented along with that method.

h4. methods