SipCoreApiDocumentation

Version 113 (Anonymous, 04/21/2011 10:20 am)

1 89 Adrian Georgescu
= SIP Core API =
2 1 Adrian Georgescu
3 101 Adrian Georgescu
[[TOC(SipMiddlewareApi, SipConfigurationAPI, SipCoreApiDocumentation, depth=3)]]
4 5 Adrian Georgescu
5 1 Adrian Georgescu
== Introduction ==
6 1 Adrian Georgescu
7 13 Adrian Georgescu
This chapter describes the internal architecture and API of the SIP core of the {{{sipsimple}}} library.
8 71 Adrian Georgescu
{{{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.
9 1 Adrian Georgescu
10 1 Adrian Georgescu
SIP stands for 'Sessions Initiation Protocol', an IETF standard described by [http://tools.ietf.org/html/rfc3261 RFC 3261]. SIP is an application-layer control protocol that can establish,
11 1 Adrian Georgescu
modify and terminate multimedia sessions such as Internet telephony calls
12 1 Adrian Georgescu
(VoIP). Media can be added to (and removed from) an existing session.
13 1 Adrian Georgescu
14 1 Adrian Georgescu
SIP transparently supports name mapping and redirection services, which
15 1 Adrian Georgescu
supports personal mobility, users can maintain a single externally visible
16 1 Adrian Georgescu
address identifier, which can be in the form of a standard email address or
17 1 Adrian Georgescu
E.164 telephone number regardless of their physical network location.
18 1 Adrian Georgescu
19 1 Adrian Georgescu
SIP allows the endpoints to negotiate and combine any type of session they
20 1 Adrian Georgescu
mutually understand like video, instant messaging (IM), file transfer,
21 1 Adrian Georgescu
desktop sharing and provides a generic event notification system with
22 1 Adrian Georgescu
real-time publications and subscriptions about state changes that can be
23 1 Adrian Georgescu
used for asynchronous services like presence, message waiting indicator and
24 1 Adrian Georgescu
busy line appearance.
25 1 Adrian Georgescu
26 1 Adrian Georgescu
For a comprehensive overview of SIP related protocols and use cases visit http://www.tech-invite.com
27 1 Adrian Georgescu
28 30 Adrian Georgescu
== PJSIP library ==
29 1 Adrian Georgescu
30 1 Adrian Georgescu
{{{sipsimple}}} builds on PJSIP [http://www.pjsip.org], a set of static libraries, written in C, which provide SIP signaling and media capabilities.
31 1 Adrian Georgescu
PJSIP is considered to be the most mature and advanced open source SIP stack available.
32 1 Adrian Georgescu
The following diagram, taken from the PJSIP documentation, illustrates the library stack of PJSIP:
33 1 Adrian Georgescu
34 1 Adrian Georgescu
[[Image(http://www.pjsip.org/images/diagram.jpg, nolink)]]
35 1 Adrian Georgescu
36 1 Adrian Georgescu
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.
37 71 Adrian Georgescu
The latter also includes an abstraction layer for the sound-card.
38 1 Adrian Georgescu
Both of these stracks are integrated in the high level library, called PJSUA.
39 1 Adrian Georgescu
40 1 Adrian Georgescu
PJSIP itself provides a high-level [http://www.pjsip.org/python/pjsua.htm Python wrapper for PJSUA].
41 1 Adrian Georgescu
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.
42 1 Adrian Georgescu
The main reasons for this are the following:
43 1 Adrian Georgescu
 * 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.
44 1 Adrian Georgescu
 * 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.
45 1 Adrian Georgescu
 * 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.
46 1 Adrian Georgescu
47 1 Adrian Georgescu
PJSIP itself is by nature asynchronous.
48 1 Adrian Georgescu
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.
49 1 Adrian Georgescu
Whenever the application performs some action through a function, this function will return immediately.
50 1 Adrian Georgescu
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.
51 1 Adrian Georgescu
52 1 Adrian Georgescu
> NOTE: Currently the core starts the media handling as a separate C thread to avoid lag caused by the GIL.
53 71 Adrian Georgescu
> The sound-card also has its own C thread.
54 1 Adrian Georgescu
55 1 Adrian Georgescu
== Architecture ==
56 1 Adrian Georgescu
57 1 Adrian Georgescu
The {{{sipsimple}}} core wrapper itself is mostly written using [http://cython.org/ Cython] (formerly [http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/ Pyrex]).
58 1 Adrian Georgescu
It allows a Python-like file with some added C manipulation statements to be compiled to C.
59 1 Adrian Georgescu
This in turn compiles to a Python C extension module, which links with the PJSIP static libraries.
60 1 Adrian Georgescu
61 90 Luci Stanescu
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:
62 90 Luci Stanescu
 * 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.
63 90 Luci Stanescu
 * Utility classes used throughout the core:
64 90 Luci Stanescu
   * {{{frozenlist}}} and {{{frozendict}}}: classes which relate respectively to {{{list}}} and {{{dict}}} similarly to how the standard {{{frozenset}}} relates to {{{set}}}.
65 90 Luci Stanescu
 * Helper classes which represent a structured collection of data which is used throughout the core:
66 90 Luci Stanescu
   * {{{BaseSIPURI}}}, {{{SIPURI}}} and {{{FrozenSIPURI}}}
67 90 Luci Stanescu
   * {{{BaseCredentials}}}, {{{Credentials}}} and {{{FrozenCredentials}}}
68 90 Luci Stanescu
 * SDP manipulation classes, which directly wrap the PJSIP structures representing either the parsed or to be generated SDP:
69 90 Luci Stanescu
   * {{{BaseSDPSession}}}, {{{SDPSession}}} and {{{FrozenSDPSession}}}
70 90 Luci Stanescu
   * {{{BaseSDPMediaStream}}}, {{{SDPMediaStream}}} and {{{FrozenSDPMediaStream}}}
71 90 Luci Stanescu
   * {{{BaseSDPConnection}}}, {{{SDPConnection}}} and {{{FrozenSDPConnection}}}
72 90 Luci Stanescu
   * {{{SDPAttributeList}}} and {{{FrozenSDPAttributeList}}}
73 90 Luci Stanescu
   * {{{BaseSDPAttribute}}}, {{{SDPAttribute}}} and {{{FrozenSDPAttribute}}}
74 90 Luci Stanescu
 * Audio handling classes:
75 90 Luci Stanescu
   * {{{AudioMixer}}}
76 90 Luci Stanescu
   * {{{MixerPort}}}
77 90 Luci Stanescu
   * {{{WaveFile}}}
78 90 Luci Stanescu
   * {{{RecordingWaveFile}}}
79 90 Luci Stanescu
   * {{{ToneGenerator}}}
80 90 Luci Stanescu
 * Media transport handling classes, using the functionality built into PJMEDIA:
81 90 Luci Stanescu
   * {{{RTPTransport}}}
82 90 Luci Stanescu
   * {{{AudioTransport}}}
83 90 Luci Stanescu
 * SIP signalling related classes:
84 90 Luci Stanescu
   * {{{Request}}} and {{{IncomingRequest}}}: low-level transaction support
85 90 Luci Stanescu
   * {{{Invitation}}}: INVITE-dialog support
86 90 Luci Stanescu
   * {{{Subscription}}} and {{{IncomingSubscription}}}: SUBSCRIBE-dialog support (including NOTIFY handling within the SUBSCRIBE dialog)
87 90 Luci Stanescu
   * {{{Registration}}}: Python object based on {{{Request}}} for REGISTER support
88 90 Luci Stanescu
   * {{{Message}}}: Python object based on {{{Request}}} for MESSAGE support
89 90 Luci Stanescu
   * {{{Publication}}}: Python object based on {{{Request}}} for PUBLISH support
90 90 Luci Stanescu
 * Exceptions:
91 90 Luci Stanescu
   * {{{SIPCoreError}}}: generic error used throught the core
92 90 Luci Stanescu
   * {{{PJSIPError}}}: subclass of {{{SIPCoreError}}} which offers more information related to errors from PJSIP
93 90 Luci Stanescu
   * {{{PJSIPTLSError}}}: subclass of {{{PJSIPError}}} to distinguish between TLS-related errors and the rest
94 90 Luci Stanescu
   * {{{SIPCoreInvalidStateError}}}: subclass of {{{SIPCoreError}}} used by objects which are based on a state-machine
95 1 Adrian Georgescu
96 90 Luci Stanescu
Most of the objects cannot be used until the {{{Engine}}} has been started. The following diagram illustrates these classes:
97 1 Adrian Georgescu
98 1 Adrian Georgescu
[[Image(sipsimple-core-classes.png, nolink)]]
99 90 Luci Stanescu
100 90 Luci Stanescu
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.
101 67 Ruud Klaver
102 11 Adrian Georgescu
== Integration ==
103 1 Adrian Georgescu
104 1 Adrian Georgescu
The core itself has one Python dependency, the [http://pypi.python.org/pypi/python-application application] module, which in turn depends on the [http://pypi.python.org/pypi/zope.interface zope.interface] module.
105 1 Adrian Georgescu
These modules should be present on the system before the core can be used.
106 1 Adrian Georgescu
An application that uses the SIP core must use the notification system provided by the {{{application}}} module in order to receive notifications from it.
107 1 Adrian Georgescu
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.
108 1 Adrian Georgescu
This means that any call to instance an object from this class will result in the same object.
109 1 Adrian Georgescu
As an example, this bit of code will create an observer for logging messages only:
110 1 Adrian Georgescu
111 1 Adrian Georgescu
{{{
112 1 Adrian Georgescu
from zope.interface import implements
113 1 Adrian Georgescu
from application.notification import NotificationCenter, IObserver
114 1 Adrian Georgescu
115 29 Luci Stanescu
class SIPEngineLogObserver(object):
116 1 Adrian Georgescu
    implements(IObserver)
117 1 Adrian Georgescu
118 1 Adrian Georgescu
    def handle_notification(self, notification):
119 1 Adrian Georgescu
        print "%(timestamp)s (%(level)d) %(sender)14s: %(message)s" % notification.data.__dict__
120 1 Adrian Georgescu
121 102 Luci Stanescu
log_observer = SIPEngineLogObserver()
122 1 Adrian Georgescu
notification_center = NotificationCenter()
123 102 Luci Stanescu
notification_center.add_observer(log_observer, name="SIPEngineLog")
124 1 Adrian Georgescu
}}}
125 1 Adrian Georgescu
126 1 Adrian Georgescu
Each notification object has three attributes:
127 99 Adrian Georgescu
128 1 Adrian Georgescu
 '''sender'''::
129 1 Adrian Georgescu
  The object that sent the notification.
130 1 Adrian Georgescu
  For generic notifications the sender will be the {{{Engine}}} instance, otherwise the relevant object.
131 99 Adrian Georgescu
132 1 Adrian Georgescu
 '''name'''::
133 1 Adrian Georgescu
  The name describing the notification.
134 91 Luci Stanescu
  Most of the notifications in the core have the prefix "SIP".
135 99 Adrian Georgescu
136 1 Adrian Georgescu
 '''data'''::
137 1 Adrian Georgescu
  An instance of {{{application.notification.NotificationData}}} or a subclass of it.
138 1 Adrian Georgescu
  The attributes of this object provide additional data about the notification.
139 1 Adrian Georgescu
  Notifications described in this document will also have the data attributes described.
140 1 Adrian Georgescu
141 91 Luci Stanescu
Besides setting up the notification observers, the application should import the relevant objects from the {{{sipsimple.core}}} module.
142 91 Luci Stanescu
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.
143 1 Adrian Georgescu
Most of these options can later be changed at runtime, by setting attributes of the same name on the {{{Engine}}} object.
144 91 Luci Stanescu
The application may then instantiate one of the SIP primitive classes and perform operations on it.
145 1 Adrian Georgescu
146 1 Adrian Georgescu
When starting the {{{Engine}}} class, the application can pass a number of keyword arguments that influence the behaviour of the SIP endpoint.
147 1 Adrian Georgescu
For example, the SIP network ports may be set through the {{{local_udp_port}}}, {{{local_tcp_port}}} and {{{local_tls_port}}} arguments.
148 1 Adrian Georgescu
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.
149 1 Adrian Georgescu
150 1 Adrian Georgescu
The methods called on the SIP primitive objects and the {{{Engine}}} object (proxied to the {{{PJSIPUA}}} instance) may be called from any thread.
151 31 Ruud Klaver
They will return immediately and any delayed result, such as results depending on network traffic, will be returned later using a notification.
152 31 Ruud Klaver
In this manner the SIP core continues the asynchronous pattern of PJSIP.
153 1 Adrian Georgescu
If there is an error in processing the request, an instance of {{{SIPCoreError}}}, or its subclass {{{PJSIPError}}} will be raised.
154 1 Adrian Georgescu
The former will be raised whenever an error occurs inside the core, the latter whenever an underlying PJSIP function returns an error.
155 1 Adrian Georgescu
The {{{PJSIPError}}} object also contains a status attribute, which is the PJSIP errno as an integer.
156 43 Ruud Klaver
157 1 Adrian Georgescu
As a very basic example, one can {{{REGISTER}}} for a sip account by typing the following lines on a Python console:
158 43 Ruud Klaver
{{{
159 91 Luci Stanescu
from sipsimple.core import ContactHeader, Credentials, Engine, Registration, RouteHeader, SIPURI
160 1 Adrian Georgescu
e = Engine()
161 1 Adrian Georgescu
e.start()
162 91 Luci Stanescu
identity = FromHeader(SIPURI(user="alice", host="example.com"), display_name="Alice")
163 43 Ruud Klaver
cred = Credentials("alice", "mypassword")
164 91 Luci Stanescu
reg = Registration(identity, credentials=cred)
165 91 Luci Stanescu
reg.register(ContactHeader(SIPURI("127.0.0.1",port=12345)), RouteHeader(SIPURI("1.2.3.4", port=5060)))
166 1 Adrian Georgescu
}}}
167 1 Adrian Georgescu
Note that in this example no observer for notifications from this {{{Registration}}} object are registered, so the result of the operation cannot be seen.
168 43 Ruud Klaver
Also note that this will not keep the registration registered when it is about to expire, as it is the application's responsibility.
169 43 Ruud Klaver
See the {{{Registration}}} documentation for more details.
170 43 Ruud Klaver
171 43 Ruud Klaver
Another convention that is worth mentioning at this point is that the SIP core will never perform DNS lookups.
172 91 Luci Stanescu
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 [wiki:SipMiddlewareApi#Lookup {{{sipsimple.lookup}}}] module of the middleware can be used to perform DNS lookups according to RFC3263.
173 32 Ruud Klaver
174 1 Adrian Georgescu
== Components ==
175 1 Adrian Georgescu
176 1 Adrian Georgescu
=== Engine ===
177 1 Adrian Georgescu
178 1 Adrian Georgescu
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.
179 1 Adrian Georgescu
Once the {{{start()}}} method is called, it instantiates the {{{core.PJSIPUA}}} object and will proxy attribute and methods from it to the application.
180 1 Adrian Georgescu
181 1 Adrian Georgescu
==== attributes ====
182 1 Adrian Georgescu
183 99 Adrian Georgescu
184 1 Adrian Georgescu
 '''default_start_options''' (class attribute)::
185 1 Adrian Georgescu
  This dictionary is a class attribute that describes the default values for the initialization options passed as keyword arguments to the {{{start()}}} method.
186 1 Adrian Georgescu
  Consult this method for documentation of the contents.
187 99 Adrian Georgescu
188 32 Ruud Klaver
 '''is_running'''::
189 32 Ruud Klaver
  A boolean property indicating if the {{{Engine}}} is running and if it is safe to try calling any proxied methods or attributes on it.
190 1 Adrian Georgescu
191 1 Adrian Georgescu
==== methods ====
192 1 Adrian Georgescu
193 99 Adrian Georgescu
194 1 Adrian Georgescu
 '''!__init!__'''(''self'')::
195 71 Adrian Georgescu
  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.
196 99 Adrian Georgescu
197 1 Adrian Georgescu
 '''start'''(''self'', '''**kwargs''')::
198 1 Adrian Georgescu
  Initialize all PJSIP libraries based on the keyword parameters provided and start the PJSIP worker thread.
199 1 Adrian Georgescu
  If this fails an appropriate exception is raised.
200 1 Adrian Georgescu
  After the {{{Engine}}} has been started successfully, it can never be started again after being stopped.
201 1 Adrian Georgescu
  The keyword arguments will be discussed here.
202 87 Adrian Georgescu
  Many of these values are also readable as (proxied) attributes on the Engine once the {{{start()}}} method has been called.
203 44 Ruud Klaver
  Many of them can also be set at runtime, either by modifying the attribute or by calling a particular method.
204 1 Adrian Georgescu
  This will also be documented for each argument in the following list of options.
205 87 Adrian Georgescu
  [[BR]]''udp_port'': (Default: {{{0}}})[[BR]]
206 1 Adrian Georgescu
  The local UDP port to listen on for UDP datagrams.
207 1 Adrian Georgescu
  If this is 0, a random port will be chosen.
208 1 Adrian Georgescu
  If it is {{{None}}}, the UDP transport is disabled, both for incoming and outgoing traffic.
209 91 Luci Stanescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_udp_port()}}} method.
210 87 Adrian Georgescu
  [[BR]]''tcp_port'': (Default: {{{0}}})[[BR]]
211 1 Adrian Georgescu
  The local TCP port to listen on for new TCP connections.
212 1 Adrian Georgescu
  If this is 0, a random port will be chosen.
213 1 Adrian Georgescu
  If it is {{{None}}}, the TCP transport is disabled, both for incoming and outgoing traffic.
214 91 Luci Stanescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_tcp_port()}}} method.
215 87 Adrian Georgescu
  [[BR]]''tls_port'': (Default: {{{0}}})[[BR]]
216 1 Adrian Georgescu
  The local TCP port to listen on for new TLS over TCP connections.
217 1 Adrian Georgescu
  If this is 0, a random port will be chosen.
218 28 Adrian Georgescu
  If it is {{{None}}}, the TLS transport is disabled, both for incoming and outgoing traffic.
219 87 Adrian Georgescu
  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.
220 1 Adrian Georgescu
  [[BR]]''tls_protocol'': (Default: "TLSv1")[[BR]] 
221 35 Ruud Klaver
  This string describes the (minimum) TLS protocol that should be used. 
222 32 Ruud Klaver
  Its values should be either {{{None}}}, "SSLv2", "SSLv23", "SSLv3" or "TLSv1". 
223 32 Ruud Klaver
  If {{{None}}} is specified, the PJSIP default will be used, which is currently "TLSv1". 
224 1 Adrian Georgescu
  [[BR]]''tls_verify_server'': (Default: {{{False}}})[[BR]]
225 32 Ruud Klaver
  This boolean indicates whether PJSIP should verify the certificate of the server against the local CA list when making an outgoing TLS connection.
226 1 Adrian Georgescu
  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.
227 28 Adrian Georgescu
  [[BR]]''tls_ca_file'': (Default: {{{None}}})[[BR]]
228 32 Ruud Klaver
  This string indicates the location of the file containing the local list of CA certificates, to be used for TLS connections.
229 1 Adrian Georgescu
  If this is set to {{{None}}}, no CA certificates will be read. 
230 1 Adrian Georgescu
  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. 
231 32 Ruud Klaver
  [[BR]]''tls_cert_file'': (Default: {{{None}}})[[BR]] 
232 32 Ruud Klaver
  This string indicates the location of a file containing the TLS certificate to be used for TLS connections. 
233 32 Ruud Klaver
  If this is set to {{{None}}}, no certificate file will be read. 
234 32 Ruud Klaver
  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. 
235 32 Ruud Klaver
  [[BR]]''tls_privkey_file'': (Default: {{{None}}})[[BR]] 
236 32 Ruud Klaver
  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. 
237 32 Ruud Klaver
  If this is set to {{{None}}}, no private key file will be read. 
238 32 Ruud Klaver
  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. 
239 32 Ruud Klaver
  [[BR]]''tls_timeout'': (Default: 1000)[[BR]] 
240 1 Adrian Georgescu
  The timeout value for a TLS negotiation in milliseconds. 
241 32 Ruud Klaver
  Note that this value should be reasonably small, as a TLS negotiation blocks the whole PJSIP polling thread. 
242 32 Ruud Klaver
  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.
243 91 Luci Stanescu
  [[BR]]''user_agent'': (Default: {{{"sipsimple-%version-pjsip-%pjsip_version-r%pjsip_svn_revision"}}})[[BR]]
244 32 Ruud Klaver
  This value indicates what should be set in the {{{User-Agent}}} header, which is included in each request or response sent.
245 71 Adrian Georgescu
  It can be read and set directly as an attribute at runtime.
246 1 Adrian Georgescu
  [[BR]]''log_level'': (Default: 5)[[BR]]
247 1 Adrian Georgescu
  This integer dictates the maximum log level that may be reported to the application by PJSIP through the {{{SIPEngineLog}}} notification.
248 1 Adrian Georgescu
  By default the maximum amount of logging information is reported.
249 29 Luci Stanescu
  This value can be read and set directly as an attribute at runtime.
250 1 Adrian Georgescu
  [[BR]]''trace_sip'': (Default: {{{False}}})[[BR]]
251 1 Adrian Georgescu
  This boolean indicates if the SIP core should send the application SIP messages as seen on the wire through the {{{SIPEngineSIPTrace}}} notification.
252 1 Adrian Georgescu
  It can be read and set directly as an attribute at runtime.
253 1 Adrian Georgescu
  [[BR]]''rtp_port_range'': (Default: (40000, 40100))[[BR]]
254 1 Adrian Georgescu
  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.
255 1 Adrian Georgescu
  It can be read and set directly as an attribute at runtime, but the ports of previously created {{{RTPTransport}}} objects remain unaffected.
256 1 Adrian Georgescu
  [[BR]]''codecs'': (Default: {{{["speex", "G722", "PCMU", "PCMA", "iLBC", "GSM"]}}})[[BR]]
257 71 Adrian Georgescu
  This list specifies the codecs to use for audio sessions and their preferred order.
258 1 Adrian Georgescu
  It can be read and set directly as an attribute at runtime.
259 1 Adrian Georgescu
  Note that this global option can be overridden by an argument passed to {{{AudioTransport.__init__()}}}.
260 40 Ruud Klaver
  The strings in this list is case insensitive.
261 1 Adrian Georgescu
  [[BR]]''events'': (Default: <some sensible events>)[[BR]]
262 1 Adrian Georgescu
  PJSIP needs a mapping between SIP SIMPLE event packages and content types.
263 1 Adrian Georgescu
  This dictionary provides some default packages and their event types.
264 91 Luci Stanescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{add_event()}}} method.
265 1 Adrian Georgescu
  [[BR]]''incoming_events'': (Default: {{{set()}}})[[BR]]
266 1 Adrian Georgescu
  A list that specifies for which SIP SIMPLE event packages the application wishes to receive {{{IncomingSubscribe}}} objects.
267 82 Ruud Klaver
  When a {{{SUBSCRIBE}}} request is received containing an event name that is not in this list, a 489 "Bad event" response is internally generated.
268 1 Adrian Georgescu
  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.
269 82 Ruud Klaver
  Note that each of the events specified here should also be a key in the {{{events}}} dictionary argument.
270 82 Ruud Klaver
  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.
271 82 Ruud Klaver
  [[BR]]''incoming_requests'': (Default: {{{set()}}})[[BR]]
272 82 Ruud Klaver
  A set of methods for which {{{IncomingRequest}}} objects are created and sent to the application if they are received.
273 85 Ruud Klaver
  Note that receiving requests using the {{{INVITE}}}, {{{SUBSCRIBE}}}, {{{ACK}}} or {{{BYE}}} methods in this way is not allowed.
274 74 Ruud Klaver
  Requests using the {{{OPTIONS}}} or {{{MESSAGE}}} method are handled internally, but may be overridden.
275 99 Adrian Georgescu
276 40 Ruud Klaver
 '''stop'''(''self'')::
277 1 Adrian Georgescu
  Stop the PJSIP worker thread and unload all PJSIP libraries.
278 36 Adrian Georgescu
  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}}}.
279 32 Ruud Klaver
  Also note that, once stopped the {{{Engine}}} cannot be started again.
280 32 Ruud Klaver
  This method is automatically called when the Python interpreter exits.
281 35 Ruud Klaver
282 1 Adrian Georgescu
==== proxied attributes ====
283 39 Ruud Klaver
284 91 Luci Stanescu
Besides all the proxied attributes described for the {{{__init__}}} method above, thse other attributes are provided once the {{{Engine}}} has been started.
285 1 Adrian Georgescu
286 99 Adrian Georgescu
287 20 Ruud Klaver
 '''input_devices'''::
288 1 Adrian Georgescu
  This read-only attribute is a list of strings, representing all audio input devices on the system that can be used.
289 91 Luci Stanescu
  One of these device names can be passed as the {{{input_device}}} argument when creating a {{{AudioMixer}}} object.
290 99 Adrian Georgescu
291 74 Ruud Klaver
 '''output_devices'''::
292 91 Luci Stanescu
  This read-only attribute is a list of strings, representing all audio output devices on the system that can be used.
293 91 Luci Stanescu
  One of these device names can be passed as the {{{output_device}}} argument when creating a {{{AudioMixer}}} object.
294 99 Adrian Georgescu
295 91 Luci Stanescu
 '''sound_devices'''::
296 91 Luci Stanescu
  This read-only attribute is a list of strings, representing all audio sound devices on the system that can be used.
297 99 Adrian Georgescu
298 1 Adrian Georgescu
 '''available_codecs'''::
299 1 Adrian Georgescu
  A read-only list of codecs available in the core, regardless of the codecs configured through the {{{codecs}}} attribute.
300 1 Adrian Georgescu
301 29 Luci Stanescu
==== proxied methods ====
302 1 Adrian Georgescu
303 99 Adrian Georgescu
304 1 Adrian Georgescu
 '''add_event'''(''self'', '''event''', '''accept_types''')::
305 82 Ruud Klaver
  Couple a certain event package to a list of content types.
306 82 Ruud Klaver
  Once added it cannot be removed or modified.
307 99 Adrian Georgescu
308 82 Ruud Klaver
 '''add_incoming_event'''(''self'', '''event''')::
309 82 Ruud Klaver
  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.
310 82 Ruud Klaver
  Note that this event should be known to the {{{Engine}}} by means of the {{{events}}} attribute.
311 99 Adrian Georgescu
312 85 Ruud Klaver
 '''remove_incoming_event'''(''self'', '''event''')::
313 85 Ruud Klaver
  Removes an event from the {{{incoming_events}}} attribute.
314 85 Ruud Klaver
  Incoming {{{SUBSCRIBE}}} requests with this event package will automatically be replied to with a 489 "Bad Event" response.
315 99 Adrian Georgescu
316 85 Ruud Klaver
 '''add_incoming_request'''(''self'', '''method''')::
317 1 Adrian Georgescu
  Add a method to the set of methods for which incoming requests should be turned into {{{IncomingRequest}}} objects.
318 1 Adrian Georgescu
  For the rules on which methods are allowed, see the description of the Engine attribute above.
319 99 Adrian Georgescu
320 38 Ruud Klaver
 '''remove_incoming_request'''(''self'', '''method''')::
321 1 Adrian Georgescu
  Removes a method from the set of methods that should be received.
322 99 Adrian Georgescu
323 1 Adrian Georgescu
 '''detect_nat_type'''(''self'', '''stun_server_address''', '''stun_server_port'''=3478, '''user_data'''=None)::
324 38 Ruud Klaver
  Will start a series of STUN requests which detect the type of NAT this host is behind.
325 87 Adrian Georgescu
  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.
326 1 Adrian Georgescu
  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.
327 99 Adrian Georgescu
328 87 Adrian Georgescu
 '''set_udp_port'''(''self'', '''value''')::
329 1 Adrian Georgescu
  Update the {{{local_udp_port}}} attribute to the newly specified value.
330 99 Adrian Georgescu
331 44 Ruud Klaver
 '''set_tcp_port'''(''self'', '''value''')::
332 44 Ruud Klaver
  Update the {{{local_tcp_port}}} attribute to the newly specified value.
333 99 Adrian Georgescu
334 44 Ruud Klaver
 '''set_tls_options'''(''self'', '''local_port'''={{{None}}}, '''protocol'''="TLSv1", '''verify_server'''={{{False}}}, '''ca_file'''={{{None}}}, '''cert_file'''={{{None}}}, '''privkey_file'''={{{None}}}, '''timeout'''=1000):: 
335 83 Ruud Klaver
  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}}}. 
336 44 Ruud Klaver
  The semantics of the arguments are the same as on the {{{start()}}} method. 
337 1 Adrian Georgescu
338 1 Adrian Georgescu
==== notifications ====
339 1 Adrian Georgescu
340 1 Adrian Georgescu
Notifications sent by the {{{Engine}}} are notifications that are related to the {{{Engine}}} itself or unrelated to any SIP primitive object.
341 1 Adrian Georgescu
They are described here including the data attributes that is included with them.
342 16 Ruud Klaver
343 99 Adrian Georgescu
344 1 Adrian Georgescu
 '''SIPEngineWillStart'''::
345 1 Adrian Georgescu
  This notification is sent when the {{{Engine}}} is about to start.
346 29 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
347 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
348 99 Adrian Georgescu
349 16 Ruud Klaver
 '''SIPEngineDidStart'''::
350 16 Ruud Klaver
  This notification is sent when the {{{Engine}}} is has just been started.
351 29 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
352 16 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
353 99 Adrian Georgescu
354 16 Ruud Klaver
 '''SIPEngineDidFail'''::
355 16 Ruud Klaver
  This notification is sent whenever the {{{Engine}}} has failed fatally and either cannot start or is about to stop.
356 29 Luci Stanescu
  It is not recommended to call any methods on the {{{Engine}}} at this point.
357 16 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
358 16 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
359 99 Adrian Georgescu
360 16 Ruud Klaver
 '''SIPEngineWillEnd'''::
361 16 Ruud Klaver
  This notification is sent when the {{{Engine}}} is about to stop because the application called the {{{stop()}}} method.
362 1 Adrian Georgescu
  Methods on the {{{Engine}}} can be called at this point, but anything that has a delayed result will probably not return any notification.
363 16 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
364 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
365 99 Adrian Georgescu
366 16 Ruud Klaver
 '''SIPEngineDidEnd'''::
367 16 Ruud Klaver
  This notification is sent when the {{{Engine}}} was running and is now stopped, either because of failure or because the application requested it.
368 29 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
369 16 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
370 99 Adrian Georgescu
371 16 Ruud Klaver
 '''SIPEngineLog'''::
372 16 Ruud Klaver
  This notification is a wrapper for PJSIP logging messages.
373 1 Adrian Georgescu
  It can be used by the application to output PJSIP logging to somewhere meaningful, possibly doing filtering based on log level.
374 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
375 1 Adrian Georgescu
  A {{{datetime.datetime}}} object representing the time when the log message was output by PJSIP.
376 1 Adrian Georgescu
  [[BR]]''sender'':[[BR]]
377 1 Adrian Georgescu
  The PJSIP module that originated this log message.
378 1 Adrian Georgescu
  [[BR]]''level'':[[BR]]
379 1 Adrian Georgescu
  The logging level of the message as an integer.
380 1 Adrian Georgescu
  Currently this is 1 through 5, 1 being the most critical.
381 1 Adrian Georgescu
  [[BR]]''message'':[[BR]]
382 1 Adrian Georgescu
  The actual log message.
383 99 Adrian Georgescu
384 1 Adrian Georgescu
 '''SIPEngineSIPTrace'''::
385 1 Adrian Georgescu
  Will be sent only when the {{{do_siptrace}}} attribute of the {{{Engine}}} instance is set to {{{True}}}.
386 1 Adrian Georgescu
  The notification data attributes will contain the SIP messages as they are sent and received on the wire.
387 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
388 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
389 1 Adrian Georgescu
  [[BR]]''received'':[[BR]]
390 1 Adrian Georgescu
  A boolean indicating if this message was sent from or received by PJSIP (i.e. the direction of the message).
391 1 Adrian Georgescu
  [[BR]]''source_ip'':[[BR]]
392 1 Adrian Georgescu
  The source IP address as a string.
393 1 Adrian Georgescu
  [[BR]]''source_port'':[[BR]]
394 1 Adrian Georgescu
  The source port of the message as an integer.
395 1 Adrian Georgescu
  [[BR]]''destination_ip'':[[BR]]
396 1 Adrian Georgescu
  The destination IP address as a string.
397 1 Adrian Georgescu
  [[BR]]''source_port'':[[BR]]
398 1 Adrian Georgescu
  The source port of the message as an integer.
399 1 Adrian Georgescu
  [[BR]]''data'':[[BR]]
400 1 Adrian Georgescu
  The contents of the message as a string.
401 1 Adrian Georgescu
402 1 Adrian Georgescu
> For received message the destination_ip and for sent messages the source_ip may not be reliable.
403 1 Adrian Georgescu
404 99 Adrian Georgescu
405 1 Adrian Georgescu
 '''SIPEngineDetectedNATType'''::
406 1 Adrian Georgescu
  This notification is sent some time after the application request the NAT type this host behind to be detected using a STUN server.
407 1 Adrian Georgescu
  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.
408 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
409 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
410 1 Adrian Georgescu
  [[BR]]''succeeded'':[[BR]]
411 1 Adrian Georgescu
  A boolean indicating if the NAT detection succeeded.
412 1 Adrian Georgescu
  [[BR]]''user_data'':[[BR]]
413 1 Adrian Georgescu
  The {{{user_data}}} argument passed while calling the {{{detect_nat_type()}}} method.
414 1 Adrian Georgescu
  This can be any object and could be used for matching requests to responses.
415 1 Adrian Georgescu
  [[BR]]''nat_type'':[[BR]]
416 1 Adrian Georgescu
  A string describing the type of NAT found.
417 1 Adrian Georgescu
  This value is only present if NAT detection succeeded.
418 1 Adrian Georgescu
  [[BR]]''error'':[[BR]]
419 1 Adrian Georgescu
  A string indicating the error that occurred while attempting to detect the type of NAT.
420 1 Adrian Georgescu
  This value only present if NAT detection did not succeed.
421 99 Adrian Georgescu
422 1 Adrian Georgescu
 '''SIPEngineGotException'''::
423 1 Adrian Georgescu
  This notification is sent whenever there is an unexpected exception within the PJSIP working thread.
424 1 Adrian Georgescu
  The application should show the traceback to the user somehow.
425 1 Adrian Georgescu
  An exception need not be fatal, but if it is it will be followed by a '''SIPEngineDidFail''' notification.
426 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
427 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
428 1 Adrian Georgescu
  [[BR]]''traceback'':[[BR]]
429 1 Adrian Georgescu
  A string containing the traceback of the exception.
430 1 Adrian Georgescu
  In general this should be printed on the console.
431 1 Adrian Georgescu
432 108 Adrian Georgescu
 '''SIPEngineGotMessage'''::
433 108 Adrian Georgescu
  This notification is sent whenever the Engine receives a {{{MESSAGE}}} request.
434 108 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
435 108 Adrian Georgescu
  The request URI of the {{{MESSAGE}}} request as a {{{SIPURI}}} object.
436 108 Adrian Georgescu
  [[BR]]''from_header'':[[BR]]
437 108 Adrian Georgescu
  The From header of the {{{MESSAGE}}} request as a {{{FrozenFromHeader}}} object.
438 108 Adrian Georgescu
  [[BR]]''to_header'':[[BR]]
439 108 Adrian Georgescu
  The To header of the {{{MESSAGE}}} request as a {{{FrozenToHeader}}} object.
440 108 Adrian Georgescu
  [[BR]]''content_type'':[[BR]]
441 108 Adrian Georgescu
  The Content-Type header value of the {{{MESSAGE}}} request as a {{{ContentType}}} object.
442 108 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
443 108 Adrian Georgescu
  The headers of the {{{MESSAGE}}} request as a dict.
444 108 Adrian Georgescu
  Each SIP header is represented in its parsed for as long as PJSIP supports it.
445 108 Adrian Georgescu
  The format of the parsed value depends on the header.
446 108 Adrian Georgescu
  [[BR]]''body'':[[BR]]
447 108 Adrian Georgescu
  The body of the {{{MESSAGE}}} request as a string, or {{{None}}} if no body was included.
448 108 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
449 108 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
450 108 Adrian Georgescu
451 98 Adrian Georgescu
=== SIPURI ===
452 1 Adrian Georgescu
453 91 Luci Stanescu
These are helper objects for representing a SIP URI.
454 91 Luci Stanescu
This object needs to be used whenever a SIP URI should be specified to the SIP core.
455 91 Luci Stanescu
It supports comparison to other {{{SIPURI}}} objects using the == and != expressions.
456 91 Luci Stanescu
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.
457 91 Luci Stanescu
458 91 Luci Stanescu
==== methods ====
459 91 Luci Stanescu
460 99 Adrian Georgescu
461 91 Luci Stanescu
 '''!__init!__'''(''self'', '''host''', '''user'''={{{None}}}, '''port'''={{{None}}}, '''display'''={{{None}}}, '''secure'''={{{False}}}, '''parameters'''={{{None}}}, '''headers'''={{{None}}})::
462 91 Luci Stanescu
  Creates the SIPURI object with the specified parameters as attributes.
463 91 Luci Stanescu
  {{{host}}} is the only mandatory attribute.
464 91 Luci Stanescu
  [[BR]]''host'':[[BR]]
465 91 Luci Stanescu
  The host part of the SIP URI as a string.
466 91 Luci Stanescu
  [[BR]]''user'':[[BR]]
467 91 Luci Stanescu
  The username part of the SIP URI as a string, or None if not set.
468 91 Luci Stanescu
  [[BR]]''port'':[[BR]]
469 91 Luci Stanescu
  The port part of the SIP URI as an int, or None or 0 if not set.
470 91 Luci Stanescu
  [[BR]]''display'':[[BR]]
471 91 Luci Stanescu
  The optional display name of the SIP URI as a string, or None if not set.
472 91 Luci Stanescu
  [[BR]]''secure'':[[BR]]
473 91 Luci Stanescu
  A boolean indicating whether this is a SIP or SIPS URI, the latter being indicated by a value of {{{True}}}.
474 91 Luci Stanescu
  [[BR]]''parameters'':[[BR]]
475 91 Luci Stanescu
  The URI parameters. represented by a dictionary.
476 91 Luci Stanescu
  [[BR]]''headers'':[[BR]]
477 91 Luci Stanescu
  The URI headers, represented by a dictionary.
478 99 Adrian Georgescu
479 91 Luci Stanescu
 '''!__str!__'''(''self'')::
480 91 Luci Stanescu
  The special Python method to represent this object as a string, the output is the properly formatted SIP URI.
481 99 Adrian Georgescu
482 91 Luci Stanescu
 '''new'''(''cls'', ''sipuri'')::
483 91 Luci Stanescu
  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).
484 99 Adrian Georgescu
485 91 Luci Stanescu
 '''parse'''(''cls'', ''uri_str'')::
486 91 Luci Stanescu
  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.
487 91 Luci Stanescu
488 104 Luci Stanescu
 '''matches'''(''self'', ''address'')::
489 104 Luci Stanescu
  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}}}.
490 104 Luci Stanescu
491 96 Luci Stanescu
=== Credentials ===
492 91 Luci Stanescu
493 96 Luci Stanescu
The {{{Credentials}}} and {{{FrozenCredentails}}} simple objects represent authentication credentials for a particular SIP account.
494 91 Luci Stanescu
These can be included whenever creating a SIP primitive object that originates SIP requests.
495 96 Luci Stanescu
The attributes of this object are the same as the arguments to the {{{__init__}}} method.
496 91 Luci Stanescu
Note that the domain name of the SIP account is not stored on this object.
497 91 Luci Stanescu
498 91 Luci Stanescu
==== methods ====
499 91 Luci Stanescu
500 99 Adrian Georgescu
501 91 Luci Stanescu
 '''!__init!__'''(''self'', '''username''', '''password''')::
502 91 Luci Stanescu
  Creates the Credentials object with the specified parameters as attributes.
503 91 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
504 91 Luci Stanescu
  [[BR]]''username'':[[BR]]
505 91 Luci Stanescu
  A string representing the username of the account for which these are the credentials.
506 91 Luci Stanescu
  [[BR]]''password'':[[BR]]
507 91 Luci Stanescu
  The password for this SIP account as a string.
508 99 Adrian Georgescu
509 91 Luci Stanescu
 '''new'''(''cls'', ''credentials'')::
510 91 Luci Stanescu
  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).
511 91 Luci Stanescu
512 103 Adrian Georgescu
=== Invitation ===
513 103 Adrian Georgescu
514 103 Adrian Georgescu
The {{{Invitation}}} class represents an {{{INVITE}}} session, which governs a complete session of media exchange between two SIP endpoints from start to finish.
515 103 Adrian Georgescu
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.
516 103 Adrian Georgescu
The {{{Invitation}}} class represents both incoming and outgoing sessions.
517 103 Adrian Georgescu
518 103 Adrian Georgescu
The state machine contained in each {{{Invitation}}} object is based on the one used by the underlying PJSIP [http://www.pjsip.org/pjsip/docs/html/group__PJSIP__INV.htm pjsip_inv_session] object.
519 103 Adrian Georgescu
In order to represent re-{{{INVITE}}}s and user-requested disconnections, three more states have been added to this state machine.
520 103 Adrian Georgescu
The progression through this state machine is fairly linear and is dependent on whether this is an incoming or an outgoing session.
521 103 Adrian Georgescu
State changes are triggered either by incoming or by outgoing SIP requests and responses.
522 103 Adrian Georgescu
The states and the transitions between them are shown in the following diagram:
523 103 Adrian Georgescu
524 103 Adrian Georgescu
[[Image(sipsimple-core-invite-state-machine.png, nolink)]]
525 103 Adrian Georgescu
526 103 Adrian Georgescu
The state changes of this machine are triggered by the following:
527 103 Adrian Georgescu
 1. An {{{Invitation}}} object is newly created, either by the application for an outgoing session, or by the core for an incoming session.
528 103 Adrian Georgescu
 2. The application requested an outgoing session by calling the {{{send_invite()}}} method and and initial {{{INVITE}}} request is sent.
529 103 Adrian Georgescu
 3. A new incoming session is received by the core.
530 103 Adrian Georgescu
    The application should look out for state change to this state in order to be notified of new incoming sessions.
531 103 Adrian Georgescu
 4. A provisional response (1xx) is received from the remove party.
532 103 Adrian Georgescu
 5. A provisional response (1xx) is sent to the remote party, after the application called the {{{respond_to_invite_provisionally()}}} method.
533 103 Adrian Georgescu
 6. A positive final response (2xx) is received from the remote party.
534 103 Adrian Georgescu
 7. A positive final response (2xx) is sent to the remote party, after the application called the {{{accept_invite()}}} method.
535 103 Adrian Georgescu
 8. A positive final response (2xx) is sent or received, depending on the orientation of the session.
536 103 Adrian Georgescu
 9. An {{{ACK}}} is sent or received, depending on the orientation of the session.
537 103 Adrian Georgescu
    If the {{{ACK}}} is sent from the local to the remote party, it is initiated by PJSIP, not by a call from the application.
538 103 Adrian Georgescu
 10. The local party sent a re-{{{INVITE}}} to the remote party by calling the {{{send_reinvite()}}} method.
539 103 Adrian Georgescu
 11. The remote party has sent a final response to the re-{{{INVITE}}}.
540 103 Adrian Georgescu
 12. The remote party has sent a re-{{{INVITE}}}.
541 103 Adrian Georgescu
 13. The local party has responded to the re-{{{INVITE}}} by calling the {{{respond_to_reinvite()}}} method.
542 103 Adrian Georgescu
 14. The application requests that the session ends by calling the {{{end()}}} method.
543 103 Adrian Georgescu
 15. A response is received from the remote party to whichever message was sent by the local party to end the session.
544 103 Adrian Georgescu
 16. A message is received from the remote party which ends the session.
545 103 Adrian Georgescu
546 103 Adrian Georgescu
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.
547 103 Adrian Georgescu
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.
548 103 Adrian Georgescu
The application should compare the previous and current states and perform the appropriate action.
549 103 Adrian Georgescu
550 103 Adrian Georgescu
An {{{Invitiation}}} object also emits the {{{SIPInvitationGotSDPUpdate}}} notification, which indicates that SDP negotiation between the two parties has been completed.
551 103 Adrian Georgescu
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.
552 103 Adrian Georgescu
In the last case, the {{{Invitation}}} object will automatically include the current local SDP in the response.
553 103 Adrian Georgescu
554 103 Adrian Georgescu
==== attributes ====
555 103 Adrian Georgescu
556 103 Adrian Georgescu
557 103 Adrian Georgescu
 '''state'''::
558 103 Adrian Georgescu
  The state the {{{Invitation}}} state machine is currently in.
559 103 Adrian Georgescu
  See the diagram above for possible states.
560 103 Adrian Georgescu
  This attribute is read-only.
561 103 Adrian Georgescu
562 103 Adrian Georgescu
 '''sub_state'''::
563 103 Adrian Georgescu
  The sub-state the {{{Invitation}}} state machine is currently in.
564 103 Adrian Georgescu
  See the diagram above for possible states.
565 103 Adrian Georgescu
  This attribute is read-only.
566 103 Adrian Georgescu
567 103 Adrian Georgescu
 '''directing'''::
568 103 Adrian Georgescu
  A string with the values {{{"incoming"}}} or {{{"outgoing"}}} depending on the direction of the original INVITE request.
569 103 Adrian Georgescu
570 103 Adrian Georgescu
 '''credentials'''::
571 103 Adrian Georgescu
  The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{FrozenCredentials}}} object.
572 103 Adrian Georgescu
  If this {{{Invitation}}} object represents an incoming {{{INVITE}}} session this attribute will be {{{None}}}.
573 103 Adrian Georgescu
  On an outgoing session this attribute will be {{{None}}} if it was not specified when the object was created.
574 103 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
575 103 Adrian Georgescu
576 103 Adrian Georgescu
 '''from_header'''::
577 103 Adrian Georgescu
  The From header of the caller represented by a {{{FrozenFromHeader}}} object.
578 103 Adrian Georgescu
  If this is an outgoing {{{INVITE}}} session, this is the from_header from the {{{send_invite()}}} method.
579 103 Adrian Georgescu
  Otherwise the URI is taken from the {{{From:}}} header of the initial {{{INVITE}}}.
580 103 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
581 103 Adrian Georgescu
582 103 Adrian Georgescu
 '''to_header'''::
583 103 Adrian Georgescu
  The To header of the callee represented by a {{{FrozenToHeader}}} object.
584 103 Adrian Georgescu
  If this is an outgoing {{{INVITE}}} session, this is the to_header from the {{{send_invite()}}} method.
585 103 Adrian Georgescu
  Otherwise the URI is taken from the {{{To:}}} header of the initial {{{INVITE}}}.
586 103 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
587 103 Adrian Georgescu
588 103 Adrian Georgescu
 '''local_identity'''::
589 103 Adrian Georgescu
  The From or To header representing the local identity used in this session.
590 103 Adrian Georgescu
  If the original {{{INVITE}}} was incoming, this is the same as {{{to_header}}}, otherwise it will be the same as {{{from_header}}}.
591 103 Adrian Georgescu
592 103 Adrian Georgescu
 '''remote_identity'''::
593 103 Adrian Georgescu
  The From or To header representing the remote party in this session.
594 103 Adrian Georgescu
  If the original {{{INVITE}}} was incoming, this is the same as {{{from_header}}}, otherwise it will be the same as {{{to_header}}}.
595 103 Adrian Georgescu
596 103 Adrian Georgescu
 '''route_header'''::
597 103 Adrian Georgescu
  The outbound proxy that was requested to be used in the form of a {{{FrozenRouteHeader}}} object, including the desired transport.
598 103 Adrian Georgescu
  If this {{{Invitation}}} object represents an incoming {{{INVITE}}} session this attribute will always be {{{None}}}.
599 103 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
600 103 Adrian Georgescu
601 103 Adrian Georgescu
 '''call_id'''::
602 103 Adrian Georgescu
  The call ID of the {{{INVITE}}} session as a read-only string.
603 103 Adrian Georgescu
  In the {{{NULL}}} and {{{DISCONNECTED}}} states, this attribute is {{{None}}}.
604 103 Adrian Georgescu
605 103 Adrian Georgescu
 '''transport'''::
606 103 Adrian Georgescu
  A string indicating the transport used for the application.
607 103 Adrian Georgescu
  This can be "udp", "tcp" or "tls".
608 103 Adrian Georgescu
609 103 Adrian Georgescu
 '''local_contact_header'''::
610 103 Adrian Georgescu
  The Contact header that the local side provided to the remote side within this {{{INVITE}}} session as a {{{FrozenContactHeader}}} object.
611 103 Adrian Georgescu
  Note that this can either be set on object creation or updated using the {{{send_reinvite()}}} method.
612 103 Adrian Georgescu
613 111 Adrian Georgescu
 '''remote_contact_header'''::
614 111 Adrian Georgescu
  The Contact header that the remote side provided to us within this {{{INVITE}}} session as a {{{FrozenContactHeader}}} object.
615 111 Adrian Georgescu
616 103 Adrian Georgescu
 '''call_id'''::
617 103 Adrian Georgescu
  A string representing the Call-Id header value of this INVITE dialog.
618 103 Adrian Georgescu
619 103 Adrian Georgescu
 '''remote_user_agent'''::
620 103 Adrian Georgescu
  A string representing the remote user agent taken from the User-Agent or Server headers (depending on the direction of the original INVITE).
621 103 Adrian Georgescu
622 103 Adrian Georgescu
 '''sdp.proposed_local'''::
623 103 Adrian Georgescu
  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.
624 103 Adrian Georgescu
625 103 Adrian Georgescu
 '''sdp.proposed_remote'''::
626 103 Adrian Georgescu
  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.
627 103 Adrian Georgescu
628 103 Adrian Georgescu
 '''sdp.active_local'''::
629 103 Adrian Georgescu
  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.
630 103 Adrian Georgescu
631 103 Adrian Georgescu
 '''sdp.active_remote'''::
632 103 Adrian Georgescu
  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.
633 103 Adrian Georgescu
634 109 Adrian Georgescu
 '''peer_address'''::
635 109 Adrian Georgescu
  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.
636 109 Adrian Georgescu
637 103 Adrian Georgescu
==== methods ====
638 103 Adrian Georgescu
639 103 Adrian Georgescu
640 103 Adrian Georgescu
 '''!__init!__'''(''self'')::
641 103 Adrian Georgescu
  Creates a new {{{Invitation}}} object.
642 103 Adrian Georgescu
643 110 Adrian Georgescu
 '''send_invite'''(''self'', '''request_uri''','''from_header''', '''to_header''', '''route_header''', '''contact_header''', '''sdp''', '''credentials'''={{{None}}}, '''extra_headers'''={{{[]}}}, '''timeout'''=None)::
644 110 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
645 110 Adrian Georgescu
  Request URI to be set inthe outgoing INVITE request.
646 103 Adrian Georgescu
  [[BR]]''from_header'':[[BR]]
647 103 Adrian Georgescu
  The identity of the local account in the form of a {{{FromHeader}}} object.
648 103 Adrian Georgescu
  [[BR]]''to_header'':[[BR]]
649 103 Adrian Georgescu
  The identity we want to send the {{{INVITE}}} to, represented as a {{{ToHeader}}} object.
650 103 Adrian Georgescu
  [[BR]]''route_header'':[[BR]]
651 103 Adrian Georgescu
  The outbound proxy to use in the form of a {{{RouteHeader}}} object.
652 103 Adrian Georgescu
  This includes the desired transport to use.
653 103 Adrian Georgescu
  [[BR]]''contact_header'':[[BR]]
654 103 Adrian Georgescu
  The Contact header to include in the {{{INVITE}}} request, a {{{ContactHeader}}} object.
655 103 Adrian Georgescu
  [[BR]]''sdp'':[[BR]]
656 103 Adrian Georgescu
  The SDP to send as offer to the remote party.
657 103 Adrian Georgescu
  [[BR]]''credentials'':[[BR]]
658 103 Adrian Georgescu
  The optional SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object.
659 103 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
660 103 Adrian Georgescu
  Any extra headers that should be included in the {{{INVITE}}} request in the form of a list of header objects.
661 103 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
662 103 Adrian Georgescu
  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.
663 103 Adrian Georgescu
  If this is set to {{{None}}}, the default PJSIP timeout will be used, which appears to be slightly longer than 30 seconds.
664 103 Adrian Georgescu
665 103 Adrian Georgescu
 '''send_response'''(''self'', '''code''', '''reason''', '''contact_header''', '''sdp''', '''extra_headers''')::
666 103 Adrian Georgescu
  Send a response to a INVITE request. 
667 103 Adrian Georgescu
  [[BR]]''code'':[[BR]]
668 103 Adrian Georgescu
  The code of the response to use as an int.
669 103 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
670 103 Adrian Georgescu
  The reason of the response as a str.
671 103 Adrian Georgescu
  [[BR]]''contact_header'':[[BR]]
672 103 Adrian Georgescu
  The Contact header to include in the response, a {{{ContactHeader}}} object.
673 103 Adrian Georgescu
  [[BR]]''sdp'':[[BR]]
674 103 Adrian Georgescu
  The SDP to send as offer/response to the remote party.
675 103 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
676 103 Adrian Georgescu
  Any extra headers that should be included in the response in the form of a list of header objects.
677 103 Adrian Georgescu
678 103 Adrian Georgescu
 '''send_reinvite'''(''self'', '''contact_header'''={{{None}}}, '''sdp'''={{{None}}}, '''extra_header'''={{{[]}}})::
679 103 Adrian Georgescu
  [[BR]]''contact_header'':[[BR]]
680 103 Adrian Georgescu
  The Contact header if it needs to be changed by the re-INVITE or None if it shouldn't be changed; a {{{BaseContactHeader}}} object.
681 103 Adrian Georgescu
  [[BR]]''sdp'':[[BR]]
682 103 Adrian Georgescu
  The SDP to send as offer to the remote party or None if the re-INVITE should not change the SDP; a {{{BaseSDPSession}}} object.
683 103 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
684 103 Adrian Georgescu
  Any extra headers that should be included in the response in the form of a list of header objects.
685 103 Adrian Georgescu
686 103 Adrian Georgescu
 '''cancel_reinvite'''(''self'')::
687 103 Adrian Georgescu
  Send a CANCEL after a re-INVITE has been sent to cancel the action of the re-INVITE.
688 103 Adrian Georgescu
689 103 Adrian Georgescu
 '''end'''(''self'', '''extra_headers'''={{{[]}}}, '''timeout'''={{{None}}})::
690 103 Adrian Georgescu
  This moves the {{{INVITE}}} state machine into the {{{DISCONNECTING}}} state by sending the necessary SIP request.
691 103 Adrian Georgescu
  When a response from the remote party is received, the state machine will go into the {{{DISCONNECTED}}} state.
692 103 Adrian Georgescu
  Depending on the current state, this could be a CANCEL or a BYE request.
693 103 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
694 103 Adrian Georgescu
  Any extra headers that should be included in the request or response in the form of a dict.
695 103 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
696 103 Adrian Georgescu
  How many seconds to wait for the remote party to reply before changing the state to {{{DISCONNECTED}}}, as an int or a float.
697 103 Adrian Georgescu
  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.
698 103 Adrian Georgescu
699 103 Adrian Georgescu
==== notifications ====
700 103 Adrian Georgescu
701 103 Adrian Georgescu
702 103 Adrian Georgescu
 '''SIPInvitationChangedState'''::
703 103 Adrian Georgescu
  This notification is sent by an {{{Invitation}}} object whenever its state machine changes state.
704 103 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
705 103 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
706 103 Adrian Georgescu
  [[BR]]''prev_state'':[[BR]]
707 103 Adrian Georgescu
  The previous state of the INVITE state machine.
708 103 Adrian Georgescu
  [[BR]]''prev_sub_state'':[[BR]]
709 103 Adrian Georgescu
  THe previous sub-state of the INVITE state machine.
710 103 Adrian Georgescu
  [[BR]]''state'':[[BR]]
711 103 Adrian Georgescu
  The new state of the INVITE state machine, which may be the same as the previous state.
712 103 Adrian Georgescu
  [[BR]]''sub_state'':[[BR]]
713 103 Adrian Georgescu
  The new sub-state of teh INVITE state machine, which may be the same as the previous sub-state.
714 103 Adrian Georgescu
  [[BR]]''method'': (only if the state change got triggered by an incoming SIP request)[[BR]]
715 103 Adrian Georgescu
  The method of the SIP request as a string.
716 103 Adrian Georgescu
  [[BR]]''request_uri'': (only if the state change got triggered by an incoming SIP request)[[BR]]
717 103 Adrian Georgescu
  The request URI of the SIP request as a {{{SIPURI}}} object.
718 103 Adrian Georgescu
  [[BR]]''code'': (only if the state change got triggered by an incoming SIP response or internal timeout or error)[[BR]]
719 103 Adrian Georgescu
  The code of the SIP response or error as an int.
720 103 Adrian Georgescu
  [[BR]]''reason'': (only if the state change got triggered by an incoming SIP response or internal timeout or error)[[BR]]
721 103 Adrian Georgescu
  The reason text of the SIP response or error as a string.
722 103 Adrian Georgescu
  [[BR]]''headers'': (only if the state change got triggered by an incoming SIP request or response)[[BR]]
723 103 Adrian Georgescu
  The headers of the SIP request or response as a dict.
724 103 Adrian Georgescu
  Each SIP header is represented in its parsed for as long as PJSIP supports it.
725 103 Adrian Georgescu
  The format of the parsed value depends on the header.
726 103 Adrian Georgescu
  [[BR]]''body'': (only if the state change got triggered by an incoming SIP request or response)[[BR]]
727 103 Adrian Georgescu
  The body of the SIP request or response as a string, or {{{None}}} if no body was included.
728 103 Adrian Georgescu
  The content type of the body can be learned from the {{{Content-Type:}}} header in the headers argument.
729 103 Adrian Georgescu
730 103 Adrian Georgescu
 '''SIPInvitationGotSDPUpdate'''::
731 103 Adrian Georgescu
  This notification is sent by an {{{Invitation}}} object whenever SDP negotiation has been performed.
732 103 Adrian Georgescu
  It should be used by the application as an indication to start, change or stop any associated media streams.
733 103 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
734 103 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
735 103 Adrian Georgescu
  [[BR]]''succeeded'':[[BR]]
736 103 Adrian Georgescu
  A boolean indicating if the SDP negotiation has succeeded.
737 103 Adrian Georgescu
  [[BR]]''error'': (only if SDP negotiation did not succeed)[[BR]]
738 103 Adrian Georgescu
  A string indicating why SDP negotiation failed.
739 103 Adrian Georgescu
  [[BR]]''local_sdp'': (only if SDP negotiation succeeded)[[BR]]
740 103 Adrian Georgescu
  A SDPSession object indicating the local SDP that was negotiated.
741 103 Adrian Georgescu
  [[BR]]''remote_sdp'': (only if SDP negotiation succeeded)[[BR]]
742 103 Adrian Georgescu
  A SDPSession object indicating the remote SDP that was negotiated.
743 103 Adrian Georgescu
744 103 Adrian Georgescu
745 92 Luci Stanescu
=== SDPSession ===
746 92 Luci Stanescu
747 92 Luci Stanescu
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 [http://tools.ietf.org/html/rfc4566 RFC 4566]. [http://tools.ietf.org/html/rfc3264 RFC 3264] 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. 
748 92 Luci Stanescu
749 92 Luci Stanescu
{{{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 [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__session.htm pjmedia_sdp_session] structure.
750 92 Luci Stanescu
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.
751 92 Luci Stanescu
A {{{(Frozen)SDPSession}}} object may contain {{{(Frozen)SDPMediaStream}}}, {{{(Frozen)SDPConnection}}} and {{{(Frozen)SDPAttribute}}} objects.
752 92 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPSession}}} objects using the == and != expressions.
753 92 Luci Stanescu
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.
754 99 Adrian Georgescu
755 92 Luci Stanescu
==== methods ====
756 92 Luci Stanescu
757 92 Luci Stanescu
758 92 Luci Stanescu
 '''!__init!__'''(''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}}})::
759 92 Luci Stanescu
  Creates the SDPSession object with the specified parameters as attributes.
760 92 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
761 92 Luci Stanescu
  [[BR]]''address'':[[BR]]
762 99 Adrian Georgescu
  The address that is contained in the "o" (origin) line of the SDP as a string.
763 92 Luci Stanescu
  [[BR]]''id'':[[BR]]
764 92 Luci Stanescu
  The session identifier contained in the "o" (origin) line of the SDP as an int.
765 99 Adrian Georgescu
  If this is set to {{{None}}} on init, a session identifier will be generated.
766 92 Luci Stanescu
  [[BR]]''version'':[[BR]]
767 92 Luci Stanescu
  The version identifier contained in the "o" (origin) line of the SDP as an int.
768 92 Luci Stanescu
  If this is set to {{{None}}} on init, a version identifier will be generated.
769 92 Luci Stanescu
  [[BR]]''user'':[[BR]]
770 92 Luci Stanescu
  The user name contained in the "o" (origin) line of the SDP as a string.
771 99 Adrian Georgescu
  [[BR]]''net_type'':[[BR]]
772 92 Luci Stanescu
  The network type contained in the "o" (origin) line of the SDP as a string.
773 92 Luci Stanescu
  [[BR]]''address_type'':[[BR]]
774 92 Luci Stanescu
  The address type contained in the "o" (origin) line of the SDP as a string.
775 99 Adrian Georgescu
  [[BR]]''name'':[[BR]]
776 92 Luci Stanescu
  The contents of the "s" (session name) line of the SDP as a string.
777 92 Luci Stanescu
  [[BR]]''info'':[[BR]]
778 92 Luci Stanescu
  The contents of the session level "i" (information) line of the SDP as a string.
779 99 Adrian Georgescu
  If this is {{{None}}} or an empty string, the SDP has no "i" line.
780 92 Luci Stanescu
  [[BR]]''connection'':[[BR]]
781 92 Luci Stanescu
  The contents of the "c" (connection) line of the SDP as a {{{(Frozen)SDPConnection}}} object.
782 92 Luci Stanescu
  If this is set to {{{None}}}, the SDP has no session level "c" line.
783 99 Adrian Georgescu
  [[BR]]''start_time'':[[BR]]
784 92 Luci Stanescu
  The first value of the "t" (time) line of the SDP as an int.
785 92 Luci Stanescu
  [[BR]]''stop_time'':[[BR]]
786 92 Luci Stanescu
  The second value of the "t" (time) line of the SDP as an int.
787 99 Adrian Georgescu
  [[BR]]''attributes'':[[BR]]
788 92 Luci Stanescu
  The session level "a" lines (attributes) in the SDP represented by a list of {{{(Frozen)SDPAttribute}}} objects.
789 92 Luci Stanescu
  [[BR]]''media'':[[BR]]
790 92 Luci Stanescu
  The media sections of the SDP represented by a list of {{{(Frozen)SDPMediaStream}}} objects.
791 92 Luci Stanescu
792 92 Luci Stanescu
 '''new'''(''cls'', ''sdp_session'')::
793 99 Adrian Georgescu
  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).
794 92 Luci Stanescu
795 92 Luci Stanescu
==== attributes ====
796 92 Luci Stanescu
797 92 Luci Stanescu
798 92 Luci Stanescu
 '''has_ice_proposal'''::
799 92 Luci Stanescu
  This read-only attribute returns {{{True}}} if the SDP contains any attributes which indicate the existence of an ice proposal and {{{False}}} otherwise.
800 92 Luci Stanescu
801 92 Luci Stanescu
=== SDPMediaStream ===
802 92 Luci Stanescu
803 92 Luci Stanescu
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.
804 92 Luci Stanescu
It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__media.htm pjmedia_sdp_media] structure.
805 92 Luci Stanescu
One or more {{{(Frozen)SDPMediaStream}}} objects are usually contained in a {{{(Frozen)SDPSession}}} object.
806 92 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPMedia}}} objects using the == and != expressions.
807 92 Luci Stanescu
As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method.
808 92 Luci Stanescu
809 92 Luci Stanescu
==== methods ====
810 92 Luci Stanescu
811 92 Luci Stanescu
812 99 Adrian Georgescu
 '''!__init!__'''(''self'', '''media''', '''port''', '''transport''', '''port_count'''=1, '''formats'''={{{None}}}, '''info'''={{{None}}}, '''connection'''={{{None}}}, '''attributes'''={{{None}}})::
813 92 Luci Stanescu
  Creates the SDPMedia object with the specified parameters as attributes.
814 92 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
815 92 Luci Stanescu
  [[BR]]''media'':[[BR]]
816 92 Luci Stanescu
  The media type contained in the "m" (media) line as a string.
817 92 Luci Stanescu
  [[BR]]''port'':[[BR]]
818 92 Luci Stanescu
  The transport port contained in the "m" (media) line as an int.
819 92 Luci Stanescu
  [[BR]]''transport'':[[BR]]
820 99 Adrian Georgescu
  The transport protocol in the "m" (media) line as a string.
821 92 Luci Stanescu
  [[BR]]''port_count'':[[BR]]
822 92 Luci Stanescu
  The port count in the "m" (media) line as an int.
823 99 Adrian Georgescu
  If this is set to 1, it is not included in the SDP.
824 92 Luci Stanescu
  [[BR]]''formats'':[[BR]]
825 92 Luci Stanescu
  The media formats in the "m" (media) line represented by a list of strings.
826 92 Luci Stanescu
  [[BR]]''info'':[[BR]]
827 92 Luci Stanescu
  The contents of the "i" (information) line of this media section as a string.
828 92 Luci Stanescu
  If this is {{{None}}} or an empty string, the media section has no "i" line.
829 99 Adrian Georgescu
  [[BR]]''connection'':[[BR]]
830 92 Luci Stanescu
  The contents of the "c" (connection) line that is somewhere below the "m" line of this section as a {{{(Frozen)SDPConnection}}} object.
831 92 Luci Stanescu
  If this is set to {{{None}}}, this media section has no "c" line.
832 92 Luci Stanescu
  [[BR]]''attributes'':[[BR]]
833 99 Adrian Georgescu
  The "a" lines (attributes) that are somewhere below the "m" line of this section represented by a list of {{{(Frozen)SDPAttribute}}} objects.
834 92 Luci Stanescu
835 92 Luci Stanescu
 '''new'''(''cls'', ''sdp_media'')::
836 92 Luci Stanescu
  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).
837 99 Adrian Georgescu
838 92 Luci Stanescu
==== attributes ====
839 92 Luci Stanescu
840 92 Luci Stanescu
841 99 Adrian Georgescu
 '''direction'''::
842 92 Luci Stanescu
  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".
843 92 Luci Stanescu
  If none of these attributes is present, the default direction is "sendrecv".
844 92 Luci Stanescu
845 92 Luci Stanescu
=== SDPConnection ===
846 92 Luci Stanescu
847 92 Luci Stanescu
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.
848 92 Luci Stanescu
It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__conn.htm pjmedia_sdp_conn] structure.
849 92 Luci Stanescu
A {{{(Frozen)SDPConnection}}} object can be contained in a {{{(Frozen)SDPSession}}} object or {{{(Frozen)SDPMediaStream}}} object.
850 92 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPConnection}}} objects using the == and != expressions.
851 92 Luci Stanescu
As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method.
852 92 Luci Stanescu
853 92 Luci Stanescu
==== methods ====
854 92 Luci Stanescu
855 92 Luci Stanescu
856 99 Adrian Georgescu
 '''!__init!__'''(''self'', '''address''', '''net_type'''="IN", '''address_type'''="IP4")::
857 92 Luci Stanescu
  Creates the SDPConnection object with the specified parameters as attributes.
858 92 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
859 92 Luci Stanescu
  [[BR]]''address'':[[BR]]
860 92 Luci Stanescu
  The address part of the connection line as a string.
861 99 Adrian Georgescu
  [[BR]]''net_type'':[[BR]]
862 92 Luci Stanescu
  The network type part of the connection line as a string.
863 92 Luci Stanescu
  [[BR]]''address_type'':[[BR]]
864 99 Adrian Georgescu
  The address type part of the connection line as a string.
865 92 Luci Stanescu
866 92 Luci Stanescu
 '''new'''(''cls'', ''sdp_connection'')::
867 99 Adrian Georgescu
  Classmethod that returns an instance of the class on which it has been called which is a copy of the {{{sdp_connection}}} object (which must be either a SDPConnection or a FrozenSDPConnection).
868 92 Luci Stanescu
869 92 Luci Stanescu
=== SDPAttributeList ===
870 92 Luci Stanescu
871 92 Luci Stanescu
{{{SDPAttributeList}}} and {{{FrozenSDPAttributeList}}} are subclasses of {{{list}}} and {{{frozenlist}}} respectively and are used as the types of the {{{attributes}}} attributes of {{{(Frozen)SDPSession}}} and {{{(Frozen)SDPMediaStream}}}. They provide convinience methods for accessing SDP attributes. Apart from the standard {{{list}}} and {{{frozenlist}}} methods, they also provide the following:
872 92 Luci Stanescu
873 92 Luci Stanescu
874 99 Adrian Georgescu
 '''!__contains!__'''(''self'', ''item'')::
875 92 Luci Stanescu
  If ''item'' is an instance of BaseSDPAttribute, the normal {{{(frozen)list}}} method is called. Otherwise, the method returns whether or not ''item'' is in the list of the names of the attributes. This allows tests such as the following to be possible:
876 92 Luci Stanescu
  {{{
877 92 Luci Stanescu
  'ice-pwd' in sdp_session.attributes
878 92 Luci Stanescu
  }}}
879 92 Luci Stanescu
880 92 Luci Stanescu
 '''getall'''(''self'', ''name'')::
881 92 Luci Stanescu
  Returns all the values of the attributes with the given name in a list.
882 99 Adrian Georgescu
883 92 Luci Stanescu
 '''getfirst'''(''self'', ''name'', ''default''={{{None}}})::
884 92 Luci Stanescu
  Return the first value of the attribute with the given name, or ''default'' is no such attribute exists.
885 92 Luci Stanescu
886 99 Adrian Georgescu
=== SDPAttribute ===
887 92 Luci Stanescu
888 92 Luci Stanescu
The {{{SDPAttribute}}} and {{{FrozenSDPAttribute}}} objects represent the contents of a "a" (attribute) line of a SDP body, either at the session level or for an individual media stream.
889 92 Luci Stanescu
It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__attr.htm pjmedia_sdp_attr] structure.
890 99 Adrian Georgescu
One or more {{{(Frozen)SDPAttribute}}} objects can be contained in a {{{(Frozen)SDPSession}}} object or {{{(Frozen)SDPMediaStream}}} object.
891 92 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPAttribute}}} objects using the == and != expressions.
892 92 Luci Stanescu
As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method.
893 92 Luci Stanescu
894 99 Adrian Georgescu
==== methods ====
895 92 Luci Stanescu
896 92 Luci Stanescu
897 99 Adrian Georgescu
 '''!__init!__'''(''self'', '''name''', '''value''')::
898 92 Luci Stanescu
  Creates the SDPAttribute object with the specified parameters as attributes.
899 92 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
900 92 Luci Stanescu
  [[BR]]''name'':[[BR]]
901 92 Luci Stanescu
  The name part of the attribute line as a string.
902 92 Luci Stanescu
  [[BR]]''value'':[[BR]]
903 99 Adrian Georgescu
  The value part of the attribute line as a string.
904 92 Luci Stanescu
905 92 Luci Stanescu
 '''new'''(''cls'', ''sdp_attribute'')::
906 92 Luci Stanescu
  Classmethod that returns an instance of the class on which it has been called which is a copy of the {{{sdp_attribute}}} object (which must be either a SDPAttribute or a FrozenSDPAttribute).
907 92 Luci Stanescu
908 92 Luci Stanescu
909 93 Luci Stanescu
=== RTPTransport ===
910 93 Luci Stanescu
911 93 Luci Stanescu
This object represents a transport for RTP media, the basis of which is a pair of UDP sockets, one for RTP and one for RTCP.
912 93 Luci Stanescu
Internally it wraps a [http://www.pjsip.org/pjmedia/docs/html/group__PJMEDIA__TRANSPORT.htm pjmedia_transport] object.
913 93 Luci Stanescu
Initially this object will only be used by the {{{AudioTransport}}} object, but in the future it can also be used for video and [wiki:RTTProposal Real-Time Text].
914 93 Luci Stanescu
For this reason the {{{AudioTransport}}} and {{{RTPTransport}}} are two distinct objects.
915 93 Luci Stanescu
916 93 Luci Stanescu
The {{{RTPTransport}}} object also allows support for ICE and SRTP functionality from PJSIP.
917 93 Luci Stanescu
Because these features are related to both the UDP transport and the SDP formatting, the SDP carried in SIP signaling message will need to "pass through" this object during the SDP negotiation.
918 93 Luci Stanescu
The code using this object, which in most cases will be the {{{AudioTransport}}} object, will need to call certain methods on the object at appropriate times.
919 93 Luci Stanescu
This process of SDP negotiation is represented by the internal state machine of the object, as shown in the following diagram:
920 93 Luci Stanescu
921 93 Luci Stanescu
> The Real-time Transport Protocol (or RTP) defines a standardized packet format for delivering audio and video over the Internet.
922 93 Luci Stanescu
> It was developed by the Audio-Video Transport Working Group of the IETF and published in [http://tools.ietf.org/html/rfc3550 RFC 3550].
923 93 Luci Stanescu
> RTP is used in streaming media systems (together with the RTSP) as well as in videoconferencing and push to talk systems.
924 93 Luci Stanescu
> For these it carries media streams controlled by Session Initiation Protocol (SIP) signaling protocols, making it the technical foundation of the Voice over IP industry.
925 93 Luci Stanescu
926 93 Luci Stanescu
[[Image(sipsimple-rtp-transport-state-machine.png, nolink)]]
927 93 Luci Stanescu
928 93 Luci Stanescu
State changes are triggered by the following events:
929 93 Luci Stanescu
 1. The application calls the {{{set_INIT()}}} method after object creation and ICE+STUN is not used.
930 93 Luci Stanescu
 2. The application calls the {{{set_INIT()}}} method after object creation and ICE+STUN is used.
931 93 Luci Stanescu
 3. A successful STUN response is received from the STUN server.
932 93 Luci Stanescu
 4. The {{{set_LOCAL()}}} method is called.
933 93 Luci Stanescu
 5. The {{{set_ESTABLISHED()}}} method is called.
934 93 Luci Stanescu
 6. The {{{set_INIT()}}} method is called while the object is in the {{{LOCAL}}} or {{{ESTABLISHED}}} state.
935 93 Luci Stanescu
 7. A method is called on the application, but in the meantime the {{{Engine}}} has stopped.
936 93 Luci Stanescu
    The object can no longer be used.
937 93 Luci Stanescu
 8. There was an error in getting the STUN candidates from the STUN server.
938 93 Luci Stanescu
939 93 Luci Stanescu
> It would make sense to be able to use the object even if the STUN request fails (and have ICE not include a STUN candidate), but for some reason the pjmedia_transport is unusable once STUN negotiation has failed.
940 93 Luci Stanescu
> This means that the RTPTransport object is also unusable once it has reached the STUN_FAILED state.
941 93 Luci Stanescu
> A workaround would be destroy the RTPTransport object and create a new one that uses ICE without STUN.
942 93 Luci Stanescu
943 93 Luci Stanescu
These states allow for two SDP negotiation scenarios to occur, represented by two paths that can be followed through the state machine.
944 93 Luci Stanescu
In this example we will assume that ICE with STUN is not used, as it is independent of the SDP negotiation procedure.
945 93 Luci Stanescu
 * The first scenario is where the local party generates the SDP offer.
946 93 Luci Stanescu
   For a stream that it wishes to include in this SDP offer, it instantiates a {{{RTPTransport}}} object.
947 93 Luci Stanescu
   After instantiation the object is initialized by calling the {{{set_INIT()}}} method and the local RTP address and port can be fetched from it using the {{{local_rtp_address}}} and {{{local_rtp_port}}} attributes respectively, which can be used to generate the local SDP in the form of a {{{SDPSession}}} object.
948 93 Luci Stanescu
   This local SDP then needs to be passed to the {{{set_LOCAL()}}} method, which moves the state machine into the {{{LOCAL}}} state (note that it needs the full object, not just the relevant {{{SDPMediaStream}}} object).
949 93 Luci Stanescu
   Depending on the options used for the {{{RTPTransport}}} instantiation (such as ICE and SRTP), this may change the {{{SDPSession}}} object.
950 93 Luci Stanescu
   This (possibly changed) {{{SDPSession}}} object then needs to be passed to the {{{Invitation}}} object.
951 93 Luci Stanescu
   After SDP negotiation is completed, the application needs to pass both the local and remote SDP, in the form of {{{(Frozen)SDPSession}}} objects, to the {{{RTPTransport}}} object using the {{{set_ESTABLISHED()}}} method, moving the state machine into the {{{ESTABLISHED}}} state.
952 93 Luci Stanescu
   This will not change either of the {{{(Frozen)SDPSession}}} objects (which is why they can also be frozen).
953 93 Luci Stanescu
 * The second scenario is where the local party is offered a media stream in SDP and wants to accept it.
954 93 Luci Stanescu
   In this case a {{{RTPTransport}}} is also instantiated and initialized using the {{{set_INIT()}}} method, and the application can generate the local SDP in response to the remote SDP, using the {{{local_rtp_address}}} and {{{local_rtp_port}}} attributes.
955 93 Luci Stanescu
   Directly after this it should pass the generated local SDP and received remote SDP, in the form of {{{SDPSession}}} objects, to the {{{set_ESTABLISHED()}}} method.
956 93 Luci Stanescu
   In this case the local SDP object may be changed, after which it can be passed to the {{{Invitation}}} object.
957 93 Luci Stanescu
958 93 Luci Stanescu
Whenever the {{{RTPTransport}}} object is in the {{{LOCAL}}} or {{{ESTABLISHED}}} states, it may be reset to the {{{INIT}}} state to facilitate re-use of the existing transport and its features.
959 93 Luci Stanescu
Before doing this however, the internal transport object must no longer be in use.
960 93 Luci Stanescu
961 93 Luci Stanescu
==== methods ====
962 93 Luci Stanescu
963 99 Adrian Georgescu
964 93 Luci Stanescu
 '''!__init!__'''(''self'', '''local_rtp_address'''={{{None}}}, '''use_srtp'''={{{False}}}, '''srtp_forced'''={{{False}}}, '''use_ice'''={{{False}}}, '''ice_stun_address'''={{{None}}}, '''ice_stun_port'''=3478)::
965 93 Luci Stanescu
  Creates a new {{{RTPTransport}}} object and opens the RTP and RTCP UDP sockets.
966 93 Luci Stanescu
  If additional features are requested, they will be initialized.
967 93 Luci Stanescu
  After object instantiation, it is either in the {{{INIT}}} or the {{{WAIT_STUN}}} state, depending on the values of the {{{use_ice}}} and {{{ice_stun_address}}} arguments.
968 93 Luci Stanescu
  [[BR]]''local_rtp_address'':[[BR]]
969 93 Luci Stanescu
  Optionally contains the local IPv4 address to listen on.
970 93 Luci Stanescu
  If this is not specified, PJSIP will listen on all network interfaces.
971 93 Luci Stanescu
  [[BR]]''use_srtp'':[[BR]]
972 93 Luci Stanescu
  A boolean indicating if SRTP should be used.
973 93 Luci Stanescu
  If this is set to {{{True}}}, SRTP information will be added to the SDP when it passes this object.
974 93 Luci Stanescu
  [[BR]]''srtp_forced'':[[BR]]
975 93 Luci Stanescu
  A boolean indicating if use of SRTP is set to mandatory in the SDP.
976 93 Luci Stanescu
  If this is set to {{{True}}} and the remote party does not support SRTP, the SDP negotiation for this stream will fail.
977 93 Luci Stanescu
  This argument is relevant only if {{{use_srtp}}} is set to {{{True}}}.
978 93 Luci Stanescu
  [[BR]]''use_ice'':[[BR]]
979 93 Luci Stanescu
  A boolean indicating if ICE should be used.
980 93 Luci Stanescu
  If this is set to {{{True}}}, ICE candidates will be added to the SDP when it passes this object.
981 93 Luci Stanescu
  [[BR]]''ice_stun_address'':[[BR]]
982 93 Luci Stanescu
  A string indicating the address (IP address or hostname) of the STUN server that should be used to add a STUN candidate to the ICE candidates.
983 93 Luci Stanescu
  If this is set to {{{None}}} no STUN candidate will be added, otherwise the object will be put into the {{{WAIT_STUN}}} state until a reply, either positive or negative, is received from the specified STUN server.
984 93 Luci Stanescu
  When this happens a {{{RTPTransportGotSTUNResponse}}} notification is sent.
985 93 Luci Stanescu
  This argument is relevant only if {{{use_ice}}} is set to {{{True}}}.
986 93 Luci Stanescu
  [[BR]]''ice_stun_address'':[[BR]]
987 93 Luci Stanescu
  An int indicating the UDP port of the STUN server that should be used to add a STUN candidate to the ICE candidates.
988 93 Luci Stanescu
  This argument is relevant only if {{{use_ice}}} is set to {{{True}}} and {{{ice_stun_address}}} is not {{{None}}}.
989 99 Adrian Georgescu
990 93 Luci Stanescu
 '''set_INIT'''(''self'')::
991 93 Luci Stanescu
  This moves the internal state machine into the {{{INIT}}} state.
992 93 Luci Stanescu
  If the state machine is in the {{{LOCAL}}} or {{{ESTABLISHED}}} states, this effectively resets the {{{RTPTransport}}} object for re-use.
993 99 Adrian Georgescu
994 93 Luci Stanescu
 '''set_LOCAL'''(''self'', '''local_sdp''', '''sdp_index''')::
995 93 Luci Stanescu
  This moves the the internal state machine into the {{{LOCAL}}} state.
996 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
997 93 Luci Stanescu
  The local SDP to be proposed in the form of a {{{SDPSession}}} object.
998 93 Luci Stanescu
  Note that this object may be modified by this method.
999 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1000 93 Luci Stanescu
  The index in the SDP for the media stream for which this object was created.
1001 99 Adrian Georgescu
1002 93 Luci Stanescu
 '''set_ESTABLISHED'''(''self'', '''local_sdp''', '''remote_sdp''', '''sdp_index''')::
1003 93 Luci Stanescu
  This moves the the internal state machine into the {{{ESTABLISHED}}} state.
1004 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
1005 93 Luci Stanescu
  The local SDP to be proposed in the form of a {{{SDPSession}}} object.
1006 93 Luci Stanescu
  Note that this object may be modified by this method, but only when moving from the {{{LOCAL}}} to the {{{ESTABLISHED}}} state.
1007 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
1008 93 Luci Stanescu
  The remote SDP that was received in in the form of a {{{SDPSession}}} object.
1009 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1010 93 Luci Stanescu
  The index in the SDP for the media stream for which this object was created.
1011 93 Luci Stanescu
1012 93 Luci Stanescu
==== attributes ====
1013 93 Luci Stanescu
1014 99 Adrian Georgescu
1015 93 Luci Stanescu
 '''state'''::
1016 93 Luci Stanescu
  Indicates which state the internal state machine is in.
1017 93 Luci Stanescu
  See the previous section for a list of states the state machine can be in.
1018 93 Luci Stanescu
  This attribute is read-only.
1019 99 Adrian Georgescu
1020 93 Luci Stanescu
 '''local_rtp_address'''::
1021 93 Luci Stanescu
  The local IPv4 address of the interface the {{{RTPTransport}}} object is listening on and the address that should be included in the SDP.
1022 93 Luci Stanescu
  If no address was specified during object instantiation, PJSIP will take guess out of the IP addresses of all interfaces.
1023 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} if PJSIP is not listening on the transport.
1024 99 Adrian Georgescu
1025 93 Luci Stanescu
 '''local_rtp_port'''::
1026 93 Luci Stanescu
  The UDP port PJSIP is listening on for RTP traffic.
1027 93 Luci Stanescu
  RTCP traffic will always be this port plus one.
1028 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} if PJSIP is not listening on the transport.
1029 99 Adrian Georgescu
1030 93 Luci Stanescu
 '''remote_rtp_address_sdp'''::
1031 93 Luci Stanescu
  The remote IP address that was seen in the SDP.
1032 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless the object is in the {{{ESTABLISHED}}} state.
1033 99 Adrian Georgescu
1034 93 Luci Stanescu
 '''remote_rtp_port_sdp'''::
1035 93 Luci Stanescu
  The remote UDP port for RTP that was seen in the SDP.
1036 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless the object is in the {{{ESTABLISHED}}} state.
1037 99 Adrian Georgescu
1038 93 Luci Stanescu
 '''remote_rtp_address_ice'''::
1039 93 Luci Stanescu
  The remote IP address that was selected by the ICE negotation.
1040 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} until the ICE negotation succeeds.
1041 99 Adrian Georgescu
1042 93 Luci Stanescu
 '''remote_rtp_port_ice'''::
1043 93 Luci Stanescu
  The remote port that was selected by the ICE negotation.
1044 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} until the ICE negotation succeeds.
1045 99 Adrian Georgescu
1046 93 Luci Stanescu
 '''remote_rtp_address_received'''::
1047 93 Luci Stanescu
  The remote IP address from which RTP data was received.
1048 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless RTP was actually received.
1049 99 Adrian Georgescu
1050 93 Luci Stanescu
 '''remote_rtp_port_received'''::
1051 93 Luci Stanescu
  The remote UDP port from which RTP data was received.
1052 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless RTP was actually received.
1053 99 Adrian Georgescu
1054 93 Luci Stanescu
 '''use_srtp'''::
1055 93 Luci Stanescu
  A boolean indicating if the use of SRTP was requested when the object was instantiated.
1056 93 Luci Stanescu
  This attribute is read-only.
1057 99 Adrian Georgescu
1058 93 Luci Stanescu
 '''force_srtp'''::
1059 93 Luci Stanescu
  A boolean indicating if SRTP being mandatory for this transport if it is enabled was requested when the object was instantiated.
1060 93 Luci Stanescu
  This attribute is read-only.
1061 99 Adrian Georgescu
1062 93 Luci Stanescu
 '''srtp_active'''::
1063 93 Luci Stanescu
  A boolean indicating if SRTP encryption and decryption is running.
1064 93 Luci Stanescu
  Querying this attribute only makes sense once the object is in the {{{ESTABLISHED}}} state and use of SRTP was requested.
1065 93 Luci Stanescu
  This attribute is read-only.
1066 99 Adrian Georgescu
1067 93 Luci Stanescu
 '''use_ice'''::
1068 93 Luci Stanescu
  A boolean indicating if the use of ICE was requested when the object was instantiated.
1069 93 Luci Stanescu
  This attribute is read-only.
1070 99 Adrian Georgescu
1071 93 Luci Stanescu
 '''ice_active''::
1072 93 Luci Stanescu
  A boolean indicating if ICE is being used.
1073 93 Luci Stanescu
  This attribute is read-only.
1074 99 Adrian Georgescu
1075 93 Luci Stanescu
 '''ice_stun_address'''::
1076 93 Luci Stanescu
  A string indicating the IP address of the STUN server that was requested to be used.
1077 93 Luci Stanescu
  This attribute is read-only.
1078 99 Adrian Georgescu
1079 93 Luci Stanescu
 '''ice_stun_port'''::
1080 93 Luci Stanescu
  A string indicating the UDP port of the STUN server that was requested to be used.
1081 93 Luci Stanescu
  This attribute is read-only.
1082 99 Adrian Georgescu
1083 93 Luci Stanescu
 '''local_rtp_candidate_type'''::
1084 93 Luci Stanescu
  Returns the ICE candidate type which has been selected for the local endpoint.
1085 99 Adrian Georgescu
1086 93 Luci Stanescu
 '''remote_rtp_candidate_type'''::
1087 93 Luci Stanescu
  Returns the ICE candidate type which has been selected for the remote endpoint.
1088 93 Luci Stanescu
1089 93 Luci Stanescu
==== notifications ====
1090 93 Luci Stanescu
1091 99 Adrian Georgescu
1092 93 Luci Stanescu
 '''RTPTransportDidInitialize'''::
1093 93 Luci Stanescu
  This notification is sent when a {{{RTPTransport}}} object has successfully initialized.
1094 93 Luci Stanescu
  If STUN+ICE is not requested, this is sent immediately on {{{set_INIT()}}}, otherwise it is sent after the STUN query has succeeded.
1095 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1096 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1097 99 Adrian Georgescu
1098 93 Luci Stanescu
 '''RTPTransportDidFail'''::
1099 93 Luci Stanescu
  This notification is sent by a {{{RTPTransport}}} object that fails to retrieve ICE candidates from the STUN server after {{{set_INIT()}}} is called.
1100 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1101 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1102 93 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1103 93 Luci Stanescu
  A string describing the failure reason.
1104 99 Adrian Georgescu
1105 93 Luci Stanescu
 '''RTPTransportICENegotiationStateDidChange'''::
1106 93 Luci Stanescu
  This notification is sent to indicate the progress of the ICE negotiation.
1107 93 Luci Stanescu
  [[BR]]''state'':[[BR]]
1108 93 Luci Stanescu
  A string describing the current ICE negotiation state.
1109 99 Adrian Georgescu
1110 93 Luci Stanescu
 '''RTPTransportICENegotiationDidFail'''::
1111 93 Luci Stanescu
  This notification is sent when the ICE negotiation fails.
1112 93 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1113 93 Luci Stanescu
  A string describing the failure reason of ICE negotation.
1114 99 Adrian Georgescu
1115 93 Luci Stanescu
 '''RTPTransportICENegotiationDidSucceed'''::
1116 93 Luci Stanescu
  This notification is sent when the ICE negotation succeeds.
1117 93 Luci Stanescu
  [[BR]]''chosen_local_candidates'' and ''chosen_remote_candidates'':[[BR]]
1118 93 Luci Stanescu
  Dictionaries with the following keys:
1119 93 Luci Stanescu
   * rtp_cand_type: the type of the RTP candidate
1120 93 Luci Stanescu
   * rtp_cand_ip: the IP address of the RTP candidate
1121 93 Luci Stanescu
   * rtcp_cand_type: the type of the RTCP candidate
1122 93 Luci Stanescu
   * rtcp_cand_ip: the IP address of teh RTCP candidate
1123 93 Luci Stanescu
  [[BR]]''duration'':[[BR]]
1124 93 Luci Stanescu
  The amount of time the ICE negotiation took.
1125 93 Luci Stanescu
  [[BR]]''local_candidates'' and ''remote_candidates'':[[BR]]
1126 93 Luci Stanescu
  Lists of tuples with the following elements:
1127 93 Luci Stanescu
   * Item ID
1128 93 Luci Stanescu
   * Component ID
1129 93 Luci Stanescu
   * Address
1130 93 Luci Stanescu
   * Component Type
1131 93 Luci Stanescu
  [[BR]]''connectivity_checks_results'':[[BR]]
1132 93 Luci Stanescu
  A list of tuples with the following elements:
1133 93 Luci Stanescu
   * Item ID
1134 93 Luci Stanescu
   * Component ID
1135 93 Luci Stanescu
   * Source
1136 93 Luci Stanescu
   * Destination
1137 93 Luci Stanescu
   * Nomination
1138 93 Luci Stanescu
   * State
1139 93 Luci Stanescu
1140 93 Luci Stanescu
=== AudioTransport ===
1141 93 Luci Stanescu
1142 93 Luci Stanescu
This object represent an audio stream as it is transported over the network.
1143 93 Luci Stanescu
It contains an instance of {{{RTPTransport}}} and wraps a [http://www.pjsip.org/pjmedia/docs/html/group__PJMED__STRM.htm pjmedia_stream] object, which in turn manages the RTP encapsulation, RTCP session, audio codec and adaptive jitter buffer.
1144 93 Luci Stanescu
It also generates a {{{SDPMediaStream}}} object to be included in the local SDP.
1145 93 Luci Stanescu
1146 93 Luci Stanescu
The {{{AudioTransport}}} is an object that, once started, is connected to a {{{AudioMixer}}} instance, and both produces and consumes sound.
1147 93 Luci Stanescu
1148 93 Luci Stanescu
Like the {{{RTPTransport}}} object there are two usage scenarios.
1149 93 Luci Stanescu
 * In the first scenario, only the {{{RTPTransport}}} instance to be used is passed to the AudioTransport object.
1150 93 Luci Stanescu
   The application can then generate the {{{SDPMediaStream}}} object by calling the {{{get_local_media()}}} method and should include it in the SDP offer.
1151 93 Luci Stanescu
   Once the remote SDP is received, it should be set along with the complete local SDP by calling the {{{start()}}} method, which will start the audio stream.
1152 93 Luci Stanescu
   The stream can then be connected to the conference bridge.
1153 93 Luci Stanescu
 * In the other scenario the remote SDP is already known because it was received in an SDP offer and can be passed directly on object instantiation.
1154 93 Luci Stanescu
   The local {{{SDPMediaStream}}} object can again be generated by calling the {{{get_local_media()}}} method and is to be included in the SDP answer.
1155 93 Luci Stanescu
   The audio stream is started directly when the object is created.
1156 93 Luci Stanescu
1157 93 Luci Stanescu
Unlike the {{{RTPTransport}}} object, this object cannot be reused.
1158 93 Luci Stanescu
1159 93 Luci Stanescu
==== methods ====
1160 93 Luci Stanescu
1161 99 Adrian Georgescu
1162 93 Luci Stanescu
 '''!__init!__'''(''self'', '''mixer''', '''transport''', '''remote_sdp'''={{{None}}}, '''sdp_index'''=0, '''enable_silence_detection'''=True, '''codecs'''={{{None}}})::
1163 93 Luci Stanescu
  Creates a new {{{AudioTransport}}} object and start the underlying stream if the remote SDP is already known.
1164 93 Luci Stanescu
  [[BR]]''mixer'':[[BR]]
1165 93 Luci Stanescu
  The {{{AudioMixer}}} object that this object is to be connected to.
1166 93 Luci Stanescu
  [[BR]]''transport'':[[BR]]
1167 93 Luci Stanescu
  The transport to use in the form of a {{{RTPTransport}}} object.
1168 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
1169 93 Luci Stanescu
  The remote SDP that was received in the form of a {{{SDPSession}}} object.
1170 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1171 93 Luci Stanescu
  The index within the SDP of the audio stream that should be created.
1172 93 Luci Stanescu
  [[BR]]''enable_silence_detection''[[BR]]
1173 93 Luci Stanescu
  Boolean that indicates if silence detection should be used for this audio stream.
1174 93 Luci Stanescu
  When enabled, this {{{AudioTransport}}} object will stop sending audio to the remote party if the input volume is below a certain threshold.
1175 93 Luci Stanescu
  [[BR]]''codecs''[[BR]]
1176 93 Luci Stanescu
  A list of strings indicating the codecs that should be proposed in the SDP of this {{{AudioTransport}}}, in order of preference.
1177 93 Luci Stanescu
  This overrides the global codecs list set on the {{{Engine}}}.
1178 93 Luci Stanescu
  The values of this list are case insensitive.
1179 99 Adrian Georgescu
1180 93 Luci Stanescu
 '''get_local_media'''(''self'', '''is_offer''', '''direction'''="sendrecv")::
1181 93 Luci Stanescu
  Generates a {{{SDPMediaStream}}} object which describes the audio stream.
1182 93 Luci Stanescu
  This object should be included in a {{{SDPSession}}} object that gets passed to the {{{Invitation}}} object.
1183 93 Luci Stanescu
  This method should also be used to obtain the SDP to include in re-INVITEs and replies to re-INVITEs.
1184 93 Luci Stanescu
  [[BR]]''is_offer'':[[BR]]
1185 93 Luci Stanescu
  A boolean indicating if the SDP requested is to be included in an offer.
1186 93 Luci Stanescu
  If this is {{{False}}} it is to be included in an answer.
1187 93 Luci Stanescu
  [[BR]]''direction'':[[BR]]
1188 93 Luci Stanescu
  The direction attribute to put in the SDP.
1189 99 Adrian Georgescu
1190 93 Luci Stanescu
 '''start'''(''self'', '''local_sdp''', '''remote_sdp''', '''sdp_index''', '''no_media_timeout'''=10, '''media_check_interval'''=30)::
1191 93 Luci Stanescu
  This method should only be called once, when the application has previously sent an SDP offer and the answer has been received.
1192 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
1193 93 Luci Stanescu
  The full local SDP that was included in the SDP negotiation in the form of a {{{SDPSession}}} object.
1194 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
1195 93 Luci Stanescu
  The remote SDP that was received in the form of a {{{SDPSession}}} object.
1196 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1197 93 Luci Stanescu
  The index within the SDP of the audio stream.
1198 93 Luci Stanescu
  [[BR]]''no_media_timeout'':[[BR]]
1199 93 Luci Stanescu
  This argument indicates after how many seconds after starting the {{{AudioTransport}}} the {{{RTPAudioTransportDidNotGetRTP}}} notification should be sent, if no RTP has been received at all.
1200 93 Luci Stanescu
  Setting this to 0 disables this an all subsequent RTP checks.
1201 93 Luci Stanescu
  [[BR]]''media_check_interval'':[[BR]]
1202 93 Luci Stanescu
  This indicates the interval at which the RTP stream should be checked, after it has initially received RTP at after {{{no_media_timeout}}} seconds.
1203 93 Luci Stanescu
  It means that if between two of these interval checks no RTP has been received, a {{{RTPAudioTransportDidNotGetRTP}}} notification will be sent.
1204 93 Luci Stanescu
  Setting this to 0 will disable checking the RTP at intervals.
1205 93 Luci Stanescu
  The initial check may still be performed if its timeout is non-zero.
1206 99 Adrian Georgescu
1207 93 Luci Stanescu
 '''stop'''(''self'')::
1208 93 Luci Stanescu
  This method stops and destroys the audio stream encapsulated by this object.
1209 93 Luci Stanescu
  After this it can no longer be used and should be deleted, while the {{{RTPTransport}}} object used by it can be re-used for something else.
1210 93 Luci Stanescu
  This method will be called automatically when the object is deleted after it was started, but this should not be relied on because of possible reference counting issues.
1211 99 Adrian Georgescu
1212 93 Luci Stanescu
 '''send_dtmf'''(''self'', '''digit''')::
1213 93 Luci Stanescu
  For a negotiated audio transport this sends one DTMF digit to the other party
1214 93 Luci Stanescu
  [[BR]]''digit'':[[BR]]
1215 93 Luci Stanescu
  A string of length one indicating the DTMF digit to send.
1216 93 Luci Stanescu
  This can be either a digit, the pound sign (#), the asterisk sign (*) or the letters A through D.
1217 99 Adrian Georgescu
1218 93 Luci Stanescu
 '''update_direction'''(''self'', '''direction''')::
1219 93 Luci Stanescu
  This method should be called after SDP negotiation has completed to update the direction of the media stream.
1220 93 Luci Stanescu
  [[BR]]''direction'':[[BR]]
1221 93 Luci Stanescu
  The direction that has been negotiated.
1222 93 Luci Stanescu
1223 93 Luci Stanescu
==== attributes ====
1224 93 Luci Stanescu
1225 99 Adrian Georgescu
1226 93 Luci Stanescu
 '''mixer'''::
1227 93 Luci Stanescu
  The {{{AudioMixer}}} object that was passed when the object got instantiated.
1228 93 Luci Stanescu
  This attribute is read-only.
1229 99 Adrian Georgescu
1230 93 Luci Stanescu
 '''transport'''::
1231 93 Luci Stanescu
  The {{{RTPTransport}}} object that was passed when the object got instantiated.
1232 93 Luci Stanescu
  This attribute is read-only.
1233 99 Adrian Georgescu
1234 93 Luci Stanescu
 '''slot'''::
1235 93 Luci Stanescu
  A read-only property indicating the slot number at which this object is attached to the associated conference bridge.
1236 93 Luci Stanescu
  If the {{{AudioTransport}}} is not active (i.e. has not been started), this attribute will be {{{None}}}.
1237 99 Adrian Georgescu
1238 93 Luci Stanescu
 '''volume'''::
1239 93 Luci Stanescu
  A writable property indicating the % of volume at which this object contributes audio to the conference bridge.
1240 93 Luci Stanescu
  By default this is set to 100.
1241 99 Adrian Georgescu
1242 93 Luci Stanescu
 '''is_active'''::
1243 93 Luci Stanescu
  A boolean indicating if the object is currently sending and receiving audio.
1244 93 Luci Stanescu
  This attribute is read-only.
1245 99 Adrian Georgescu
1246 93 Luci Stanescu
 '''is_started'''::
1247 93 Luci Stanescu
  A boolean indicating if the object has been started.
1248 93 Luci Stanescu
  Both this attribute and the {{{is_active}}} attribute get set to {{{True}}} once the {{{start()}}} method is called, but unlike the {{{is_active}}} attribute this attribute does not get set to {{{False}}} once {{{stop()}}} is called.
1249 93 Luci Stanescu
  This is to prevent the object from being re-used.
1250 93 Luci Stanescu
  This attribute is read-only.
1251 99 Adrian Georgescu
1252 93 Luci Stanescu
 '''codec'''::
1253 93 Luci Stanescu
  Once the SDP negotiation is complete, this attribute indicates the audio codec that was negotiated, otherwise it will be {{{None}}}.
1254 93 Luci Stanescu
  This attribute is read-only.
1255 99 Adrian Georgescu
1256 93 Luci Stanescu
 '''sample_rate'''::
1257 93 Luci Stanescu
  Once the SDP negotiation is complete, this attribute indicates the sample rate of the audio codec that was negotiated, otherwise it will be {{{None}}}.
1258 93 Luci Stanescu
  This attribute is read-only.
1259 99 Adrian Georgescu
1260 93 Luci Stanescu
 '''direction'''::
1261 93 Luci Stanescu
  The current direction of the audio transport, which is one of "sendrecv", "sendonly", "recvonly" or "inactive".
1262 93 Luci Stanescu
  This attribute is read-only, although it can be set using the {{{update_direction()}}} method.
1263 93 Luci Stanescu
1264 93 Luci Stanescu
==== notifications ====
1265 93 Luci Stanescu
1266 99 Adrian Georgescu
1267 93 Luci Stanescu
 '''RTPAudioTransportGotDTMF'''::
1268 93 Luci Stanescu
  This notification will be sent when an incoming DTMF digit is received from the remote party.
1269 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1270 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1271 93 Luci Stanescu
  [[BR]]''digit'':[[BR]]
1272 93 Luci Stanescu
  The DTMF digit that was received, in the form of a string of length one.
1273 93 Luci Stanescu
  This can be either a number or letters A through D.
1274 99 Adrian Georgescu
1275 93 Luci Stanescu
 '''RTPAudioTransportDidNotGetRTP'''::
1276 93 Luci Stanescu
  This notification will be sent when no RTP packets have been received from the remote party for some time.
1277 93 Luci Stanescu
  See the {{{start()}}} method for a more exact description.
1278 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1279 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1280 93 Luci Stanescu
  [[BR]]''got_any'':[[BR]]
1281 93 Luci Stanescu
  A boolean data attribute indicating if the {{{AudioTransport}}} every saw any RTP packets from the remote party.
1282 93 Luci Stanescu
  In effect, if no RTP was received after {{{no_media_timeout}}} seconds, its value will be {{{False}}}.
1283 93 Luci Stanescu
1284 46 Ruud Klaver
=== Request ===
1285 46 Ruud Klaver
1286 46 Ruud Klaver
The {{{sipsimple.core.Request}}} object encapsulates a single SIP request transaction from the client side, which includes sending the request, receiving the response and possibly waiting for the result of the request to expire.
1287 94 Luci Stanescu
Although this class can be used by the application to construct and send an arbitrary SIP request, most applications will use the classes for primitive requests provided in the {{{sipsimple.core}}} module, which are built on top of one or several {{{Request}}} objects and deal with instances of specific SIP methods (REGISTER, MESSAGE and PUBLISH).
1288 46 Ruud Klaver
1289 46 Ruud Klaver
The lifetime of this object is linear and is described by the following diagram:
1290 46 Ruud Klaver
1291 46 Ruud Klaver
[[Image(sipsimple-request-lifetime.png, nolink)]]
1292 46 Ruud Klaver
1293 46 Ruud Klaver
The bar denotes which state the object is in and at the top are the notifications which may be emitted at certain points in time.
1294 46 Ruud Klaver
Directly after the object is instantiated, it will be in the {{{INIT}}} state.
1295 46 Ruud Klaver
The request will be sent over the network once its {{{send()}}} method is called, moving the object into the {{{IN_PROGRESS}}} state.
1296 46 Ruud Klaver
On each provisional response that is received in reply to this request, the {{{SIPRequestGotProvisionalResponse}}} notification is sent, with data describing the response.
1297 46 Ruud Klaver
Note that this may not occur at all if not provisional responses are received.
1298 46 Ruud Klaver
When the {{{send()}}} method has been called and it does not return an exception, the object will send either a {{{SIPRequestDidSucceed}}} or a {{{SIPRequestDidFail}}} notification.
1299 46 Ruud Klaver
Both of these notifications include data on the response that triggered it.
1300 46 Ruud Klaver
Note that a SIP response that requests authentication (401 or 407) will be handled internally the first time, if a {{{Credentials}}} object was supplied.
1301 46 Ruud Klaver
If this is the sort of request that expires (detected by a {{{Expires}}} header in the response or a {{{expires}}} parameter in the {{{Contact}}} header of the response), and the request was successful, the object will go into the {{{EXPIRING}}} state.
1302 46 Ruud Klaver
A certain amount of time before the result of the request will expire, governed by the {{{expire_warning_time}}} class attribute and the actual returned expiration time, a {{{SIPRequestWillExpire}}} notification will be sent.
1303 46 Ruud Klaver
This should usually trigger whomever is using this {{{Request}}} object to construct a new {{{Request}}} for a refreshing operation.
1304 49 Ruud Klaver
When the {{{Request}}} actually expires, or when the {{{EXPIRING}}} state is skipped directly after sending {{{SIPRequestDidSucceed}}} or {{{SIPRequestDidFail}}}, a {{{SIPRequestDidEnd}}} notification will be sent.
1305 1 Adrian Georgescu
1306 94 Luci Stanescu
==== methods ====
1307 1 Adrian Georgescu
1308 99 Adrian Georgescu
1309 110 Adrian Georgescu
 '''!__init!__'''(''self'', '''method''', '''request_uri''', '''from_header''', '''to_header''', '''route_header''', '''credentials'''={{{None}}}, '''contact_header'''={{{None}}}, '''call_id'''={{{None}}}, '''cseq'''={{{None}}}, '''extra_headers'''={{{None}}}, '''content_type'''={{{None}}}, '''body'''={{{None}}})::
1310 94 Luci Stanescu
  Creates a new {{{Request}}} object in the {{{INIT}}} state.
1311 94 Luci Stanescu
  The arguments to this method are documented in the attributes section.
1312 99 Adrian Georgescu
1313 94 Luci Stanescu
 '''send'''(''self'', '''timeout'''={{{None}}})::
1314 94 Luci Stanescu
   Compose the SIP request and send it to the destination.
1315 94 Luci Stanescu
   This moves the {{{Request}}} object into the {{{IN_PROGRESS}}} state.
1316 94 Luci Stanescu
  [[BR]]''timeout'':[[BR]]
1317 94 Luci Stanescu
  This can be either an int or a float, indicating in how many seconds the request should timeout with an internally generated 408 response.
1318 94 Luci Stanescu
  This is is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1319 94 Luci Stanescu
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1320 99 Adrian Georgescu
1321 94 Luci Stanescu
 '''end'''(''self'')::
1322 94 Luci Stanescu
  Terminate the transaction, whichever state it is in, sending the appropriate notifications.
1323 94 Luci Stanescu
  Note that calling this method while in the {{{INIT}}} state does nothing.
1324 94 Luci Stanescu
1325 47 Ruud Klaver
==== attributes ====
1326 47 Ruud Klaver
1327 99 Adrian Georgescu
1328 62 Ruud Klaver
 '''expire_warning_time''' (class attribute)::
1329 47 Ruud Klaver
  The {{{SIPRequestWillExpire}}} notification will be sent halfway between the positive response and the actual expiration time, but at least this amount of seconds before.
1330 47 Ruud Klaver
  The default value is 30 seconds.
1331 99 Adrian Georgescu
1332 47 Ruud Klaver
 '''state'''::
1333 47 Ruud Klaver
  Indicates the state the {{{Request}}} object is in, in the form of a string.
1334 1 Adrian Georgescu
  Refer to the diagram above for possible states.
1335 1 Adrian Georgescu
  This attribute is read-only.
1336 99 Adrian Georgescu
1337 1 Adrian Georgescu
 '''method'''::
1338 1 Adrian Georgescu
  The method of the SIP request as a string.
1339 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1340 99 Adrian Georgescu
1341 94 Luci Stanescu
 '''from_header'''::
1342 94 Luci Stanescu
  The {{{FrozenFromHeader}}} object to put in the {{{From}}} header of the request.
1343 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1344 99 Adrian Georgescu
1345 94 Luci Stanescu
 '''to_header'''::
1346 94 Luci Stanescu
  The {{{FrozenToHeader}}} object to put in the {{{To}}} header of the request.
1347 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1348 99 Adrian Georgescu
1349 1 Adrian Georgescu
 '''request_uri'''::
1350 94 Luci Stanescu
  The SIP URI to put as request URI in the request, in the form of a {{{FrozenSIPURI}}} object.
1351 62 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1352 99 Adrian Georgescu
1353 94 Luci Stanescu
 '''route_header'''::
1354 94 Luci Stanescu
  Where to send the SIP request to, including IP, port and transport, in the form of a {{{FrozenRouteHeader}}} object.
1355 47 Ruud Klaver
  This will also be included in the {{{Route}}} header of the request.
1356 47 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1357 99 Adrian Georgescu
1358 47 Ruud Klaver
 '''credentials'''::
1359 94 Luci Stanescu
  The credentials to be used when challenged for authentication, represented by a {{{FrozenCredentials}}} object.
1360 47 Ruud Klaver
  If no credentials were supplied when the object was created this attribute is {{{None}}}.
1361 47 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1362 99 Adrian Georgescu
1363 94 Luci Stanescu
 '''contact_header'''::
1364 94 Luci Stanescu
  The {{{FrozenContactHeader}}} object to put in the {{{Contact}}} header of the request.
1365 1 Adrian Georgescu
  If this was not specified, this attribute is {{{None}}}.
1366 1 Adrian Georgescu
  It is set on instantiation and is read-only.
1367 99 Adrian Georgescu
1368 47 Ruud Klaver
 '''call_id'''::
1369 47 Ruud Klaver
  The {{{Call-ID}}} to be used for this transaction as a string.
1370 46 Ruud Klaver
  If no call id was specified on instantiation, this attribute contains the generated id.
1371 46 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1372 99 Adrian Georgescu
1373 62 Ruud Klaver
 '''cseq'''::
1374 48 Ruud Klaver
  The sequence number to use in the request as an int.
1375 48 Ruud Klaver
  If no sequence number was specified on instantiation, this attribute contains the generated sequence number.
1376 48 Ruud Klaver
  Note that this number may be increased by one if an authentication challenge is received and a {{{Credentials}}} object is given.
1377 48 Ruud Klaver
  This attribute is read-only.
1378 99 Adrian Georgescu
1379 48 Ruud Klaver
 '''extra_headers'''::
1380 94 Luci Stanescu
  Extra headers to include in the request as a frozenlist of header objects.
1381 48 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1382 99 Adrian Georgescu
1383 48 Ruud Klaver
 '''content_type'''::
1384 48 Ruud Klaver
  What string to put as content type in the {{{Content-Type}}} headers, if the request contains a body.
1385 57 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1386 48 Ruud Klaver
  It is set on instantiation and is read-only.
1387 99 Adrian Georgescu
1388 48 Ruud Klaver
 '''body'''::
1389 48 Ruud Klaver
  The body of the request as a string.
1390 46 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1391 49 Ruud Klaver
  It is set on instantiation and is read-only.
1392 99 Adrian Georgescu
1393 49 Ruud Klaver
 '''expires_in'''::
1394 49 Ruud Klaver
  This read-only property indicates in how many seconds from now this {{{Request}}} will expire, if it is in the {{{EXPIRING}}} state.
1395 49 Ruud Klaver
  If this is not the case, this property is 0.
1396 49 Ruud Klaver
1397 109 Adrian Georgescu
 '''peer_address'''::
1398 109 Adrian Georgescu
  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.
1399 109 Adrian Georgescu
1400 49 Ruud Klaver
==== notifications ====
1401 49 Ruud Klaver
1402 99 Adrian Georgescu
1403 49 Ruud Klaver
 '''SIPRequestGotProvisionalResponse'''::
1404 49 Ruud Klaver
  This notification will be sent on every provisional response received in reply to the sent request.
1405 49 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1406 49 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1407 49 Ruud Klaver
  [[BR]]''code'':[[BR]]
1408 49 Ruud Klaver
  The SIP response code of the received provisional response as an int, which will be in the 1xx range.
1409 49 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1410 49 Ruud Klaver
  The reason text string included with the SIP response code.
1411 49 Ruud Klaver
  [[BR]]''headers'':[[BR]]
1412 94 Luci Stanescu
  The headers included in the provisional response as a dict, the values of which are header objects.
1413 49 Ruud Klaver
  [[BR]]''body'':[[BR]]
1414 49 Ruud Klaver
  The body of the provisional response as a string, or {{{None}}} if there was no body.
1415 99 Adrian Georgescu
1416 49 Ruud Klaver
 '''SIPRequestDidSucceed'''::
1417 49 Ruud Klaver
  This notification will be sent when a positive final response was received in reply to the request.
1418 49 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1419 49 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1420 49 Ruud Klaver
  [[BR]]''code'':[[BR]]
1421 49 Ruud Klaver
  The SIP response code of the received positive final response as an int, which will be in the 2xx range.
1422 49 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1423 49 Ruud Klaver
  The reason text string included with the SIP response code.
1424 49 Ruud Klaver
  [[BR]]''headers'':[[BR]]
1425 94 Luci Stanescu
  The headers included in the positive final response as a dict, the values of which are header objects.
1426 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
1427 1 Adrian Georgescu
  The body of the positive final response as a string, or {{{None}}} if there was no body.
1428 1 Adrian Georgescu
  [[BR]]''expires'':[[BR]]
1429 1 Adrian Georgescu
  Indicates in how many seconds the {{{Request}}} will expire as an int.
1430 1 Adrian Georgescu
  If it does not expire and the {{{EXPIRING}}} state is skipped, this attribute is 0.
1431 99 Adrian Georgescu
1432 1 Adrian Georgescu
 '''SIPRequestDidFail'''::
1433 1 Adrian Georgescu
  This notification will be sent when a negative final response is received in reply to the request or if an internal error occurs.
1434 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1435 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1436 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
1437 1 Adrian Georgescu
  The SIP response code of the received negative final response as an int.
1438 1 Adrian Georgescu
  This could also be a response code generated by PJSIP internally, or 0 when an internal error occurs.
1439 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1440 1 Adrian Georgescu
  The reason text string included with the SIP response code or error.
1441 1 Adrian Georgescu
  [[BR]]''headers'': (only if a negative final response was received)[[BR]]
1442 94 Luci Stanescu
  The headers included in the negative final response as a dict, the values of which are header objects, if this is what triggered the notification.
1443 1 Adrian Georgescu
  [[BR]]''body'': (only if a negative final response was received)[[BR]]
1444 1 Adrian Georgescu
  The body of the negative final response as a string, or {{{None}}} if there was no body.
1445 1 Adrian Georgescu
  This attribute is absent if no response was received.
1446 99 Adrian Georgescu
1447 1 Adrian Georgescu
 '''SIPRequestWillExpire'''::
1448 1 Adrian Georgescu
  This notification will be sent when a {{{Request}}} in the {{{EXPIRING}}} state will expire soon.
1449 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1450 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1451 1 Adrian Georgescu
  [[BR]]''expires'':[[BR]]
1452 1 Adrian Georgescu
  An int indicating in how many seconds from now the {{{Request}}} will actually expire.
1453 99 Adrian Georgescu
1454 1 Adrian Georgescu
 '''SIPRequestDidEnd'''::
1455 1 Adrian Georgescu
  This notification will be sent when a {{{Request}}} object enters the {{{TERMINATED}}} state and can no longer be used.
1456 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1457 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1458 1 Adrian Georgescu
1459 94 Luci Stanescu
=== IncomingRequest ===
1460 94 Luci Stanescu
1461 94 Luci Stanescu
This is a relatively simple object that can manage responding to incoming requests in a single transaction.
1462 94 Luci Stanescu
For this reason it does not handle requests that create a dialog.
1463 94 Luci Stanescu
To register methods for which requests should be formed into an {{{IncomingRequest}}} object, the application should set the {{{incoming_requests}}} set attribute on the {{{Engine}}}.
1464 94 Luci Stanescu
Receiving {{{INVITE}}}, {{{SUBSCRIBE}}}, {{{ACK}}} and {{{BYE}}} through this object is not supported.
1465 94 Luci Stanescu
1466 94 Luci Stanescu
The application is notified of an incoming request through the {{{SIPIncomingRequestGotRequest}}} notification.
1467 94 Luci Stanescu
It can answer this request by calling the {{{answer}}} method on the sender of this notification.
1468 94 Luci Stanescu
Note that if the {{{IncomingRequest}}} object gets destroyed before it is answered, a 500 response is automatically sent.
1469 94 Luci Stanescu
1470 94 Luci Stanescu
==== attributes ====
1471 94 Luci Stanescu
1472 99 Adrian Georgescu
1473 94 Luci Stanescu
 '''state'''::
1474 94 Luci Stanescu
  This read-only attribute indicates the state the object is in.
1475 94 Luci Stanescu
  This can be {{{None}}} if the object was created by the application, essentially meaning the object is inert, {{{"incoming"}}} or {{{"answered"}}}.
1476 94 Luci Stanescu
1477 94 Luci Stanescu
==== methods ====
1478 94 Luci Stanescu
1479 99 Adrian Georgescu
1480 94 Luci Stanescu
 '''answer'''(''self'', '''code''', '''reason'''={{{None}}}, '''extra_headers'''={{{None}}})::
1481 94 Luci Stanescu
  Reply to the received request with a final response.
1482 94 Luci Stanescu
  [[BR]]''code'':[[BR]]
1483 94 Luci Stanescu
  The SIP response code to send.
1484 94 Luci Stanescu
  This should be 200 or higher.
1485 94 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1486 94 Luci Stanescu
  The reason text to include in the response.
1487 94 Luci Stanescu
  If this is {{{None}}}, the default text for the given response code is used.
1488 94 Luci Stanescu
  [[BR]]''extra_headers'':[[BR]]
1489 94 Luci Stanescu
  The extra headers to include in the response as an iterable of header objects.
1490 94 Luci Stanescu
1491 94 Luci Stanescu
==== notifications ====
1492 94 Luci Stanescu
1493 99 Adrian Georgescu
1494 94 Luci Stanescu
 '''SIPIncomingRequestGotRequest'''::
1495 94 Luci Stanescu
  This notification will be sent when a new {{{IncomingRequest}}} is created as result of a received request.
1496 94 Luci Stanescu
  The application should listen for this notification, retain a reference to the object that sent it and answer it.
1497 94 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1498 94 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1499 94 Luci Stanescu
  [[BR]]''method'':[[BR]]
1500 94 Luci Stanescu
  The method of the SIP request as a string.
1501 94 Luci Stanescu
  [[BR]]''request_uri'':[[BR]]
1502 94 Luci Stanescu
  The request URI of the request as a {{{FrozenSIPURI}}} object.
1503 94 Luci Stanescu
  [[BR]]''headers'':[[BR]]
1504 94 Luci Stanescu
  The headers of the request as a dict, the values of which are the relevant header objects.
1505 94 Luci Stanescu
  [[BR]]''body'':[[BR]]
1506 94 Luci Stanescu
  The body of the request as a string, or {{{None}}} if no body was included.
1507 99 Adrian Georgescu
1508 94 Luci Stanescu
 '''SIPIncomingRequestSentResponse'''::
1509 94 Luci Stanescu
  This notification is sent when a response to the request is sent by the object.
1510 94 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1511 94 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1512 94 Luci Stanescu
  [[BR]]''code'':[[BR]]
1513 94 Luci Stanescu
  The code of the SIP response as an int.
1514 94 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1515 94 Luci Stanescu
  The reason text of the SIP response as an int.
1516 94 Luci Stanescu
  [[BR]]''headers'':[[BR]]
1517 94 Luci Stanescu
  The headers of the response as a dict, the values of which are the relevant header objects.
1518 94 Luci Stanescu
  [[BR]]''body'':[[BR]]
1519 94 Luci Stanescu
  This will be {{{None}}}.
1520 94 Luci Stanescu
1521 51 Ruud Klaver
=== Message ===
1522 1 Adrian Georgescu
1523 94 Luci Stanescu
The {{{Message}}} class is a simple wrapper for the {{{Request}}} class, with the purpose of sending {{{MESSAGE}}} requests, as described in [http://tools.ietf.org/html/rfc3428 RFC 3428].
1524 51 Ruud Klaver
It is a one-shot object that manages only one {{{Request}}} object.
1525 51 Ruud Klaver
1526 94 Luci Stanescu
==== methods ====
1527 94 Luci Stanescu
1528 99 Adrian Georgescu
1529 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''to_header''', '''route_header''', '''content_type''', '''body''', '''credentials'''={{{None}}}, '''extra_headers'''={{{[]}}})::
1530 94 Luci Stanescu
  Creates a new {{{Message}}} object with the specified arguments.
1531 94 Luci Stanescu
  These arguments are documented in the attributes section for this class.
1532 99 Adrian Georgescu
1533 94 Luci Stanescu
 '''send'''(''self'', '''timeout'''={{{None}}})::
1534 94 Luci Stanescu
  Send the {{{MESSAGE}}} request to the remote party.
1535 94 Luci Stanescu
  [[BR]]''timeout'':[[BR]]
1536 94 Luci Stanescu
  This argument as the same meaning as it does for {{{Request.send()}}}.
1537 99 Adrian Georgescu
1538 94 Luci Stanescu
 '''end'''(''self'')::
1539 94 Luci Stanescu
  Stop trying to send the {{{MESSAGE}}} request.
1540 94 Luci Stanescu
  If it was not sent yet, calling this method does nothing.
1541 94 Luci Stanescu
1542 1 Adrian Georgescu
==== attributes ====
1543 1 Adrian Georgescu
1544 99 Adrian Georgescu
1545 94 Luci Stanescu
 '''from_header'''::
1546 94 Luci Stanescu
  The {{{FrozenFromHeader}}} to put in the {{{From}}} header of the {{{MESSAGE}}} request.
1547 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1548 99 Adrian Georgescu
1549 94 Luci Stanescu
 '''to_header'''::
1550 94 Luci Stanescu
  The {{{FrozenToHeader}}} to put in the {{{To}}} header of the {{{MESSAGE}}} request.
1551 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1552 99 Adrian Georgescu
1553 94 Luci Stanescu
 '''route_header'''::
1554 94 Luci Stanescu
  Where to send the {{{MESSAGE}}} request to, including IP, port and transport, in the form of a {{{FrozenRouteHeader}}} object.
1555 1 Adrian Georgescu
  This will also be included in the {{{Route}}} header of the request.
1556 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1557 99 Adrian Georgescu
1558 1 Adrian Georgescu
 '''content_type'''::
1559 1 Adrian Georgescu
  What string to put as content type in the {{{Content-Type}}} headers.
1560 1 Adrian Georgescu
  It is set on instantiation and is read-only.
1561 99 Adrian Georgescu
1562 1 Adrian Georgescu
 '''body'''::
1563 1 Adrian Georgescu
  The body of the {{{MESSAGE}}} request as a string.
1564 52 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1565 52 Ruud Klaver
  It is set on instantiation and is read-only.
1566 99 Adrian Georgescu
1567 52 Ruud Klaver
 '''credentials'''::
1568 94 Luci Stanescu
  The credentials to be used when challenged for authentication, represented by a {{{FrozenCredentials}}} object.
1569 52 Ruud Klaver
  If no credentials were specified, this attribute is {{{None}}}.
1570 52 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1571 99 Adrian Georgescu
1572 1 Adrian Georgescu
 '''is_sent'''::
1573 1 Adrian Georgescu
  A boolean read-only property indicating if the {{{MESSAGE}}} request was sent.
1574 99 Adrian Georgescu
1575 1 Adrian Georgescu
 '''in_progress'''::
1576 52 Ruud Klaver
  A boolean read-only property indicating if the object is waiting for the response from the remote party.
1577 52 Ruud Klaver
1578 109 Adrian Georgescu
 '''peer_address'''::
1579 109 Adrian Georgescu
  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.
1580 109 Adrian Georgescu
1581 52 Ruud Klaver
==== notifications ====
1582 52 Ruud Klaver
1583 99 Adrian Georgescu
1584 52 Ruud Klaver
 '''SIPMessageDidSucceed'''::
1585 52 Ruud Klaver
  This notification will be sent when the remote party acknowledged the reception of the {{{MESSAGE}}} request.
1586 52 Ruud Klaver
  It has not data attributes.
1587 99 Adrian Georgescu
1588 52 Ruud Klaver
 '''SIPMessageDidFail'''::
1589 52 Ruud Klaver
  This notification will be sent when transmission of the {{{MESSAGE}}} request fails for whatever reason.
1590 52 Ruud Klaver
  [[BR]]''code'':[[BR]]
1591 52 Ruud Klaver
  An int indicating the SIP or internal PJSIP code that was given in response to the {{{MESSAGE}}} request.
1592 1 Adrian Georgescu
  This is 0 if the failure is caused by an internal error.
1593 58 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1594 1 Adrian Georgescu
  A status string describing the failure, either taken from the SIP response or the internal error.
1595 52 Ruud Klaver
1596 52 Ruud Klaver
=== Registration ===
1597 52 Ruud Klaver
1598 94 Luci Stanescu
The {{{Registration}}} class wraps a series of {{{Request}}} objects, managing the registration of a particular contact URI at a SIP registrar through the sending of {{{REGISTER}}} requests.
1599 86 Ruud Klaver
For details, see [http://tools.ietf.org/html/rfc3261 RFC 3261].
1600 1 Adrian Georgescu
This object is designed in such a way that it will not initiate sending a refreshing {{{REGISTER}}} itself, rather it will inform the application that a registration is about to expire.
1601 1 Adrian Georgescu
The application should then perform a DNS lookup to find the relevant SIP registrar and call the {{{register()}}} method on this object.
1602 52 Ruud Klaver
1603 52 Ruud Klaver
==== methods ====
1604 52 Ruud Klaver
1605 99 Adrian Georgescu
1606 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''credentials'''={{{None}}}, '''duration'''=300)::
1607 52 Ruud Klaver
  Creates a new {{{Registration}}} object with the specified arguments.
1608 52 Ruud Klaver
  These arguments are documented in the attributes section for this class.
1609 99 Adrian Georgescu
1610 94 Luci Stanescu
 '''register'''(''self'', '''contact_header''', '''route_header''', '''timeout'''={{{None}}})::
1611 52 Ruud Klaver
  Calling this method will attempt to send a new {{{REGISTER}}} request to the registrar provided, whatever state the object is in.
1612 52 Ruud Klaver
  If the object is currently busy sending a {{{REGISTER}}}, this request will be preempted for the new one.
1613 52 Ruud Klaver
  Once sent, the {{{Registration}}} object will send either a {{{SIPRegistrationDidSucceed}}} or a {{{SIPRegistrationDidFail}}} notification.
1614 94 Luci Stanescu
  The {{{contact_header}}} argument is mentioned in the attributes section of this class.
1615 94 Luci Stanescu
  The {{{route_header}}} argument specifies the IP address, port and transport of the SIP registrar in the form of a {{{RouteHeader}}} object and {{{timeout}}} has the same meaning as it does for {{{Request.send()}}}.
1616 99 Adrian Georgescu
1617 1 Adrian Georgescu
 '''end'''(''self'', '''timeout'''={{{None}}})::
1618 1 Adrian Georgescu
  Calling this method while the object is registered will attempt to send a {{{REGISTER}}} request with the {{{Expires}}} headers set to 0, effectively unregistering the contact URI at the registrar.
1619 94 Luci Stanescu
  The {{{RouteHeader}}} used for this will be the same as the last successfully sent {{{REGISTER}}} request.
1620 1 Adrian Georgescu
  If another {{{REGISTER}}} is currently being sent, it will be preempted.
1621 1 Adrian Georgescu
  When the unregistering {{{REGISTER}}} request is sent, a {{{SIPRegistrationWillEnd}}} notification is sent.
1622 1 Adrian Georgescu
  After this, either a {{{SIPRegistrationDidEnd}}} with the {{{expired}}} data attribute set to {{{False}}} will be sent, indicating a successful unregister, or a {{{SIPRegistrationDidNotEnd}}} notification is sent if unregistering fails for some reason.
1623 1 Adrian Georgescu
  Calling this method when the object is not registered will do nothing.
1624 1 Adrian Georgescu
  The {{{timeout}}} argument has the same meaning as for the {{{register()}}} method.
1625 1 Adrian Georgescu
1626 94 Luci Stanescu
==== attributes ====
1627 94 Luci Stanescu
1628 99 Adrian Georgescu
1629 94 Luci Stanescu
 '''from_header''::
1630 94 Luci Stanescu
  The {{{(Frozen)FromHeader}}} the {{{Registration}}} was sent with.
1631 99 Adrian Georgescu
1632 94 Luci Stanescu
 '''credentials'''::
1633 94 Luci Stanescu
  The credentials to be used when challenged for authentication by the registrar, represented by a {{{(Frozen)Credentials}}} object. 
1634 94 Luci Stanescu
  This attribute is set at instantiation, can be {{{None}}} if it was not specified and can be updated to be used for the next {{{REGISTER}}} request.
1635 94 Luci Stanescu
  Note that, in contrast to other classes mentioned in this document, the {{{Registration}}} class does not make a copy of the {{{Credentials}}} object on instantiation, but instead retains a reference to it.
1636 99 Adrian Georgescu
1637 94 Luci Stanescu
 '''duration'''::
1638 94 Luci Stanescu
  The amount of time in seconds to request the registration for at the registrar.
1639 94 Luci Stanescu
  This attribute is set at object instantiation and can be updated for subsequent {{{REGISTER}}} requests.
1640 99 Adrian Georgescu
1641 94 Luci Stanescu
 '''is_registered'''::
1642 94 Luci Stanescu
  A boolean read-only property indicating if this object is currently registered.
1643 99 Adrian Georgescu
1644 94 Luci Stanescu
 '''contact_header'''::
1645 94 Luci Stanescu
  If the {{{Registration}}} object is registered, this attribute contains the latest contact header that was sent to the registrar as a {{{FrozenContactHeader}}} object.
1646 94 Luci Stanescu
  Otherwise, this attribute is {{{None}}}
1647 99 Adrian Georgescu
1648 94 Luci Stanescu
 '''expires_in'''::
1649 94 Luci Stanescu
  If registered, this read-only property indicates in how many seconds from now this {{{Registration}}} will expire.
1650 94 Luci Stanescu
  If this is not the case, this property is 0.
1651 94 Luci Stanescu
1652 109 Adrian Georgescu
 '''peer_address'''::
1653 109 Adrian Georgescu
  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.
1654 109 Adrian Georgescu
1655 69 Ruud Klaver
==== notifications ====
1656 69 Ruud Klaver
1657 99 Adrian Georgescu
1658 69 Ruud Klaver
 '''SIPRegistrationDidSucceed'''::
1659 69 Ruud Klaver
  This notification will be sent when the {{{register()}}} method was called and the registration succeeded.
1660 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1661 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1662 69 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1663 1 Adrian Georgescu
  The reason string received from the SIP registrar.
1664 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1665 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{register()}}} method.
1666 94 Luci Stanescu
  [[BR]]''contact_header'':[[BR]]
1667 94 Luci Stanescu
  The contact header that was sent to the registrar as a {{{FrozenContactHeader}}} object.
1668 94 Luci Stanescu
  [[BR]]''contact_header_list'':[[BR]]
1669 94 Luci Stanescu
  A full list of contact headers that are registered for this SIP account, including the one used for this registration.
1670 94 Luci Stanescu
  The format of this data attribute is a list of FrozenContactHeader objects.
1671 1 Adrian Georgescu
  [[BR]]''expires_in'':[[BR]]
1672 69 Ruud Klaver
  The number of seconds before this registration expires
1673 99 Adrian Georgescu
1674 69 Ruud Klaver
 '''SIPRegistrationDidFail'''::
1675 69 Ruud Klaver
  This notification will be sent when the {{{register()}}} method was called and the registration failed, for whatever reason.
1676 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1677 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1678 69 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1679 69 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1680 69 Ruud Klaver
  The reason string received from the SIP registrar or the error string.
1681 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1682 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{register()}}} method.
1683 99 Adrian Georgescu
1684 69 Ruud Klaver
 '''SIPRegistrationWillExpire'''::
1685 1 Adrian Georgescu
  This notification will be sent when a registration will expire soon.
1686 69 Ruud Klaver
  It should be used as an indication to re-perform DNS lookup of the registrar and call the {{{register()}}} method.
1687 69 Ruud Klaver
  [[BR]]''expires'':[[BR]]
1688 69 Ruud Klaver
  The number of seconds in which the registration will expire.
1689 99 Adrian Georgescu
1690 69 Ruud Klaver
 '''SIPRegistrationWillEnd'''::
1691 69 Ruud Klaver
  Will be sent whenever the {{{end()}}} method was called and an unregistering {{{REGISTER}}} is sent.
1692 99 Adrian Georgescu
1693 69 Ruud Klaver
 '''SIPRegistrationDidNotEnd'''::
1694 69 Ruud Klaver
  This notification will be sent when the unregistering {{{REGISTER}}} request failed for some reason.
1695 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1696 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1697 69 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1698 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1699 1 Adrian Georgescu
  The reason string received from the SIP registrar or the error string.
1700 99 Adrian Georgescu
1701 1 Adrian Georgescu
 '''SIPRegistrationDidEnd'''::
1702 69 Ruud Klaver
  This notification will be sent when a {{{Registration}}} has become unregistered.
1703 69 Ruud Klaver
  [[BR]]''expired'':[[BR]]
1704 69 Ruud Klaver
  This boolean indicates if the object is unregistered because the registration expired, in which case it will be set to {{{True}}}.
1705 69 Ruud Klaver
  If this data attribute is {{{False}}}, it means that unregistration was explicitly requested through the {{{end()}}} method.
1706 69 Ruud Klaver
1707 69 Ruud Klaver
==== example code ====
1708 69 Ruud Klaver
1709 69 Ruud Klaver
For an example on how to use this object, see the Integration section.
1710 69 Ruud Klaver
1711 69 Ruud Klaver
=== Publication ===
1712 69 Ruud Klaver
1713 69 Ruud Klaver
Publication of SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3903 RFC 3903]. 
1714 69 Ruud Klaver
{{{PUBLISH}}} is similar to {{{REGISTER}}} in that it allows a user to create, modify, and remove state in another entity which manages this state on behalf of the user.
1715 69 Ruud Klaver
1716 69 Ruud Klaver
A {{{Publication}}} object represents publishing some content for a particular SIP account and a particular event type at the SIP presence agent through a series of {{{PUBLISH}}} request.
1717 69 Ruud Klaver
This object is similar in behaviour to the {{{Registration}}} object, as it is also based on a sequence of {{{Request}}} objects.
1718 69 Ruud Klaver
As with this other object, the {{{Publication}}} object will notify the application when a published item is about to expire and it is the applications responsibility to perform a DNS lookup and call the {{{publish()}}} method in order to send the {{{PUBLISH}}} request.
1719 69 Ruud Klaver
1720 69 Ruud Klaver
==== methods ====
1721 69 Ruud Klaver
1722 99 Adrian Georgescu
1723 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''event''', '''content_type''', '''credentials'''={{{None}}}, '''duration'''=300)::
1724 69 Ruud Klaver
  Creates a new {{{Publication}}} object with the specified arguments.
1725 69 Ruud Klaver
  These arguments are documented in the attributes section for this class.
1726 99 Adrian Georgescu
1727 94 Luci Stanescu
 '''publish'''(''self'', '''body''', '''route_header''', '''timeout'''={{{None}}})::
1728 69 Ruud Klaver
  Send an actual {{{PUBLISH}}} request to the specified presence agent.
1729 69 Ruud Klaver
  [[BR]]''body'':[[BR]]
1730 69 Ruud Klaver
  The body to place in the {{{PUBLISH}}} request as a string.
1731 69 Ruud Klaver
  This body needs to be of the content type specified at object creation.
1732 69 Ruud Klaver
  For the initial request, a body will need to be specified.
1733 69 Ruud Klaver
  For subsequent refreshing {{{PUBLISH}}} requests, the body can be {{{None}}} to indicate that the last published body should be refreshed.
1734 69 Ruud Klaver
  If there was an ETag error with the previous refreshing {{{PUBLISH}}}, calling this method with a body of {{{None}}} will throw a {{{PublicationError}}}.
1735 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1736 94 Luci Stanescu
  The host where the request should be sent to in the form of a {{{(Frozen)RouteHeader}}} object.
1737 69 Ruud Klaver
  [[BR]]''timeout'':[[BR]]
1738 69 Ruud Klaver
  This can be either an int or a float, indicating in how many seconds the {{{SUBSCRIBE}}} request should timeout with an internally generated 408 response.
1739 69 Ruud Klaver
  This is is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1740 69 Ruud Klaver
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1741 99 Adrian Georgescu
1742 69 Ruud Klaver
 '''end'''(''self'', '''timeout'''={{{None}}})::
1743 1 Adrian Georgescu
  End the publication by sending a {{{PUBLISH}}} request with an {{{Expires}}} header of 0.
1744 86 Ruud Klaver
  If the object is not published, this will result in a {{{PublicationError}}} being thrown.
1745 86 Ruud Klaver
  [[BR]]''timeout'':[[BR]]
1746 86 Ruud Klaver
  The meaning of this argument is the same as it is for the {{{publish()}}} method.
1747 86 Ruud Klaver
1748 94 Luci Stanescu
==== attributes ====
1749 94 Luci Stanescu
1750 99 Adrian Georgescu
1751 94 Luci Stanescu
 '''from_header''::
1752 94 Luci Stanescu
  The {{{(Frozen)FromHeader}}} the {{{Publication}}} was sent with.
1753 99 Adrian Georgescu
1754 94 Luci Stanescu
 '''event''::
1755 94 Luci Stanescu
  The name of the event this object is publishing for the specified SIP URI, as a string.
1756 99 Adrian Georgescu
1757 94 Luci Stanescu
 '''content_type''::
1758 94 Luci Stanescu
  The {{{Content-Type}}} of the body that will be in the {{{PUBLISH}}} requests.
1759 94 Luci Stanescu
  Typically this will remain the same throughout the publication session, but the attribute may be updated by the application if needed.
1760 94 Luci Stanescu
  Note that this attribute needs to be in the typical MIME type form, containing a "/" character.
1761 99 Adrian Georgescu
1762 94 Luci Stanescu
 '''credentials'''::
1763 94 Luci Stanescu
  The credentials to be used when challenged for authentication by the presence agent, represented by a {{{(Frozen)Credentials}}} object. 
1764 94 Luci Stanescu
  This attribute is set at instantiation, can be {{{None}}} if it was not specified and can be updated to be used for the next {{{PUBLISH}}} request.
1765 94 Luci Stanescu
  Note that, in contrast to most other classes mentioned in this document, the {{{Publication}}} class does not make a copy of the {{{(Frozen)Credentials}}} object on instantiation, but instead retains a reference to it.
1766 99 Adrian Georgescu
1767 94 Luci Stanescu
 '''duration'''::
1768 94 Luci Stanescu
  The amount of time in seconds that the publication should be valid for.
1769 94 Luci Stanescu
  This attribute is set at object instantiation and can be updated for subsequent {{{PUBLISH}}} requests.
1770 99 Adrian Georgescu
1771 94 Luci Stanescu
 '''is_published'''::
1772 94 Luci Stanescu
  A boolean read-only property indicating if this object is currently published.
1773 99 Adrian Georgescu
1774 94 Luci Stanescu
 '''expires_in'''::
1775 94 Luci Stanescu
  If published, this read-only property indicates in how many seconds from now this {{{Publication}}} will expire.
1776 94 Luci Stanescu
  If this is not the case, this property is 0.
1777 94 Luci Stanescu
1778 109 Adrian Georgescu
 '''peer_address'''::
1779 109 Adrian Georgescu
  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.
1780 109 Adrian Georgescu
1781 86 Ruud Klaver
==== notifications ====
1782 86 Ruud Klaver
1783 99 Adrian Georgescu
1784 86 Ruud Klaver
 '''SIPPublicationDidSucceed'''::
1785 86 Ruud Klaver
  This notification will be sent when the {{{publish()}}} method was called and the publication succeeded.
1786 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1787 86 Ruud Klaver
  The SIP response code as received from the SIP presence agent as an int.
1788 86 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1789 86 Ruud Klaver
  The reason string received from the SIP presence agent.
1790 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1791 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{publish()}}} method.
1792 86 Ruud Klaver
  [[BR]]''expires_in'':[[BR]]
1793 86 Ruud Klaver
  The number of seconds before this publication expires
1794 99 Adrian Georgescu
1795 86 Ruud Klaver
 '''SIPPublicationDidFail'''::
1796 86 Ruud Klaver
  This notification will be sent when the {{{publish()}}} method was called and the publication failed, for whatever reason.
1797 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1798 86 Ruud Klaver
  The SIP response code as received from the presence agent as an int.
1799 86 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1800 86 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1801 86 Ruud Klaver
  The reason string received from the presence agent or the error string.
1802 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1803 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{publish()}}} method.
1804 99 Adrian Georgescu
1805 86 Ruud Klaver
 '''SIPPublicationWillExpire'''::
1806 86 Ruud Klaver
  This notification will be sent when a publication will expire soon.
1807 86 Ruud Klaver
  It should be used as an indication to re-perform DNS lookup of the presence agent and call the {{{publish()}}} method.
1808 86 Ruud Klaver
  [[BR]]''expires'':[[BR]]
1809 86 Ruud Klaver
  The number of seconds in which the publication will expire.
1810 99 Adrian Georgescu
1811 86 Ruud Klaver
 '''SIPPublicationWillEnd'''::
1812 86 Ruud Klaver
  Will be sent whenever the {{{end()}}} method was called and an unpublishing {{{PUBLISH}}} is sent.
1813 99 Adrian Georgescu
1814 86 Ruud Klaver
 '''SIPPublicationDidNotEnd'''::
1815 86 Ruud Klaver
  This notification will be sent when the unpublishing {{{PUBLISH}}} request failed for some reason.
1816 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1817 1 Adrian Georgescu
  The SIP response code as received from the presence agent as an int.
1818 1 Adrian Georgescu
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1819 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1820 1 Adrian Georgescu
  The reason string received from the presence agent or the error string.
1821 99 Adrian Georgescu
1822 59 Ruud Klaver
 '''SIPPublicationDidEnd'''::
1823 1 Adrian Georgescu
  This notification will be sent when a {{{Publication}}} has become unpublished.
1824 1 Adrian Georgescu
  [[BR]]''expired'':[[BR]]
1825 1 Adrian Georgescu
  This boolean indicates if the object is unpublished because the publication expired, in which case it will be set to {{{True}}}.
1826 1 Adrian Georgescu
  If this data attribute is {{{False}}}, it means that unpublication was explicitly requested through the {{{end()}}} method.
1827 1 Adrian Georgescu
1828 59 Ruud Klaver
=== Subscription ===
1829 59 Ruud Klaver
1830 1 Adrian Georgescu
Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856].
1831 1 Adrian Georgescu
1832 1 Adrian Georgescu
This SIP primitive class represents a subscription to a specific event type of a particular SIP URI.
1833 1 Adrian Georgescu
This means that the application should instance this class for each combination of event and SIP URI that it wishes to subscribe to.
1834 1 Adrian Georgescu
The event type and the content types that are acceptable for it need to be registered first, either through the {{{init_options}}} attribute of {{{Engine}}} (before starting it), or by calling the {{{add_event()}}} method of the {{{Engine}}} instance.
1835 1 Adrian Georgescu
Whenever a {{{NOTIFY}}} is received, the application will receive the {{{SIPSubscriptionGotNotify}}} event.
1836 59 Ruud Klaver
1837 59 Ruud Klaver
Internally a {{{Subscription}}} object has a state machine, which reflects the state of the subscription.
1838 1 Adrian Georgescu
It is a direct mirror of the state machine of the underlying {{{pjsip_evsub}}} object, whose possible states are at least {{{NULL}}}, {{{SENT}}}, {{{ACCEPTED}}}, {{{PENDING}}}, {{{ACTIVE}}} or {{{TERMINATED}}}.
1839 1 Adrian Georgescu
The last three states are directly copied from the contents of the {{{Subscription-State}}} header of the received {{{NOTIFY}}} request.
1840 71 Adrian Georgescu
Also, the state can be an arbitrary string if the contents of the {{{Subscription-State}}} header are not one of the three above.
1841 1 Adrian Georgescu
The state of the object is presented in the {{{state}}} attribute and changes of the state are indicated by means of the {{{SIPSubscriptionChangedState}}} notification.
1842 59 Ruud Klaver
This notification is only informational, an application using this object should take actions based on the other notifications sent by this object.
1843 1 Adrian Georgescu
1844 1 Adrian Georgescu
==== methods ====
1845 1 Adrian Georgescu
1846 99 Adrian Georgescu
1847 110 Adrian Georgescu
 '''!__init!__'''(''self'', '''request_uri''', '''from_header''', '''to_header''', '''contact_header, '''event''', '''route_header''', '''credentials'''={{{None}}}, '''refresh'''=300)::
1848 1 Adrian Georgescu
  Creates a new {{{Subscription}}} object which will be in the {{{NULL}}} state.
1849 1 Adrian Georgescu
  The arguments for this method are documented in the attributes section above.
1850 99 Adrian Georgescu
1851 1 Adrian Georgescu
 '''subscribe'''(''self'', '''extra_headers'''={{{None}}}, '''content_type'''={{{None}}}, '''body'''={{{None}}}, '''timeout'''={{{None}}})::
1852 1 Adrian Georgescu
  Calling this method triggers sending a {{{SUBSCRIBE}}} request to the presence agent.
1853 1 Adrian Georgescu
  The arguments passed will be stored and used for subsequent refreshing {{{SUBSCRIBE}}} requests.
1854 1 Adrian Georgescu
  This method may be used both to send the initial request and to update the arguments while the subscription is ongoing.
1855 1 Adrian Georgescu
  It may not be called when the object is in the {{{TERMINATED}}} state.
1856 1 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
1857 1 Adrian Georgescu
  A dictionary of additional headers to include in the {{{SUBSCRIBE}}} requests.
1858 1 Adrian Georgescu
  [[BR]]''content_type'':[[BR]]
1859 1 Adrian Georgescu
  The {{{Content-Type}}} of the supplied {{{body}}} argument as a string.
1860 1 Adrian Georgescu
  If this argument is supplied, the {{{body}}} argument cannot be {{{None}}}.
1861 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
1862 1 Adrian Georgescu
  The optional body to include in the {{{SUBSCRIBE}}} request as a string.
1863 1 Adrian Georgescu
  If this argument is supplied, the {{{content_type}}} argument cannot be {{{None}}}.
1864 1 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
1865 1 Adrian Georgescu
  This can be either an int or a float, indicating in how many seconds the request should timeout with an internally generated 408 response.
1866 1 Adrian Georgescu
  If this is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1867 1 Adrian Georgescu
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1868 99 Adrian Georgescu
1869 1 Adrian Georgescu
 '''end'''(''self'', '''timeout'''={{{None}}})::
1870 1 Adrian Georgescu
  This will end the subscription by sending a {{{SUBSCRIBE}}} request with an {{{Expires}}} value of 0.
1871 1 Adrian Georgescu
  If this object is no longer subscribed, this method will return without performing any action.
1872 1 Adrian Georgescu
  This method cannot be called when the object is in the {{{NULL}}} state.
1873 1 Adrian Georgescu
  The {{{timeout}}} argument has the same meaning as it does for the {{{subscribe()}}} method.
1874 59 Ruud Klaver
1875 95 Luci Stanescu
==== attributes ====
1876 95 Luci Stanescu
1877 99 Adrian Georgescu
1878 95 Luci Stanescu
 '''state'''::
1879 95 Luci Stanescu
  Indicates which state the internal state machine is in.
1880 95 Luci Stanescu
  See the previous section for a list of states the state machine can be in.
1881 99 Adrian Georgescu
1882 95 Luci Stanescu
 '''from_header'''::
1883 1 Adrian Georgescu
  The {{{FrozenFromHeader}}} to be put in the {{{From}}} header of the {{{SUBSCRIBE}}} requests.
1884 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1885 1 Adrian Georgescu
1886 1 Adrian Georgescu
 '''to_header'''::
1887 1 Adrian Georgescu
  The {{{FrozenToHeader}}} that is the target for the subscription.
1888 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1889 1 Adrian Georgescu
1890 95 Luci Stanescu
 '''contact_header'''::
1891 1 Adrian Georgescu
  The {{{FrozenContactHeader}}} to be put in the {{{Contact}}} header of the {{{SUBSCRIBE}}} requests.
1892 99 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1893 95 Luci Stanescu
1894 1 Adrian Georgescu
 '''event'''::
1895 1 Adrian Georgescu
  The event package for which the subscription is as a string.
1896 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1897 1 Adrian Georgescu
1898 1 Adrian Georgescu
 '''route_header'''::
1899 1 Adrian Georgescu
  The outbound proxy to use in the form of a {{{FrozenRouteHeader}}} object.
1900 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1901 1 Adrian Georgescu
1902 1 Adrian Georgescu
 '''credentials'''::
1903 1 Adrian Georgescu
  The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{FrozenCredentials}}} object.
1904 1 Adrian Georgescu
  If none was specified when creating the {{{Subscription}}} object, this attribute is {{{None}}}.
1905 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1906 1 Adrian Georgescu
1907 1 Adrian Georgescu
 '''refresh'''::
1908 1 Adrian Georgescu
  The refresh interval in seconds that was requested on object instantiation as an int.
1909 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1910 1 Adrian Georgescu
1911 1 Adrian Georgescu
 '''extra_headers'''::
1912 1 Adrian Georgescu
  This contains the {{{frozenlist}}} of extra headers that was last passed to a successful call to the {{{subscribe()}}} method.
1913 1 Adrian Georgescu
  If the argument was not provided, this attribute is an empty list.
1914 1 Adrian Georgescu
  This attribute is read-only.
1915 95 Luci Stanescu
1916 1 Adrian Georgescu
 '''content_type'''::
1917 1 Adrian Georgescu
  This attribute contains the {{{Content-Type}}} of the body that was last passed to a successful call to the {{{subscribe()}}} method.
1918 1 Adrian Georgescu
  If the argument was not provided, this attribute is {{{None}}}.
1919 95 Luci Stanescu
1920 1 Adrian Georgescu
 '''body'''::
1921 1 Adrian Georgescu
  This attribute contains the {{{body}}} string argument that was last passed to a successful call to the {{{subscribe()}}} method.
1922 99 Adrian Georgescu
  If the argument was not provided, this attribute is {{{None}}}.
1923 1 Adrian Georgescu
1924 109 Adrian Georgescu
 '''peer_address'''::
1925 109 Adrian Georgescu
  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.
1926 109 Adrian Georgescu
1927 1 Adrian Georgescu
==== notifications ====
1928 1 Adrian Georgescu
1929 1 Adrian Georgescu
1930 95 Luci Stanescu
 '''SIPSubscriptionChangedState'''::
1931 95 Luci Stanescu
  This notification will be sent every time the internal state machine of a {{{Subscription}}} object changes state.
1932 95 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1933 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1934 1 Adrian Georgescu
  [[BR]]''prev_state'':[[BR]]
1935 1 Adrian Georgescu
  The previous state that the sate machine was in.
1936 1 Adrian Georgescu
  [[BR]]''state'':[[BR]]
1937 99 Adrian Georgescu
  The new state the state machine moved into.
1938 1 Adrian Georgescu
1939 1 Adrian Georgescu
 '''SIPSubscriptionWillStart'''::
1940 1 Adrian Georgescu
  This notification will be emitted when the initial {{{SUBSCRIBE}}} request is sent.
1941 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1942 95 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1943 1 Adrian Georgescu
1944 1 Adrian Georgescu
 '''SIPSubscriptionDidStart'''::
1945 1 Adrian Georgescu
  This notification will be sent when the initial {{{SUBSCRIBE}}} was accepted by the presence agent.
1946 95 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1947 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1948 1 Adrian Georgescu
1949 1 Adrian Georgescu
 '''SIPSubscriptionGotNotify'''::
1950 1 Adrian Georgescu
  This notification will be sent when a {{{NOTIFY}}} is received that corresponds to a particular {{{Subscription}}} object.
1951 95 Luci Stanescu
  Note that this notification could be sent when a {{{NOTIFY}}} without a body is received.
1952 1 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
1953 1 Adrian Georgescu
  The request URI of the {{{NOTIFY}}} request as a {{{SIPURI}}} object.
1954 107 Adrian Georgescu
  [[BR]]''from_header'':[[BR]]
1955 107 Adrian Georgescu
  The From header of the {{{NOTIFY}}} request as a {{{FrozenFromHeader}}} object.
1956 107 Adrian Georgescu
  [[BR]]''to_header'':[[BR]]
1957 107 Adrian Georgescu
  The To header of the {{{NOTIFY}}} request as a {{{FrozenToHeader}}} object.
1958 107 Adrian Georgescu
  [[BR]]''content_type'':[[BR]]
1959 107 Adrian Georgescu
  The Content-Type header value of the {{{NOTIFY}}} request as a {{{ContentType}}} object.
1960 107 Adrian Georgescu
  [[BR]]''event'':[[BR]]
1961 107 Adrian Georgescu
  The Event header value of the {{{NOTIFY}}} request as a string object.
1962 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
1963 1 Adrian Georgescu
  The headers of the {{{NOTIFY}}} request as a dict.
1964 1 Adrian Georgescu
  Each SIP header is represented in its parsed for as long as PJSIP supports it.
1965 1 Adrian Georgescu
  The format of the parsed value depends on the header.
1966 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
1967 1 Adrian Georgescu
  The body of the {{{NOTIFY}}} request as a string, or {{{None}}} if no body was included.
1968 107 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1969 107 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.  
1970 95 Luci Stanescu
1971 1 Adrian Georgescu
 '''SIPSubscriptionDidFail'''::
1972 95 Luci Stanescu
  This notification will be sent whenever there is a failure, such as a rejected initial or refreshing {{{SUBSCRIBE}}}.
1973 1 Adrian Georgescu
  After this notification the {{{Subscription}}} object is in the {{{TERMINATED}}} state and can no longer be used.
1974 95 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1975 99 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1976 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
1977 1 Adrian Georgescu
  An integer SIP code from the fatal response that was received from the remote party of generated by PJSIP.
1978 1 Adrian Georgescu
  If the error is internal to the SIP core, this attribute will have a value of 0.
1979 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1980 95 Luci Stanescu
  An text string describing the failure that occurred.
1981 106 Adrian Georgescu
  [[BR]]''min_expires'':[[BR]]
1982 106 Adrian Georgescu
  An integer containing the value from the Min-Expires header. Will be None if the response doesn't contain the header.
1983 1 Adrian Georgescu
1984 59 Ruud Klaver
 '''SIPSubscriptionDidEnd'''::
1985 1 Adrian Georgescu
  This notification will be sent when the subscription ends normally, i.e. the {{{end()}}} method was called and the remote party sent a positive response.
1986 1 Adrian Georgescu
  After this notification the {{{Subscription}}} object is in the {{{TERMINATED}}} state and can no longer be used.
1987 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1988 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1989 1 Adrian Georgescu
1990 1 Adrian Georgescu
=== IncomingSubscription ===
1991 1 Adrian Georgescu
1992 1 Adrian Georgescu
Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856].
1993 1 Adrian Georgescu
1994 1 Adrian Georgescu
This SIP primitive class is the mirror companion to the {{{Subscription}}} class and allows the application to take on the server role in a {{{SUBSCRIBE}}} session.
1995 1 Adrian Georgescu
This means that it can accept a {{{SUBSCRIBE}}} request and subsequent refreshing {{{SUBSCRIBE}}}s and sent {{{NOTIFY}}} requests containing event state.
1996 1 Adrian Georgescu
1997 1 Adrian Georgescu
In order to be able to receive {{{SUBSCRIBE}}} requests for a particular event package, the application needs to add the name of this event package to the {{{incoming_events}}} set attribute on the {{{Engine}}}, either at startup or at a later time, using the {{{add_incoming_event()}}} method.
1998 1 Adrian Georgescu
This event needs to be known by the {{{Engine}}}, i.e. it should already be present in the {{{events}}} dictionary attribute.
1999 1 Adrian Georgescu
Once the event package name is in the {{{incoming_events}}} set attribute, any incoming {{{SUBSCRIBE}}} request containing this name in the {{{Event}}} header causes the creation of a {{{IncomingSubscribe}}} object.
2000 1 Adrian Georgescu
This will be indicated to the application through a {{{SIPIncomingSubscriptionGotSubscribe}}} notification.
2001 1 Adrian Georgescu
It is then up to the application to check if the {{{SUBSCRIBE}}} request was valid, e.g. if it was actually directed at the correct SIP URI, and respond to it in a timely fashion.
2002 1 Adrian Georgescu
2003 1 Adrian Georgescu
The application can either reject the subscription by calling the {{{reject()}}} method or accept it through the {{{accept()}}} method, optionally first accepting it in the {{{pending}}} state by calling the {{{accept_pending()}}} method.
2004 1 Adrian Georgescu
After the {{{IncomingSubscription}}} is accepted, the application can trigger sending a {{{NOTIFY}}} request with a body reflecting the event state through the {{{push_content()}}} method.
2005 1 Adrian Georgescu
Whenever a refreshing {{{SUBSCRIBE}}} is received, the latest contents to be set are sent in the resulting {{{NOTIFY}}} request.
2006 1 Adrian Georgescu
The subscription can be ended by using the {{{end()}}} method.
2007 1 Adrian Georgescu
2008 1 Adrian Georgescu
==== methods ====
2009 1 Adrian Georgescu
2010 1 Adrian Georgescu
2011 99 Adrian Georgescu
 '''!__init!__'''(''self'')::
2012 59 Ruud Klaver
  An application should never create an {{{IncomingSubscription}}} object itself.
2013 59 Ruud Klaver
  Doing this will create a useless object in the {{{None}}} state.
2014 59 Ruud Klaver
2015 59 Ruud Klaver
 '''reject'''(''self'', '''code''')::
2016 99 Adrian Georgescu
  Will reply to the initial {{{SUBSCRIBE}}} with a negative response.
2017 59 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} state and sets the subscription to the {{{"terminated"}}} state.
2018 59 Ruud Klaver
  [[BR]]''code'':[[BR]]
2019 59 Ruud Klaver
  The SIP response code to use.
2020 59 Ruud Klaver
  This should be a negative response, i.e. in the 3xx, 4xx, 5xx or 6xx range.
2021 99 Adrian Georgescu
2022 59 Ruud Klaver
 '''accept_pending'''(''self'')::
2023 1 Adrian Georgescu
  Accept the initial incoming {{{SUBSCRIBE}}}, but put the subscription in the {{{"pending"}}} state and reply with a 202, followed by a {{{NOTIFY}}} request indicating the state.
2024 59 Ruud Klaver
  The application can later decide to fully accept the subscription or terminate it.
2025 59 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} state.
2026 59 Ruud Klaver
2027 59 Ruud Klaver
 '''accept'''(''self'', '''content_type'''={{{None}}}, '''content'''={{{None}}})::
2028 59 Ruud Klaver
  Accept the initial incoming {{{SUBSCRIBE}}} and respond to it with a 200 OK, or fully accept an {{{IncomingSubscription}}} that is in the {{{"pending"}}} state.
2029 59 Ruud Klaver
  In either case, a {{{NOTIFY}}} will be sent to update the state to "active", optionally with the content specified in the arguments.
2030 59 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} or {{{"pending"}}} state.
2031 59 Ruud Klaver
  [[BR]]''content_type'':[[BR]]
2032 59 Ruud Klaver
  The Content-Type of the content to be set supplied as a string containing a {{{"/"}}} character.
2033 59 Ruud Klaver
  Note that if this argument is set, the {{{content}}} argument should also be set.
2034 84 Ruud Klaver
  [[BR]]''content'':[[BR]]
2035 84 Ruud Klaver
  The body of the {{{NOTIFY}}} to send when accepting the subscription, as a string.
2036 84 Ruud Klaver
  Note that if this argument is set, the {{{content_type}}} argument should also be set.
2037 84 Ruud Klaver
2038 84 Ruud Klaver
 '''push_content'''(''self'', '''content_type''', '''content''')::
2039 99 Adrian Georgescu
  Sets or updates the body of the {{{NOTIFY}}}s to be sent within this subscription and causes a {{{NOTIFY}}} to be sent to the subscriber.
2040 84 Ruud Klaver
  This method can only be called in the {{{"active"}}} state.
2041 84 Ruud Klaver
  [[BR]]''content_type'':[[BR]]
2042 84 Ruud Klaver
  The Content-Type of the content to be set supplied as a string containing a {{{"/"}}} character.
2043 84 Ruud Klaver
  [[BR]]''content'':[[BR]]
2044 84 Ruud Klaver
  The body of the {{{NOTIFY}}} as a string.
2045 84 Ruud Klaver
2046 84 Ruud Klaver
==== attributes ====
2047 84 Ruud Klaver
2048 84 Ruud Klaver
2049 84 Ruud Klaver
 '''state'''::
2050 99 Adrian Georgescu
  Indicates which state the incoming subscription session is in.
2051 84 Ruud Klaver
  This can be one of {{{None}}}, {{{"incoming"}}}, {{{"pending"}}}, {{{"active"}}} or {{{"terminated"}}}.
2052 84 Ruud Klaver
  This attribute is read-only.
2053 1 Adrian Georgescu
2054 1 Adrian Georgescu
 '''event'''::
2055 1 Adrian Georgescu
  The name of the event package that this {{{IncomingSubscription}}} relates to.
2056 1 Adrian Georgescu
  This attribute is a read-only string.
2057 1 Adrian Georgescu
2058 1 Adrian Georgescu
 '''content_type'''::
2059 1 Adrian Georgescu
  The {{{Content-Type}}} of the last set content in this subscription session.
2060 1 Adrian Georgescu
  Inititally this will be {{{None}}}.
2061 1 Adrian Georgescu
  This attribute is a read-only string.
2062 1 Adrian Georgescu
2063 1 Adrian Georgescu
 '''content'''::
2064 1 Adrian Georgescu
  The last set content in this subscription session as a read-only string.
2065 109 Adrian Georgescu
2066 109 Adrian Georgescu
 '''peer_address'''::
2067 109 Adrian Georgescu
  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.
2068 1 Adrian Georgescu
2069 1 Adrian Georgescu
==== notifications ====
2070 1 Adrian Georgescu
2071 1 Adrian Georgescu
2072 84 Ruud Klaver
 '''SIPIncomingSubscriptionChangedState'''::
2073 84 Ruud Klaver
  This notification will be sent every time the an {{{IncomingSubscription}}} object changes state.
2074 84 Ruud Klaver
  This notification is mostly indicative, an application should not let its logic depend on it.
2075 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2076 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2077 84 Ruud Klaver
  [[BR]]''prev_state'':[[BR]]
2078 84 Ruud Klaver
  The previous state that the subscription was in.
2079 84 Ruud Klaver
  [[BR]]''state'':[[BR]]
2080 99 Adrian Georgescu
  The new state the subscription has.
2081 84 Ruud Klaver
2082 84 Ruud Klaver
 '''SIPIncomingSubscriptionGotSubscribe'''::
2083 84 Ruud Klaver
  This notification will be sent when a new {{{IncomingSubscription}}} is created as result of an incoming {{{SUBSCRIBE}}} request.
2084 99 Adrian Georgescu
  The application should listen for this notification, retain a reference to the object that sent it and either accept or reject it.
2085 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2086 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2087 84 Ruud Klaver
  [[BR]]''method'':[[BR]]
2088 84 Ruud Klaver
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2089 84 Ruud Klaver
  [[BR]]''request_uri'':[[BR]]
2090 84 Ruud Klaver
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2091 99 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2092 84 Ruud Klaver
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2093 84 Ruud Klaver
  [[BR]]''body'':[[BR]]
2094 84 Ruud Klaver
  The body of the {{{SUBSCRIBE}}} request as a string, or {{{None}}} if no body was included.
2095 84 Ruud Klaver
2096 99 Adrian Georgescu
 '''SIPIncomingSubscriptionGotRefreshingSubscribe'''::
2097 84 Ruud Klaver
  This notification indicates that a refreshing {{{SUBSCRIBE}}} request was received from the subscriber.
2098 84 Ruud Klaver
  It is purely informative, no action needs to be taken by the application as a result of it.
2099 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2100 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2101 84 Ruud Klaver
  [[BR]]''method'':[[BR]]
2102 84 Ruud Klaver
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2103 84 Ruud Klaver
  [[BR]]''request_uri'':[[BR]]
2104 84 Ruud Klaver
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2105 84 Ruud Klaver
  [[BR]]''headers'':[[BR]]
2106 84 Ruud Klaver
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2107 99 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2108 84 Ruud Klaver
  The body of the {{{SUBSCRIBE}}} request as a string, or {{{None}}} if no body was included.
2109 84 Ruud Klaver
2110 84 Ruud Klaver
 '''SIPIncomingSubscriptionGotUnsubscribe'''::
2111 84 Ruud Klaver
  This notification indicates that a {{{SUBSCRIBE}}} request with an {{{Expires}}} header of 0 was received from the subscriber, effectively requesting to unsubscribe.
2112 84 Ruud Klaver
  It is purely informative, no action needs to be taken by the application as a result of it.
2113 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2114 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2115 84 Ruud Klaver
  [[BR]]''method'':[[BR]]
2116 95 Luci Stanescu
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2117 95 Luci Stanescu
  [[BR]]''request_uri'':[[BR]]
2118 99 Adrian Georgescu
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2119 95 Luci Stanescu
  [[BR]]''headers'':[[BR]]
2120 95 Luci Stanescu
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2121 95 Luci Stanescu
  [[BR]]''body'':[[BR]]
2122 95 Luci Stanescu
  The body of the {{{SUBSCRIBE}}} request or response as a string, or {{{None}}} if no body was included.
2123 99 Adrian Georgescu
2124 95 Luci Stanescu
 '''SIPIncomingSubscriptionAnsweredSubscribe'''::
2125 95 Luci Stanescu
  This notification is sent whenever a response to a {{{SUBSCRIBE}}} request is sent by the object, including an unsubscribing {{{SUBSCRIBE}}}.
2126 95 Luci Stanescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2127 99 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2128 95 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2129 95 Luci Stanescu
  [[BR]]''code'':[[BR]]
2130 95 Luci Stanescu
  The code of the SIP response as an int.
2131 95 Luci Stanescu
  [[BR]]''reason'':[[BR]]
2132 99 Adrian Georgescu
  The reason text of the SIP response as an int.
2133 95 Luci Stanescu
  [[BR]]''headers'':[[BR]]
2134 95 Luci Stanescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2135 95 Luci Stanescu
  [[BR]]''body'':[[BR]]
2136 1 Adrian Georgescu
  This will be {{{None}}}.
2137 1 Adrian Georgescu
2138 99 Adrian Georgescu
 '''SIPIncomingSubscriptionSentNotify'''::
2139 1 Adrian Georgescu
  This notification indicates that a {{{NOTIFY}}} request was sent to the subscriber.
2140 1 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2141 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2142 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2143 1 Adrian Georgescu
  [[BR]]''method'':[[BR]]
2144 1 Adrian Georgescu
  The method of the SIP request as a string, which will be {{{NOTIFY}}}.
2145 1 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
2146 1 Adrian Georgescu
  The request URI of the {{{NOTIFY}}} request as a {{{FrozenSIPURI}}} object.
2147 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2148 99 Adrian Georgescu
  The headers of the {{{NOTIFY}}} request as a dict, the values of which are the relevant header objects.
2149 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2150 1 Adrian Georgescu
  The body of the {{{NOTIFY}}} request or response as a string, or {{{None}}} if no body was included.
2151 1 Adrian Georgescu
2152 1 Adrian Georgescu
 '''SIPIncomingSubscriptionNotifyDidSucceed'''::
2153 1 Adrian Georgescu
  This indicates that a positive final response was received from the subscriber in reply to a sent {{{NOTIFY}}} request.
2154 18 Adrian Georgescu
  The notification is purely informative, no action needs to be taken by the application as a result of it.
2155 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2156 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2157 17 Ruud Klaver
  [[BR]]''code'':[[BR]]
2158 17 Ruud Klaver
  The code of the SIP response as an int.
2159 17 Ruud Klaver
  [[BR]]''reason'':[[BR]]
2160 17 Ruud Klaver
  The reason text of the SIP response as a string.
2161 17 Ruud Klaver
  [[BR]]''headers'':[[BR]]
2162 99 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2163 17 Ruud Klaver
  [[BR]]''body'':[[BR]]
2164 17 Ruud Klaver
  This will be {{{None}}}.
2165 17 Ruud Klaver
2166 17 Ruud Klaver
 '''SIPIncomingSubscriptionNotifyDidFail'''::
2167 1 Adrian Georgescu
  This indicates that a negative response was received from the subscriber in reply to a sent {{{NOTIFY}}} request or that the {{{NOTIFY}}} failed to send.
2168 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2169 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2170 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2171 1 Adrian Georgescu
  The code of the SIP response as an int.
2172 1 Adrian Georgescu
  If this is 0, the notification was sent as a result of an internal error.
2173 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2174 1 Adrian Georgescu
  The reason text of the SIP response as a string or the internal error if the code attribute is 0.
2175 1 Adrian Georgescu
  [[BR]]''headers'': (if the notification was caused by a negative response)[[BR]]
2176 99 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2177 17 Ruud Klaver
  [[BR]]''body'': (if the notification was caused by a negative response)[[BR]]
2178 1 Adrian Georgescu
  This will be {{{None}}}.
2179 1 Adrian Georgescu
2180 1 Adrian Georgescu
 '''SIPIncomingSubscriptionNotifyDidEnd'''::
2181 1 Adrian Georgescu
  This notification is sent whenever the {{{IncomingSubscription}}} object reaches the {{{"terminated"}}} state and is no longer valid.
2182 1 Adrian Georgescu
  After receiving this notification, the application should not longer try to use the object.
2183 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2184 17 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2185 1 Adrian Georgescu
2186 112 Adrian Georgescu
=== Referral ===
2187 112 Adrian Georgescu
2188 112 Adrian Georgescu
Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856].
2189 112 Adrian Georgescu
The REFER method, defined in [http://tools.ietf.org/html/rfc3515 RFC 3515] uses the subscription mechanism to to tell SIP endpoints to refer to specific resources.
2190 112 Adrian Georgescu
2191 112 Adrian Georgescu
This SIP primitive class represents a referral requested by the client to a target URI.
2192 112 Adrian Georgescu
This means that the application should instance this class for each combination of target URI and resource it wishes the target to refer to.
2193 112 Adrian Georgescu
Whenever a {{{NOTIFY}}} is received, the application will receive the {{{SIPReferralGotNotify}}} notification.
2194 112 Adrian Georgescu
2195 112 Adrian Georgescu
Not creating an implicit subscription is supporte as per [http://tools.ietf.org/html/rfc4488 RFC 4488]
2196 112 Adrian Georgescu
2197 112 Adrian Georgescu
Internally a {{{Referral}}} object has a state machine, which reflects the state of the subscription. (The same as the {{{Subsciption}}} since it uses the same event framework)
2198 112 Adrian Georgescu
It is a direct mirror of the state machine of the underlying {{{pjsip_evsub}}} object, whose possible states are at least {{{NULL}}}, {{{SENT}}}, {{{ACCEPTED}}}, {{{PENDING}}}, {{{ACTIVE}}} or {{{TERMINATED}}}.
2199 112 Adrian Georgescu
The last three states are directly copied from the contents of the {{{Subscription-State}}} header of the received {{{NOTIFY}}} request.
2200 112 Adrian Georgescu
Also, the state can be an arbitrary string if the contents of the {{{Subscription-State}}} header are not one of the three above.
2201 112 Adrian Georgescu
The state of the object is presented in the {{{state}}} attribute and changes of the state are indicated by means of the {{{SIPReferralChangedState}}} notification.
2202 112 Adrian Georgescu
This notification is only informational, an application using this object should take actions based on the other notifications sent by this object.
2203 112 Adrian Georgescu
2204 112 Adrian Georgescu
==== methods ====
2205 112 Adrian Georgescu
2206 112 Adrian Georgescu
2207 112 Adrian Georgescu
 '''!__init!__'''(''self'', '''request_uri''', '''from_header''', '''to_header''', '''refer_to_header, '''contact_header''', '''route_header''', '''credentials'''={{{None}}})::
2208 112 Adrian Georgescu
  Creates a new {{{Referral}}} object which will be in the {{{NULL}}} state.
2209 112 Adrian Georgescu
  The arguments for this method are documented in the attributes section above.
2210 112 Adrian Georgescu
2211 112 Adrian Georgescu
 '''send_refer'''(''self'', '''create_subscription'''={{{1}}}, '''extra_headers'''={{{list()}}}, '''timeout'''={{{None}}})::
2212 112 Adrian Georgescu
  Calling this method triggers sending a {{{REFER}}} request to the presence agent.
2213 112 Adrian Georgescu
  The arguments passed will be stored and used for subsequent refreshing {{{SUBSCRIBE}}} requests. The dialog may also be refreshed manually by using the {{{refresh}}} function.
2214 112 Adrian Georgescu
  It may not be called when the object is in the {{{TERMINATED}}} state.
2215 112 Adrian Georgescu
  [[BR]]''create_subscription'':[[BR]]
2216 112 Adrian Georgescu
  Boolean flag indicating if an implicit subscription should be created.
2217 112 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
2218 112 Adrian Georgescu
  A list of additional headers to include in the {{{REFER}}} requests.
2219 112 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
2220 112 Adrian Georgescu
  This can be either an int or a float, indicating in how many seconds the request should timeout with an internally generated 408 response.
2221 112 Adrian Georgescu
  If this is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
2222 112 Adrian Georgescu
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
2223 112 Adrian Georgescu
2224 112 Adrian Georgescu
 '''refresh'''(''self'', '''contact_header'''={{{None}}}, '''extra_headers'''={{{list()}}}, '''timeout'''={{{None}}})::
2225 112 Adrian Georgescu
  [[BR]]''contact_header'':[[BR]]
2226 112 Adrian Georgescu
  An optional {{{ContactHeader}}} object which will replace the local contact header and will be used from this moment on.
2227 112 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
2228 112 Adrian Georgescu
  A list of additional headers to include in the refreshing {{{SUBSCRIBE}}} request.
2229 112 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
2230 112 Adrian Georgescu
  The {{{timeout}}} argument has the same meaning as it does for the {{{send_refer()}}} method.
2231 112 Adrian Georgescu
2232 112 Adrian Georgescu
 '''end'''(''self'', '''timeout'''={{{None}}})::
2233 112 Adrian Georgescu
  This will end the referral subscription by sending a {{{SUBSCRIBE}}} request with an {{{Expires}}} value of 0.
2234 112 Adrian Georgescu
  If this object is no longer subscribed, this method will return without performing any action.
2235 112 Adrian Georgescu
  This method cannot be called when the object is in the {{{NULL}}} state.
2236 112 Adrian Georgescu
  The {{{timeout}}} argument has the same meaning as it does for the {{{send_refer()}}} method.
2237 112 Adrian Georgescu
2238 112 Adrian Georgescu
==== attributes ====
2239 112 Adrian Georgescu
2240 112 Adrian Georgescu
2241 112 Adrian Georgescu
 '''state'''::
2242 112 Adrian Georgescu
  Indicates which state the internal state machine is in.
2243 112 Adrian Georgescu
  See the previous section for a list of states the state machine can be in.
2244 112 Adrian Georgescu
2245 112 Adrian Georgescu
 '''from_header'''::
2246 112 Adrian Georgescu
  The {{{FrozenFromHeader}}} to be put in the {{{From}}} header of the {{{REFER}}} and {{{SUBSCRIBE}}} requests.
2247 112 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
2248 112 Adrian Georgescu
2249 112 Adrian Georgescu
 '''to_header'''::
2250 112 Adrian Georgescu
  The {{{FrozenToHeader}}} that is the target for the referral.
2251 112 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
2252 112 Adrian Georgescu
2253 112 Adrian Georgescu
 '''refer_to_header'''::
2254 112 Adrian Georgescu
  The {{{FrozenReferToHeader}}} that is the target resource for the referral.
2255 112 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
2256 112 Adrian Georgescu
2257 112 Adrian Georgescu
 '''local_contact_header'''::
2258 112 Adrian Georgescu
  The {{{FrozenContactHeader}}} to be put in the {{{Contact}}} header of the {{{REFER}}} and {{{SUBSCRIBE}}} requests.
2259 112 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
2260 112 Adrian Georgescu
2261 112 Adrian Georgescu
 '''remote_contact_header'''::
2262 112 Adrian Georgescu
 The {{{FrozenContactHeader}}} received from the remote endpoint. This attribute is read-only.
2263 112 Adrian Georgescu
2264 112 Adrian Georgescu
 '''route_header'''::
2265 112 Adrian Georgescu
  The outbound proxy to use in the form of a {{{FrozenRouteHeader}}} object.
2266 112 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
2267 112 Adrian Georgescu
2268 112 Adrian Georgescu
 '''credentials'''::
2269 112 Adrian Georgescu
  The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{FrozenCredentials}}} object.
2270 112 Adrian Georgescu
  If none was specified when creating the {{{Referral}}} object, this attribute is {{{None}}}.
2271 112 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
2272 112 Adrian Georgescu
2273 112 Adrian Georgescu
 '''refresh'''::
2274 112 Adrian Georgescu
  The refresh interval in seconds that was requested on object instantiation as an int.
2275 112 Adrian Georgescu
  This attribute is set when a {{{NOTIFY}}} request is received and is read-only.
2276 112 Adrian Georgescu
2277 112 Adrian Georgescu
 '''extra_headers'''::
2278 112 Adrian Georgescu
  This contains the {{{frozenlist}}} of extra headers that was last passed to a successful call to the {{{subscribe()}}} method.
2279 112 Adrian Georgescu
  If the argument was not provided, this attribute is an empty list.
2280 112 Adrian Georgescu
  This attribute is read-only.
2281 112 Adrian Georgescu
2282 112 Adrian Georgescu
 '''peer_address'''::
2283 112 Adrian Georgescu
  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.
2284 112 Adrian Georgescu
2285 112 Adrian Georgescu
==== notifications ====
2286 112 Adrian Georgescu
2287 112 Adrian Georgescu
2288 112 Adrian Georgescu
 '''SIPReferralChangedState'''::
2289 112 Adrian Georgescu
  This notification will be sent every time the internal state machine of a {{{Referral}}} object changes state.
2290 112 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2291 112 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2292 112 Adrian Georgescu
  [[BR]]''prev_state'':[[BR]]
2293 112 Adrian Georgescu
  The previous state that the sate machine was in.
2294 112 Adrian Georgescu
  [[BR]]''state'':[[BR]]
2295 112 Adrian Georgescu
  The new state the state machine moved into.
2296 112 Adrian Georgescu
2297 112 Adrian Georgescu
 '''SIPReferralWillStart'''::
2298 112 Adrian Georgescu
  This notification will be emitted when the initial {{{REFER}}} request is sent.
2299 112 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2300 112 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2301 112 Adrian Georgescu
2302 112 Adrian Georgescu
 '''SIPReferralDidStart'''::
2303 112 Adrian Georgescu
  This notification will be sent when the initial {{{REFER}}} was accepted by the remote endpoint.
2304 112 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2305 112 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2306 112 Adrian Georgescu
2307 112 Adrian Georgescu
 '''SIPReferralGotNotify'''::
2308 112 Adrian Georgescu
  This notification will be sent when a {{{NOTIFY}}} is received that corresponds to a particular {{{Referral}}} object.
2309 112 Adrian Georgescu
  Note that this notification could be sent when a {{{NOTIFY}}} without a body is received.
2310 112 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
2311 112 Adrian Georgescu
  The request URI of the {{{NOTIFY}}} request as a {{{SIPURI}}} object.
2312 112 Adrian Georgescu
  [[BR]]''from_header'':[[BR]]
2313 112 Adrian Georgescu
  The From header of the {{{NOTIFY}}} request as a {{{FrozenFromHeader}}} object.
2314 112 Adrian Georgescu
  [[BR]]''to_header'':[[BR]]
2315 112 Adrian Georgescu
  The To header of the {{{NOTIFY}}} request as a {{{FrozenToHeader}}} object.
2316 112 Adrian Georgescu
  [[BR]]''content_type'':[[BR]]
2317 112 Adrian Georgescu
  The Content-Type header value of the {{{NOTIFY}}} request as a {{{ContentType}}} object.
2318 112 Adrian Georgescu
  [[BR]]''event'':[[BR]]
2319 112 Adrian Georgescu
  The Event header value of the {{{NOTIFY}}} request as a string object.
2320 112 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2321 112 Adrian Georgescu
  The headers of the {{{NOTIFY}}} request as a dict.
2322 112 Adrian Georgescu
  Each SIP header is represented in its parsed for as long as PJSIP supports it.
2323 112 Adrian Georgescu
  The format of the parsed value depends on the header.
2324 112 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2325 112 Adrian Georgescu
  The body of the {{{NOTIFY}}} request as a string, or {{{None}}} if no body was included.
2326 112 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2327 112 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.  
2328 112 Adrian Georgescu
2329 112 Adrian Georgescu
 '''SIPReferralDidFail'''::
2330 112 Adrian Georgescu
  This notification will be sent whenever there is a failure, such as a rejected initial {{{REFER}}} or refreshing {{{SUBSCRIBE}}}.
2331 112 Adrian Georgescu
  After this notification the {{{Referral}}} object is in the {{{TERMINATED}}} state and can no longer be used.
2332 112 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2333 112 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2334 112 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2335 112 Adrian Georgescu
  An integer SIP code from the fatal response that was received from the remote party of generated by PJSIP.
2336 112 Adrian Georgescu
  If the error is internal to the SIP core, this attribute will have a value of 0.
2337 112 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2338 112 Adrian Georgescu
  An text string describing the failure that occurred.
2339 112 Adrian Georgescu
2340 112 Adrian Georgescu
 '''SIPReferralDidEnd'''::
2341 112 Adrian Georgescu
  This notification will be sent when the subscription ends normally, i.e. the {{{end()}}} method was called and the remote party sent a positive response. It will also be sent when the remote endpoint sends a {{{NOTIFY}}} request with a {{{noresource}}} reason in the {{{Subscription-State}}} header.
2342 112 Adrian Georgescu
  After this notification the {{{Referral}}} object is in the {{{TERMINATED}}} state and can no longer be used.
2343 112 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2344 112 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2345 112 Adrian Georgescu
2346 113 Adrian Georgescu
=== IncomingReferral ===
2347 113 Adrian Georgescu
2348 113 Adrian Georgescu
Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856].
2349 113 Adrian Georgescu
The REFER method, defined in [http://tools.ietf.org/html/rfc3515 RFC 3515] uses the subscription mechanism to to tell SIP endpoints to refer to specific resources.
2350 113 Adrian Georgescu
2351 113 Adrian Georgescu
This SIP primitive class is the mirror companion to the {{{Referral}}} class and allows the application to take on the server role in a {{{REFER}}} dialog.
2352 113 Adrian Georgescu
This means that it can accept a {{{REFER}}} request and subsequent refreshing {{{SUBSCRIBE}}}s and sent {{{NOTIFY}}} requests containing event state.
2353 113 Adrian Georgescu
2354 113 Adrian Georgescu
Any incoming {{{REFER}}} request causes the creation of a {{{IncomingReferral}}} object.
2355 113 Adrian Georgescu
This will be indicated to the application through a {{{SIPIncomingReferralGotRefer}}} notification.
2356 113 Adrian Georgescu
It is then up to the application to check if the {{{REFER}}} request was valid, e.g. if it was actually directed at the correct SIP URI, and respond to it in a timely fashion.
2357 113 Adrian Georgescu
2358 113 Adrian Georgescu
The application can either reject the referral by calling the {{{reject()}}} method or accept it through the {{{accept()}}} method.
2359 113 Adrian Georgescu
After the {{{IncomingReferral}}} is accepted, the application can trigger sending a {{{NOTIFY}}} request with a body reflecting the event state through the {{{send_notify()}}} method.
2360 113 Adrian Georgescu
Whenever a refreshing {{{SUBSCRIBE}}} is received, the latest contents to be set are sent in the resulting {{{NOTIFY}}} request.
2361 113 Adrian Georgescu
The subscription can be ended by using the {{{end()}}} method.
2362 113 Adrian Georgescu
2363 113 Adrian Georgescu
==== methods ====
2364 113 Adrian Georgescu
2365 113 Adrian Georgescu
2366 113 Adrian Georgescu
 '''!__init!__'''(''self'')::
2367 113 Adrian Georgescu
  An application should never create an {{{IncomingSubscription}}} object itself.
2368 113 Adrian Georgescu
  Doing this will create a useless object in the {{{None}}} state.
2369 113 Adrian Georgescu
2370 113 Adrian Georgescu
 '''reject'''(''self'', '''code''')::
2371 113 Adrian Georgescu
  Will reply to the initial {{{REFER}}} with a negative response.
2372 113 Adrian Georgescu
  This method can only be called in the {{{"incoming"}}} state and sets the referral to the {{{"terminated"}}} state.
2373 113 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2374 113 Adrian Georgescu
  The SIP response code to use.
2375 113 Adrian Georgescu
  This should be a negative response, i.e. in the 3xx, 4xx, 5xx or 6xx range.
2376 113 Adrian Georgescu
2377 113 Adrian Georgescu
 '''accept'''(''self'', '''code'''={{{202}}}, '''duration'''={{{180}}})::
2378 113 Adrian Georgescu
  Accept the initial incoming {{{REFER}}} and respond to it with a 202 Accepted.
2379 113 Adrian Georgescu
  A {{{NOTIFY}}} will be sent to update the state to "active", with a payload indicating the referral is in 100 Trying state.
2380 113 Adrian Georgescu
  This method can only be called in the {{{"incoming"}}} state.
2381 113 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2382 113 Adrian Georgescu
  The code to be  used for the initial reply.
2383 113 Adrian Georgescu
  [[BR]]''duration'':[[BR]]
2384 113 Adrian Georgescu
  The desired duration for the implicit subscription. Unlike {{{SUBSCRIBE}}} initiated dialogs, in a referral the receiving party is the one choosing the expiration time.
2385 113 Adrian Georgescu
2386 113 Adrian Georgescu
 '''send_notify'''(''self'', '''code''', '''status'''={{{None}}})::
2387 113 Adrian Georgescu
  Sets or updates the body of the {{{NOTIFY}}}s to be sent within this referral and causes a {{{NOTIFY}}} to be sent to the subscriber.
2388 113 Adrian Georgescu
  This method can only be called in the {{{"active"}}} state.
2389 113 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2390 113 Adrian Georgescu
  The response code to be used to generate the sipfrag payload.
2391 113 Adrian Georgescu
  [[BR]]''status'':[[BR]]
2392 113 Adrian Georgescu
  Optional status reason to be used to build the sipfrag payload. If none was specified the standard reason string will be used.
2393 113 Adrian Georgescu
2394 113 Adrian Georgescu
==== attributes ====
2395 113 Adrian Georgescu
2396 113 Adrian Georgescu
2397 113 Adrian Georgescu
 '''state'''::
2398 113 Adrian Georgescu
  Indicates which state the incoming referral dialog is in.
2399 113 Adrian Georgescu
  This can be one of {{{None}}}, {{{"incoming"}}}, {{{"pending"}}}, {{{"active"}}} or {{{"terminated"}}}.
2400 113 Adrian Georgescu
  This attribute is read-only.
2401 113 Adrian Georgescu
2402 113 Adrian Georgescu
 '''local_contact_header'''::
2403 113 Adrian Georgescu
  The {{{FrozenContactHeader}}} to be put in the {{{Contact}}} header of the {{{REFER}}} and {{{SUBSCRIBE}}} responses and {{{NOTIFY}}} requests.
2404 113 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
2405 113 Adrian Georgescu
2406 113 Adrian Georgescu
 '''remote_contact_header'''::
2407 113 Adrian Georgescu
 The {{{FrozenContactHeader}}} received from the remote endpoint. This attribute is read-only.
2408 113 Adrian Georgescu
2409 113 Adrian Georgescu
 '''peer_address'''::
2410 113 Adrian Georgescu
  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.
2411 113 Adrian Georgescu
2412 113 Adrian Georgescu
==== notifications ====
2413 113 Adrian Georgescu
2414 113 Adrian Georgescu
2415 113 Adrian Georgescu
 '''SIPIncomingReferralChangedState'''::
2416 113 Adrian Georgescu
  This notification will be sent every time the an {{{IncomingReferral}}} object changes state.
2417 113 Adrian Georgescu
  This notification is mostly indicative, an application should not let its logic depend on it.
2418 113 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2419 113 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2420 113 Adrian Georgescu
  [[BR]]''prev_state'':[[BR]]
2421 113 Adrian Georgescu
  The previous state that the subscription was in.
2422 113 Adrian Georgescu
  [[BR]]''state'':[[BR]]
2423 113 Adrian Georgescu
  The new state the subscription has.
2424 113 Adrian Georgescu
2425 113 Adrian Georgescu
 '''SIPIncomingReferralGotRefer'''::
2426 113 Adrian Georgescu
  This notification will be sent when a new {{{IncomingReferral}}} is created as result of an incoming {{{REFER}}} request.
2427 113 Adrian Georgescu
  The application should listen for this notification, retain a reference to the object that sent it and either accept or reject it.
2428 113 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2429 113 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2430 113 Adrian Georgescu
  [[BR]]''method'':[[BR]]
2431 113 Adrian Georgescu
  The method of the SIP request as a string, which will be {{{REFER}}}.
2432 113 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
2433 113 Adrian Georgescu
  The request URI of the {{{REFER}}} request as a {{{FrozenSIPURI}}} object.
2434 113 Adrian Georgescu
  [[BR]]''refer_to'':[[BR]]
2435 113 Adrian Georgescu
  The Refer-To header as a {{{FrozenReferToHeader}}} object.
2436 113 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2437 113 Adrian Georgescu
  The headers of the {{{REFER}}} request as a dict, the values of which are the relevant header objects.
2438 113 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2439 113 Adrian Georgescu
  The body of the {{{REFER}}} request as a string, or {{{None}}} if no body was included.
2440 113 Adrian Georgescu
2441 113 Adrian Georgescu
 '''SIPIncomingReferralGotRefreshingSubscribe'''::
2442 113 Adrian Georgescu
  This notification indicates that a refreshing {{{SUBSCRIBE}}} request was received from the subscriber.
2443 113 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2444 113 Adrian Georgescu
2445 113 Adrian Georgescu
 '''SIPIncomingReferralGotUnsubscribe'''::
2446 113 Adrian Georgescu
  This notification indicates that a {{{SUBSCRIBE}}} request with an {{{Expires}}} header of 0 was received from the subscriber, effectively requesting to unsubscribe.
2447 113 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2448 113 Adrian Georgescu
2449 113 Adrian Georgescu
 '''SIPIncomingReferralAnsweredRefer'''::
2450 113 Adrian Georgescu
  This notification is sent whenever a response to a {{{REFER}}} request is sent by the object.
2451 113 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2452 113 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2453 113 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2454 113 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2455 113 Adrian Georgescu
  The code of the SIP response as an int.
2456 113 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2457 113 Adrian Georgescu
  The reason text of the SIP response as an int.
2458 113 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2459 113 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2460 113 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2461 113 Adrian Georgescu
  This will be {{{None}}}.
2462 113 Adrian Georgescu
2463 113 Adrian Georgescu
 '''SIPIncomingReferralSentNotify'''::
2464 113 Adrian Georgescu
  This notification indicates that a {{{NOTIFY}}} request was sent to the subscriber.
2465 113 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2466 113 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2467 113 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2468 113 Adrian Georgescu
  [[BR]]''method'':[[BR]]
2469 113 Adrian Georgescu
  The method of the SIP request as a string, which will be {{{NOTIFY}}}.
2470 113 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
2471 113 Adrian Georgescu
  The request URI of the {{{NOTIFY}}} request as a {{{FrozenSIPURI}}} object.
2472 113 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2473 113 Adrian Georgescu
  The headers of the {{{NOTIFY}}} request as a dict, the values of which are the relevant header objects.
2474 113 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2475 113 Adrian Georgescu
  The body of the {{{NOTIFY}}} request or response as a string, or {{{None}}} if no body was included.
2476 113 Adrian Georgescu
2477 113 Adrian Georgescu
 '''SIPIncomingReferralNotifyDidSucceed'''::
2478 113 Adrian Georgescu
  This indicates that a positive final response was received from the subscriber in reply to a sent {{{NOTIFY}}} request.
2479 113 Adrian Georgescu
  The notification is purely informative, no action needs to be taken by the application as a result of it.
2480 113 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2481 113 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2482 113 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2483 113 Adrian Georgescu
  The code of the SIP response as an int.
2484 113 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2485 113 Adrian Georgescu
  The reason text of the SIP response as a string.
2486 113 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2487 113 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2488 113 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2489 113 Adrian Georgescu
  This will be {{{None}}}.
2490 113 Adrian Georgescu
2491 113 Adrian Georgescu
 '''SIPIncomingReferralNotifyDidFail'''::
2492 113 Adrian Georgescu
  This indicates that a negative response was received from the subscriber in reply to a sent {{{NOTIFY}}} request or that the {{{NOTIFY}}} failed to send.
2493 113 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2494 113 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2495 113 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2496 113 Adrian Georgescu
  The code of the SIP response as an int.
2497 113 Adrian Georgescu
  If this is 0, the notification was sent as a result of an internal error.
2498 113 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2499 113 Adrian Georgescu
  The reason text of the SIP response as a string or the internal error if the code attribute is 0.
2500 113 Adrian Georgescu
  [[BR]]''headers'': (if the notification was caused by a negative response)[[BR]]
2501 113 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2502 113 Adrian Georgescu
  [[BR]]''body'': (if the notification was caused by a negative response)[[BR]]
2503 113 Adrian Georgescu
  This will be {{{None}}}.
2504 113 Adrian Georgescu
2505 113 Adrian Georgescu
 '''SIPIncomingReferralDidEnd'''::
2506 113 Adrian Georgescu
  This notification is sent whenever the {{{IncomingReferral}}} object reaches the {{{"terminated"}}} state and is no longer valid.
2507 113 Adrian Georgescu
  After receiving this notification, the application should not longer try to use the object.
2508 113 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2509 113 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2510 113 Adrian Georgescu
2511 103 Adrian Georgescu
=== AudioMixer ===
2512 1 Adrian Georgescu
2513 103 Adrian Georgescu
A {{{AudioMixer}}} manages two audio devices, on for input and one for output, and is able to route audio data for a number of sources.
2514 103 Adrian Georgescu
It wraps a [http://www.pjsip.org/pjmedia/docs/html/group__PJMEDIA__CONF.htm PJSIP conference bridge], the concept of which is explained in the [http://trac.pjsip.org/repos/wiki/Python_SIP/Media PJSIP documentation].
2515 103 Adrian Georgescu
Any component in the core that either produces or consumes sound, i.e. {{{AudioTransport}}}, {{{ToneGenerator}}}, {{{WaveFile}}} and {{{RecordingWaveFile}}} objects, has a {{{ConferenceBridge}}} associated with it and a corresponding slot on that conference bridge.
2516 103 Adrian Georgescu
The sound devices, both input and output, together always occupy slot 0.
2517 103 Adrian Georgescu
It is up to the application to setup the desired routing between these components. Note that the middleware provides an abstracted API which hides the complexity of using the low-level PJSIP concepts. This is mainly provided in the [wiki:SipMiddlewareApi#Audio {{{sipsimple.audio}}}] module, but also consists of other audio-enabled objects (such as the AudioStream).
2518 1 Adrian Georgescu
2519 103 Adrian Georgescu
==== methods ====
2520 1 Adrian Georgescu
2521 1 Adrian Georgescu
2522 103 Adrian Georgescu
 '''!__init!__'''(''self'', '''input_device''', '''output_device''', '''sample_rate''', '''ec_tail_length'''=200, '''slot_count'''=254)::
2523 103 Adrian Georgescu
  Creates a new {{{ConferenceBridge}}} object.
2524 103 Adrian Georgescu
  [[BR]]''input_device'':[[BR]]
2525 103 Adrian Georgescu
  The name of the audio input device to use as a string, or {{{None}}} if no input device is to be used.
2526 103 Adrian Georgescu
  A list of known input devices can be queried through the {{{Engine.input_devices}}} attribute.
2527 105 Luci Stanescu
  If {{{"system_default"}}} is used, PJSIP will select the system default output device, or {{{None}}} if no audio input device is present.
2528 103 Adrian Georgescu
  The device that was selected can be queried afterwards through the {{{input_device}}} attribute.
2529 103 Adrian Georgescu
  [[BR]]''output_device'':[[BR]]
2530 103 Adrian Georgescu
  The name of the audio output device to use as a string, or {{{None}}} if no output device is to be used.
2531 103 Adrian Georgescu
  A list of known output devices can be queried through the {{{Engine.output_devices}}} attribute.
2532 105 Luci Stanescu
  If {{{"system_default"}}} is used, PJSIP will select the system default output device, or {{{None}}} if no audio output device is present.
2533 103 Adrian Georgescu
  The device that was selected can be queried afterwards through the {{{output_device}}} attribute.
2534 103 Adrian Georgescu
  [[BR]]''sample_rate'':[[BR]]
2535 103 Adrian Georgescu
  The sample rate on which the conference bridge and sound devices should operate in Hz.
2536 103 Adrian Georgescu
  This must be a multiple of 50.
2537 103 Adrian Georgescu
  [[BR]]''ec_tail_length'':[[BR]]
2538 103 Adrian Georgescu
  The echo cancellation tail length in ms.
2539 103 Adrian Georgescu
  If this value is 0, no echo cancellation is used.
2540 103 Adrian Georgescu
  [[BR]]''slot_count'':[[BR]]
2541 103 Adrian Georgescu
  The number of slots to allocate on the conference bridge.
2542 103 Adrian Georgescu
  Not that this includes the slot that is occupied by the sound devices.
2543 99 Adrian Georgescu
2544 103 Adrian Georgescu
 '''set_sound_devices'''(''self'', '''input_device''', '''output_device''', '''ec_tail_length''')::
2545 103 Adrian Georgescu
  Change the sound devices used (including echo cancellation) by the conference bridge.
2546 103 Adrian Georgescu
  The meaning of the parameters is that same as for {{{__init__()}}}.
2547 1 Adrian Georgescu
2548 103 Adrian Georgescu
 '''connect_slots'''(''self'', '''src_slot''', '''dst_slot''')::
2549 103 Adrian Georgescu
  Connect two slots on the conference bridge, making audio flow from {{{src_slot}}} to {{{dst_slot}}}.
2550 1 Adrian Georgescu
2551 103 Adrian Georgescu
 '''disconnect_slots'''(''self'', '''src_slot''', '''dst_slot''')::
2552 103 Adrian Georgescu
  Break the connection between the specified slots.
2553 103 Adrian Georgescu
  Note that when an audio object is stopped or destroyed, its connections on the conference bridge will automatically be removed.
2554 103 Adrian Georgescu
2555 1 Adrian Georgescu
==== attributes ====
2556 1 Adrian Georgescu
2557 99 Adrian Georgescu
2558 103 Adrian Georgescu
 '''input_device'''::
2559 103 Adrian Georgescu
  A string specifying the audio input device that is currently being used.
2560 103 Adrian Georgescu
  If there is no input device, this attribute will be {{{None}}}.
2561 103 Adrian Georgescu
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
2562 1 Adrian Georgescu
2563 103 Adrian Georgescu
 '''output_device'''::
2564 103 Adrian Georgescu
  A string specifying the audio output device that is currently being used.
2565 103 Adrian Georgescu
  If there is no output device, this attribute will be {{{None}}}.
2566 103 Adrian Georgescu
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
2567 1 Adrian Georgescu
2568 103 Adrian Georgescu
 '''sample_rate'''::
2569 103 Adrian Georgescu
  The sample rate in Hz that the conference bridge is currently operating on.
2570 103 Adrian Georgescu
  This read-only attribute is passed when the object is created.
2571 99 Adrian Georgescu
2572 103 Adrian Georgescu
 '''ec_tail_length'''::
2573 103 Adrian Georgescu
  The current echo cancellation tail length in ms.
2574 103 Adrian Georgescu
  If this value is 0, no echo cancellation is used.
2575 103 Adrian Georgescu
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
2576 1 Adrian Georgescu
2577 103 Adrian Georgescu
 '''slot_count'''::
2578 103 Adrian Georgescu
  The total number of slots that is available on the conference bridge
2579 103 Adrian Georgescu
  This read-only attribute is passed when the object is created.
2580 1 Adrian Georgescu
2581 103 Adrian Georgescu
 '''used_slot_count'''::
2582 103 Adrian Georgescu
  A read-only attribute indicating the number of slots that are used by objects.
2583 1 Adrian Georgescu
2584 103 Adrian Georgescu
 '''input_volume'''::
2585 103 Adrian Georgescu
  This writable property indicates the % of volume that is read from the audio input device.
2586 103 Adrian Georgescu
  By default this value is 100.
2587 1 Adrian Georgescu
2588 103 Adrian Georgescu
 '''output_volume'''::
2589 103 Adrian Georgescu
  This writable property indicates the % of volume that is sent to the audio output device.
2590 103 Adrian Georgescu
  By default this value is 100.
2591 1 Adrian Georgescu
2592 103 Adrian Georgescu
 '''muted'''::
2593 103 Adrian Georgescu
  This writable boolean property indicates if the input audio device is muted.
2594 1 Adrian Georgescu
2595 103 Adrian Georgescu
 '''connected_slots'''::
2596 103 Adrian Georgescu
  A read-only list of tupples indicating which slot is connected to which.
2597 103 Adrian Georgescu
  Connections are directional.
2598 1 Adrian Georgescu
2599 103 Adrian Georgescu
=== MixerPort ===
2600 1 Adrian Georgescu
2601 103 Adrian Georgescu
This a simple object which simply copies all the audio data it gets as input to it output. It's main purpose is that of facilitating the creation the of the middleware {{{AudioBridge}}} object.
2602 1 Adrian Georgescu
2603 103 Adrian Georgescu
==== methods ====
2604 1 Adrian Georgescu
2605 1 Adrian Georgescu
2606 103 Adrian Georgescu
 '''!__init!__'''(''self'', ''mixer'')::
2607 103 Adrian Georgescu
  Create a new MixerPort which is associated with the specified AudioMixer.
2608 1 Adrian Georgescu
2609 103 Adrian Georgescu
 '''start'''(''self'')::
2610 103 Adrian Georgescu
  Activate the mixer port. This will reserve a slot on the AudioMixer and allow it to be connected to other slots.
2611 78 Ruud Klaver
2612 103 Adrian Georgescu
 '''stop'''(''self'')::
2613 103 Adrian Georgescu
  Deactivate the mixer port. This will release the slot previously allocated on the AudioMixer and all connections which it had will be discarded.
2614 78 Ruud Klaver
2615 103 Adrian Georgescu
==== attributes ====
2616 78 Ruud Klaver
2617 103 Adrian Georgescu
2618 103 Adrian Georgescu
 '''mixer'''::
2619 103 Adrian Georgescu
  The AudioMixer this MixerPort is associated with
2620 103 Adrian Georgescu
  This attribute is read-only.
2621 103 Adrian Georgescu
2622 103 Adrian Georgescu
 '''is_active'''::
2623 103 Adrian Georgescu
  Whether or not this MixerPort has a slot associated in its AudioMixer.
2624 103 Adrian Georgescu
  This attribute is read-only.
2625 103 Adrian Georgescu
2626 103 Adrian Georgescu
 '''slot'''::
2627 103 Adrian Georgescu
  The slot this MixerPort has reserved on AudioMixer or {{{None}}} if it is not active.
2628 103 Adrian Georgescu
  This attribute is read-only.
2629 103 Adrian Georgescu
2630 103 Adrian Georgescu
2631 103 Adrian Georgescu
=== WaveFile ===
2632 103 Adrian Georgescu
2633 103 Adrian Georgescu
This is a simple object that allows playing back of a {{{.wav}}} file over the PJSIP conference bridge.
2634 103 Adrian Georgescu
Only 16-bit PCM and A-law/U-law formats are supported.
2635 103 Adrian Georgescu
Its main purpose is the playback of ringtones or previously recorded conversations.
2636 103 Adrian Georgescu
2637 103 Adrian Georgescu
This object is associated with a {{{AudioMixer}}} instance and, once the {{{start()}}} method is called, connects to it and sends the sound to all its connections.
2638 103 Adrian Georgescu
Note that the slot of the {{{WaveFile}}} object will not start playing until it is connected to another slot on the AudioMixer.
2639 103 Adrian Georgescu
If the {{{stop()}}} method is called or the end of the {{{.wav}}} file is reached, a {{{WaveFileDidFinishPlaying}}} notification is sent by the object.
2640 103 Adrian Georgescu
After this the {{{start()}}} method may be called again in order to re-use the object.
2641 103 Adrian Georgescu
2642 103 Adrian Georgescu
It is the application's responsibility to keep a reference to the {{{WaveFile}}} object for the duration of playback.
2643 103 Adrian Georgescu
If the reference count of the object reaches 0, playback will be stopped automatically.
2644 103 Adrian Georgescu
In this case no notification will be sent.
2645 103 Adrian Georgescu
2646 78 Ruud Klaver
==== methods ====
2647 99 Adrian Georgescu
2648 95 Luci Stanescu
2649 103 Adrian Georgescu
 '''!__init!__'''(''self'', '''mixer''', '''filename''')::
2650 103 Adrian Georgescu
  Creates a new {{{WaveFile}}} object.
2651 103 Adrian Georgescu
  [[BR]]''mixer'':[[BR]]
2652 103 Adrian Georgescu
  The {{{AudioMixer}}} object that this object is to be connected to.
2653 103 Adrian Georgescu
  [[BR]]''filename'':[[BR]]
2654 103 Adrian Georgescu
  The name of the {{{.wav}}} file to be played back as a string.
2655 103 Adrian Georgescu
  This should include the full path to the file.
2656 95 Luci Stanescu
2657 103 Adrian Georgescu
 '''start'''(''self'')::
2658 103 Adrian Georgescu
  Start playback of the {{{.wav}}} file.
2659 95 Luci Stanescu
2660 103 Adrian Georgescu
 '''stop'''(''self'')::
2661 103 Adrian Georgescu
  Stop playback of the file.
2662 95 Luci Stanescu
2663 103 Adrian Georgescu
==== attributes ====
2664 78 Ruud Klaver
2665 78 Ruud Klaver
2666 103 Adrian Georgescu
 '''mixer'''::
2667 103 Adrian Georgescu
  The {{{AudioMixer}}} this object is associated with.
2668 103 Adrian Georgescu
  This attribute is read-only.
2669 1 Adrian Georgescu
2670 103 Adrian Georgescu
 '''filename'''::
2671 103 Adrian Georgescu
  The name of the {{{.wav}}} file, as specified when the object was created.
2672 103 Adrian Georgescu
  This attribute is read-only.
2673 103 Adrian Georgescu
2674 103 Adrian Georgescu
 '''slot'''::
2675 103 Adrian Georgescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
2676 103 Adrian Georgescu
  If the {{{WaveFile}}} is not active, this attribute will be {{{None}}}.
2677 103 Adrian Georgescu
2678 103 Adrian Georgescu
 '''volume'''::
2679 103 Adrian Georgescu
  A writable property indicating the % of volume at which this object contributes audio to the AudioMixer.
2680 103 Adrian Georgescu
  By default this is set to 100.
2681 103 Adrian Georgescu
2682 103 Adrian Georgescu
 '''is_active'''::
2683 103 Adrian Georgescu
  A boolean read-only property that indicates if the file is currently being played.
2684 103 Adrian Georgescu
2685 95 Luci Stanescu
==== notifications ====
2686 95 Luci Stanescu
2687 99 Adrian Georgescu
2688 103 Adrian Georgescu
 '''WaveFileDidFinishPlaying'''::
2689 103 Adrian Georgescu
  This notification will be sent whenever playing of the {{{.wav}}} has stopped.
2690 103 Adrian Georgescu
  After sending this event, the playback may be re-started.
2691 95 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
2692 95 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2693 99 Adrian Georgescu
2694 103 Adrian Georgescu
=== RecordingWaveFile ===
2695 103 Adrian Georgescu
2696 103 Adrian Georgescu
This is a simple object that allows recording audio to a PCM {{{.wav}}} file.
2697 103 Adrian Georgescu
2698 103 Adrian Georgescu
This object is associated with a {{{AudioMixer}}} instance and, once the {{{start()}}} method is called, crecords sound from its connections.
2699 103 Adrian Georgescu
Note that the {{{RecordingWaveFile}}} will not record anything if it does not have any connections.
2700 103 Adrian Georgescu
Recording to the file can be stopped either by calling the {{{stop()}}} method or by removing all references to the object.
2701 103 Adrian Georgescu
Once the {{{stop()}}} method has been called, the {{{start()}}} method may not be called again.
2702 103 Adrian Georgescu
It is the application's responsibility to keep a reference to the {{{RecordingWaveFile}}} object for the duration of the recording, it will be stopped automatically when the reference count reaches 0.
2703 103 Adrian Georgescu
2704 103 Adrian Georgescu
==== methods ====
2705 103 Adrian Georgescu
2706 103 Adrian Georgescu
2707 103 Adrian Georgescu
 '''!__init!__'''(''self'', '''mixer''', '''filename''')::
2708 103 Adrian Georgescu
  Creates a new {{{RecordingWaveFile}}} object.
2709 103 Adrian Georgescu
  [[BR]]''mixer'':[[BR]]
2710 103 Adrian Georgescu
  The {{{AudioMixer}}} object that this object is to be associated with.
2711 103 Adrian Georgescu
  [[BR]]''filename'':[[BR]]
2712 103 Adrian Georgescu
  The name of the {{{.wav}}} file to record to as a string.
2713 103 Adrian Georgescu
  This should include the full path to the file.
2714 103 Adrian Georgescu
2715 103 Adrian Georgescu
 '''start'''(''self'')::
2716 103 Adrian Georgescu
  Start recording the sound to the {{{.wav}}} file.
2717 103 Adrian Georgescu
2718 103 Adrian Georgescu
 '''stop'''(''self'')::
2719 103 Adrian Georgescu
  Stop recording to the file.
2720 103 Adrian Georgescu
2721 103 Adrian Georgescu
==== attributes ====
2722 103 Adrian Georgescu
2723 103 Adrian Georgescu
2724 103 Adrian Georgescu
 '''mixer'''::
2725 103 Adrian Georgescu
  The {{{AudioMixer}}} this object is associated with.
2726 103 Adrian Georgescu
  This attribute is read-only.
2727 103 Adrian Georgescu
2728 103 Adrian Georgescu
 '''filename'''::
2729 103 Adrian Georgescu
  The name of the {{{.wav}}} file, as specified when the object was created.
2730 103 Adrian Georgescu
  This attribute is read-only.
2731 103 Adrian Georgescu
2732 103 Adrian Georgescu
 '''slot'''::
2733 103 Adrian Georgescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
2734 103 Adrian Georgescu
  If the {{{RecordingWaveFile}}} is not active, this attribute will be {{{None}}}.
2735 103 Adrian Georgescu
2736 103 Adrian Georgescu
 '''is_active'''::
2737 103 Adrian Georgescu
  A boolean read-only attribute that indicates if the file is currently being written to.
2738 103 Adrian Georgescu
2739 103 Adrian Georgescu
=== ToneGenerator ===
2740 103 Adrian Georgescu
2741 103 Adrian Georgescu
A {{{ToneGenerator}}} can generate a series of dual frequency tones and has a shortcut method for generating valid DTMF tones.
2742 103 Adrian Georgescu
Each instance of this object is associated with a {{{AudioMixer}}} object, which it will connect to once started.
2743 103 Adrian Georgescu
The tones will be sent to the slots on the AudioMixer its slot is connected to.
2744 103 Adrian Georgescu
Once started, a {{{ToneGenerator}}} can be stopped by calling the {{{stop()}}} method and is automatically destroyed when the reference count reaches 0.
2745 103 Adrian Georgescu
2746 103 Adrian Georgescu
> Note: this object has threading issues when the application uses multiple AudioMixers. It should not be used.
2747 103 Adrian Georgescu
2748 103 Adrian Georgescu
==== methods ====
2749 103 Adrian Georgescu
2750 103 Adrian Georgescu
2751 103 Adrian Georgescu
 '''!__init!__'''(''self'', '''mixer''')::
2752 103 Adrian Georgescu
  Creates a new {{{ToneGenerator}}} object.
2753 103 Adrian Georgescu
  [[BR]]''mixer'':[[BR]]
2754 103 Adrian Georgescu
  The {{{AudioMixer}}} object that this object is to be connected to.
2755 103 Adrian Georgescu
2756 103 Adrian Georgescu
 '''start'''(''self'')::
2757 103 Adrian Georgescu
  Start the tone generator and connect it to its associated {{{AudioMixer}}}.
2758 103 Adrian Georgescu
2759 103 Adrian Georgescu
 '''stop'''(''self'')::
2760 103 Adrian Georgescu
  Stop the tone generator and remove it from the conference bridge.
2761 103 Adrian Georgescu
2762 103 Adrian Georgescu
 '''play_tones(''self'', '''tones''')::
2763 103 Adrian Georgescu
  Play a sequence of single or dual frequency tones over the audio device.
2764 103 Adrian Georgescu
  [[BR]]''tones'':[[BR]]
2765 103 Adrian Georgescu
  This should be a list of 3-item tuples, in the form of {{{[(<freq1>, <freq2>, <duration>), ...]}}}, with Hz as unit for the frequencies and ms as unit for the duration.
2766 103 Adrian Georgescu
  If {{{freq2}}} is 0, this indicates that only {{{freq1}}} should be used for the tone.
2767 103 Adrian Georgescu
  If {{{freq1}}} is 0, this indicates a pause when no tone should be played for the set duration.
2768 103 Adrian Georgescu
2769 103 Adrian Georgescu
 '''play_dtmf(''self'', '''digit''')::
2770 103 Adrian Georgescu
  Play a single DTMF digit.
2771 103 Adrian Georgescu
  [[BR]]''digit'':[[BR]]
2772 103 Adrian Georgescu
  A string of length 1 containing a valid DTMF digit, i.e. 0 through 9, #, * or A through D.
2773 103 Adrian Georgescu
2774 103 Adrian Georgescu
==== attributes ====
2775 103 Adrian Georgescu
2776 103 Adrian Georgescu
2777 103 Adrian Georgescu
 '''mixer'''::
2778 103 Adrian Georgescu
  The {{{AudioMixer}}} this object is associated with.
2779 103 Adrian Georgescu
  This attribute is read-only.
2780 103 Adrian Georgescu
2781 103 Adrian Georgescu
 '''slot'''::
2782 103 Adrian Georgescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
2783 103 Adrian Georgescu
  If the {{{ToneGenerator}}} has not been started, this attribute will be {{{None}}}.
2784 103 Adrian Georgescu
2785 103 Adrian Georgescu
 '''volume'''::
2786 103 Adrian Georgescu
  A writable property indicating the % of volume at which this object contributes audio.
2787 103 Adrian Georgescu
  By default this is set to 100.
2788 103 Adrian Georgescu
2789 103 Adrian Georgescu
 '''is_active'''::
2790 103 Adrian Georgescu
  A boolean read-only property that indicates if the object has been started.
2791 103 Adrian Georgescu
2792 103 Adrian Georgescu
 '''is_busy'''::
2793 103 Adrian Georgescu
  A boolean read-only property indicating if the {{{ToneGenerator}}} is busy playing tones.
2794 103 Adrian Georgescu
2795 103 Adrian Georgescu
==== notifications ====
2796 103 Adrian Georgescu
2797 103 Adrian Georgescu
 '''ToneGeneratorDidFinishPlaying'''::
2798 103 Adrian Georgescu
  This notification will be sent whenever playing of the queued tones has finished.
2799 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2800 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.