SIP SIMPLE Client SDK

= Middleware API =

<abbr title="WikiStart, Sip*, depth=3">TOC</abbr>

This chapter describes the event driven ''Middleware API'' that can be used by a developer to build a user interface for SIP SIMPLE client SDK.

• For sub-systems communications the Middleware uses the [http://pypi.python.org/pypi/python-application/ Notification Bus] provided by [http://pypi.python.org/pypi/python-application/ python-application]
• For configuration the Middleware uses the [wiki:SipConfigurationAPI Configuration API] to access General and SIP account settings

To see a working example for how to use Middleware, see the [http://sipsimpleclient.com/wiki/SipTesting#TestingGuide Command Line Tools] provided with the library.

Image(sipsimple-middleware.png, align=center, width=800)

Lookup support

The SIP SIMPLE middleware offers the {{{sipsimple.lookup}}} module which contains an implementation for doing DNS lookups for SIP proxies, MSRP relays and STUN servers. The interface offers both an asynchronous and synchronous interface. The asynchronous interface is based on notifications, while the synchronous one on green threads. In order to call the methods in a asynchronous manner, you just need to call the method and wait for the notification which is sent on behalf of the DNSLookup instance. The notifications sent by the DNSLookup object are DNSLookupDidSucceed and DNSLookupDidFail. In order to call the methods in a synchronous manner, you need to call the wait method on the object returned by the methods of DNSLookup. This wait method needs to be called from a green thread and will either return the result of the lookup or raise an exception.

=== DNS Lookup ===

This object implements DNS lookup support for SIP proxies according to RFC3263 and MSRP relay and STUN server lookup using SRV records. The object initially does NS record queries in order to determine the authoritative nameservers for the domain requested; these authoritative nameservers will then be used for NAPTR, SRV and A record queries. If this fails, the locally configured nameservers are used. The reason for doing this is that some home routers have broken NAPTR and/or SRV query support.

==== methods ====

'''!__init!__'''(''self'')::
  Instantiate a new DNSLookup object.
 '''lookup_service'''(''self'', '''uri''', '''service''', '''timeout'''={{{3.0}}}, '''lifetime'''={{{15.0}}})::
  Perform an SRV lookup followed by A lookups for MSRP relays or STUN servers depending on the {{{service}}} parameter. If SRV queries on the {{{uri.host}}} domain fail, an A lookup is performed on it and the default port for the service is returned. Only the {{{uri.host}}} attribute is used. The return value is a list of (host, port) tuples.
  [[BR]]uri:[[BR]]
  A {{{(Frozen)SIPURI}}} from which the {{{host}}} attribute is used for the query domain.
  [[BR]]service:[[BR]]
  The service to lookup servers for, {{{"msrprelay"}}} or {{{"stun"}}}.
  [[BR]]timeout:[[BR]]
  How many seconds to wait for a response from a nameserver.
  [[BR]]lifetime:[[BR]]
  How many seconds to wait for a response from all nameservers in total.
 '''lookup_sip_proxy'''(''self'', '''uri''', '''supported_transports''', '''timeout'''={{{3.0}}}, '''lifetime'''={{{15.0}}})::
  Perform a RFC3263 compliant DNS lookup for a SIP proxy using the URI which is considered to point to a host if either the {{{host}}} attribute is an IP address, or the {{{port}}} is present. Otherwise, it is considered a domain for which NAPTR, SRV and A lookups are performed. If NAPTR or SRV queries fail, they fallback to using SRV and A queries. If the transport parameter is present in the URI, this will be used as far as it is part of the supported transports. If the URI has a {{{sips}}} schema, then only the TLS transport will be used as far as it doesn't conflict with the supported transports or the transport parameter. The return value is a list of {{{Route}}} objects containing the IP address, port and transport to use for routing in the order of preference given by the supported_transports argument.
  [[BR]]uri:[[BR]]
  A {{{(Frozen)SIPURI}}} from which the {{{host}}}, {{{port}}}, {{{parameters}}} and {{{secure}}} attributes are used.
  [[BR]]supported_transports:[[BR]]
  A sublist of {{{['udp', 'tcp', 'tls']}}} in the application's order of preference.
  [[BR]]timeout:[[BR]]
  How many seconds to wait for a response from a nameserver.
  [[BR]]lifetime:[[BR]]
  How many seconds to wait for a response from all nameservers in total.

==== notifications ====

'''DNSLookupDidSucceed'''::
  This notification is sent when one of the lookup methods succeeds in finding a result.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]result:[[BR]]
  The result of the DNS lookup in the format described in each method.
 '''DNSLookupDidFail'''::
  This notification is sent when one of the lookup methods fails in finding a result.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]error:[[BR]]
  A {{{str}}} object describing the error which resulted in the DNS lookup failure.
 '''DNSLookupTrace'''::
  This notification is sent several times during a lookup process for each individual DNS query.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]query_type:[[BR]]
  The type of the query, {{{"NAPTR"}}}, {{{"SRV"}}}, {{{"A"}}}, {{{"NS"}}} etc.
  [[BR]]query_name:[[BR]]
  The name which was queried.
  [[BR]]answer:[[BR]]
  The answer returned by dnspython, or {{{None}}} if an error occurred.
  [[BR]]error:[[BR]]
  The exception which caused the query to fail, or {{{None}}} if no error occurred.
  [[BR]]context:[[BR]]
  The name of the method which was called on the {{{DNSLookup}}} object.
  [[BR]]service:[[BR]]
  The service which was queried for, only available when context is {{{"lookup_service"}}}.
  [[BR]]uri:[[BR]]
  The uri which was queried for.

=== Route ===

This is a convinience object which contains sufficient information to identify a route to a SIP proxy. This object is returned by {{{DNSLookup.lookup_sip_proxy}}} and can be used with the {{{Session}}} or a {{{(Frozen)RouteHeader}}} can be easily constructed from it to pass to one of the objects in the SIP core handling SIP dialogs/transactions ({{{Invitation}}}, {{{Subscription}}}, {{{Request}}}, {{{Registration}}}, {{{Message}}}, {{{Publication}}}). This object has three attributes which can be set in the constructor or after it was instantiated. They will only be documented as arguments to the constructor.

==== methods ====

'''!__init!__'''(''self'', '''address''', '''port'''=None, '''transport'''={{{'udp'}}})::
  Creates the Route object with the specified parameters as attributes.
  Each of these attributes can be accessed on the object once instanced.
  [[BR]]''address'':[[BR]]
  The IPv4 address that the request in question should be sent to as a string.
  [[BR]]''port'':[[BR]]
  The port to send the requests to, represented as an int, or None if the default port is to be used.
  [[BR]]''transport'':[[BR]]
  The transport to use, this can be a string of either "udp", "tcp" or "tls" (case insensitive).
 '''get_uri'''(''self'')::
  Returns a {{{SIPURI}}} object which contains the adress, port and transport as parameter. This can be used to easily construct a {{{RouteHeader}}}:
 {{{
    route = Route("1.2.3.4", port=1234, transport="tls")
    route_header = RouteHeader(route.get_uri())
  }}}

High-level audio API

The high-level audio API hides the complexity of using the low-level PJMEDIA interface. This is implemented in the {{{sipsimple.audio}}} module and contains the following components: * IAudioPort: an interface describing an object capable of producing and/or consuming audio data. * AudioDevice: an object conforming to the IAudioPort interface which describes a physical audio device. * AudioBridge: a collection of objects conforming to IAudioPort which connects all of them in a full mesh. * WavePlayer: an object conforming to the IAudioPort interface which can playback the audio data from a {{{.wav}}} file. * WaveRecorder: an object conforming to the IAudioPort interface which can record audio data to a {{{.wav}}} file.

=== IAudioPort ===

The IAudioPort interface describes an object capable of producing and/or consuming audio data. This can be a dynamic object, which changes its role during its lifetime and notifies such changes using a notification, which is part of the interface.

==== attributes ====

'''mixer'''::
  The {{{AudioMixer}}} this audio object is connected to. Only audio objects connected to the same mixer will be able to send audio data from one to another.
 '''consumer_slot'''::
  An integer representing the slot (see [wiki:SipCoreApiDocumentation#AudioMixer AudioMixer]) which this object uses to consume audio data, or {{{None}}} if this object is not a consumer.
 '''producer_slot'''::
  An integer representing the slot (see [wiki:SipCoreApiDocumentation#AudioMixer AudioMixer]) which this object uses to produce audio data, or {{{None}}} if this object is not a producer.

==== notifications ====

'''AudioPortDidChangeSlots'''::
  This notification needs to be sent by implementations of this interface when the slots it has change, so as to let the {{{AudioBridges}}} it is part of know that reconnections need to be made.
  [[BR]]consumer_slot_changed:[[BR]]
  A bool indicating whether the consumer slot was changed.
  [[BR]]producer_slot_changed:[[BR]]
  A bool indicating whether the producer slot was changed.
  [[BR]]old_consumer_slot:[[BR]]
  The old slot for consuming audio data. Only required if consumer_slot_changed is {{{True}}}.
  [[BR]]new_consumer_slot:[[BR]]
  The new slot for consuming audio data. Only required if consumer_slot_changed is {{{True}}}.
  [[BR]]old_producer_slot:[[BR]]
  The old slot for producing audio data. Only required if producer_slot_changed is {{{True}}}.
  [[BR]]new_producer_slot:[[BR]]
  The new slot for producing audio data. Only required if producer_slot_changed is {{{True}}}.

=== AudioDevice ===

The AudioDevice represents the physical audio device which is part of a {{{AudioMixer}}}, implementing the {{{IAudioPort}}} interface. As such, it can be uniquely identified by the mixer it represents.

==== methods ====

'''!__init!__'''(''self'', '''mixer''', '''input_muted'''={{{False}}}, '''output_muted'''={{{False}}}):
  Instantiates a new AudioDevice which represents the physical device associated with the specified {{{AudioMixer}}}.
  [[BR]]mixer:[[BR]]
  The {{{AudioMixer}}} whose physical device this object represents.
  [[BR]]input_muted:[[BR]]
  A boolean which indicates whether this object should act as a producer of audio data.
  [[BR]]output_muted:[[BR]]
  A boolean which indicates whether this object should act as a consumer of audio data.

==== attributes ====

'''input_muted'''::
  A writable property which controls whether this object should act as a producer of audio data. An {{{AudioPortDidChange}}} slots notification is sent when this attribute is changed to force connections to be reconsidered within the {{{AudioBridges}}} this object is part of.
 '''output_muted'''::
  A writable property which controls whether this object should act as a consumer of audio data. An {{{AudioPortDidChange}}} slots notification is sent when this attribute is changed to force connections to be reconsidered within  the {{{AudioBridges}}} this object is part of.

=== AudioBridge ===

The {{{AudioBridge}}} is the basic component which is able to connect {{{IAudioPort}}} implementations. It acts as a container which connects as the producers to all the consumers which are part of it. An object which is both a producer and a consumer of audio data will not be connected to itself. Being an implementation of {{{IAudioPort}}} itself, an {{{AudioBridge}}} can be part of another {{{AudioBridge}}}. The {{{AudioBridge}}} does not keep strong references to the ports it contains and once the port's reference count reaches 0, it is automatically removed from the {{{AudioBridge}}}.

Note: although this is not enforced, there should never be any cycles when connecting {{{AudioBridges}}}.

==== methods ====

'''!__init!__'''(''self'', '''mixer''')::
  Instantiate a new {{{AudioBridge}}} which uses the specified {{{AudioMixer}}} for mixing.
 '''add'''(''self'', '''port''')::
  Add an implementation of {{{IAudioPort}}} to this AudioBridge. This will connect the new port to all the existing ports of the bridge. A port cannot be added more than once to an {{{AudioBridge}}}; thus, this object acts like a set.
 '''remove'''(''self'', '''port''')::
  Remove a port from this {{{AudioBridge}}}. The port must have previously been added to the {{{AudioBridge}}}, otherwise a {{{ValueError}}} is raised.

=== WavePlayer ===

A {{{WavePlayer}}} is an implementation of {{{IAudioPort}}} which is capable of producing audio data read from a {{{.wav}}} file. This object is completely reusable, as it can be started and stopped any number of times.

==== methods ====

'''!__init!__'''(''self'', '''mixer''', '''filename''', '''volume'''={{{100}}}, '''loop_count'''={{{1}}}, '''pause_time'''={{{0}}}, '''initial_play'''={{{True}}})::
  Instantiate a new {{{WavePlayer}}} which is capable of playing a {{{.wav}}} file repeatedly. All the parameters are available as attributes of the object, but should not be changed once the object has been started.
  [[BR]]mixer:[[BR]]
  The {{{AudioMixer}}} this object is connected to.
  [[BR]]filename:[[BR]]
  The full path to the {{{.wav}}} file from which audio data is to be read.
  [[BR]]volume:[[BR]]
  The volume at which the file should be played.
  [[BR]]loop_count:[[BR]]
  The number of times the file should be played, or {{{0}}} for infinity.
  [[BR]]pause_time:[[BR]]
  How many seconds to wait between successive plays of the file. 
  [[BR]]initial_play:[[BR]]
  Whether or not the file to play once the {{{WavePlayer}}} is started, or to wait {{{pause_time}}} seconds before the first play.
 '''start'''(''self'')::
  Start playing the {{{.wav}}} file.
 '''stop'''(''self'')::
  Stop playuing the {{{.wav}}} file immediately.

==== attributes ====

'''is_active'''::
  A boolean indicating whether or not this {{{WavePlayer}}} is currently playing.

==== notifications ====

'''WavePlayerDidStart'''::
  This notification is sent when the {{{WavePlayer}}} starts playing the file the first time after the {{{start()}}} method has been called.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''WavePlayerDidEnd'''::
  This notification is sent when the {{{WavePlayer}}} is done playing either as a result of playing the number of times it was told to, or because the {{{stop()}}} method has been called.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''WavePlayerDidFail'''::
  This notification is sent when the {{{WavePlayer}}} is not capable of playing the {{{.wav}}} file.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]error:[[BR]]
  The exception raised by the {{{WaveFile}}} which identifies the cause for not being able to play the {{{.wav}}} file.

=== WaveRecorder ===

A {{{WaveRecorder}}} is an implementation of {{{IAudioPort}}} is is capable of consuming audio data and writing it to a {{{.wav}}} file. Just like {{{WavePlayer}}}, this object is reusable: once stopped it can be started again, but if the filename attribute is not changed, the previously written file will be overwritten.

==== methods ====

'''!__init!__'''(''self'', '''mixer''', '''filename''')::
  Instantiate a new {{{WaveRecorder}}}.
  [[BR]]mixer:[[BR]]
  The {{{AudioMixer}}} this {{{WaveRecorder}}} is connected to.
  [[BR]]filename:[[BR]]
  The full path to the {{{.wav}}} file where this object should write the audio data. The file must be writable. The directories up to the file will be created if possible when the {{{start()}}} method is called.
 '''start'''(''self'')::
  Start consuming audio data and writing it to the {{{.wav}}} file. If this object is not part of an {{{AudioBridge}}}, not audio data will be written.
 '''stop'''(''self'')::
  Stop consuming audio data and close the {{{.wav}}} file.

==== attributes ====

'''is_active'''::
  A boolean indicating whether or not this {{{WaveRecorder}}} is currently recording audio data.

SIPApplication

Implemented in [browser:sipsimple/application.py]

Implements a high-level application responsable for starting and stopping various sub-systems required to implement a fully featured SIP User Agent application. The SIPApplication class is a Singleton and can be instantiated from any part of the code, obtaining a reference to the same object. The SIPApplication takes care of initializing the following components: * the twisted thread * the configuration system, via the [wiki:SipConfigurationAPI#ConfigurationManager ConfigurationManager]. * the core [wiki:SipCoreApiDocumentation#Engine Engine] using the settings in the configuration * the [wiki:SipMiddlewareApi#AccountManager AccountManager], using the accounts in the configuration * the [wiki:SipMiddlewareApi#SessionManager SessionManager], in order to handle incoming sessions * two [wiki:SipMiddlewareApi#AudioBridge AudioBridges], using the settings in the configuration

The attributes in this class can be set and accessed on both this class and its subclasses, as they are implemented using descriptors which keep single value for each attribute, irrespective of the class from which that attribute is set/accessed. Usually, all attributes should be considered read-only.

=== Methods ===

'''!__init!__'''(''self'')::
  Instantiates a new SIPApplication.
 '''start'''(''self'', '''config_backend''')::
  Starts the {{{SIPApplication}}} which initializes all the components in the correct order. The {{{config_backend}}} is used to start the {{{ConfigurationManager}}}. If any error occurs with loading the configuration, the exception raised by the {{{ConfigurationManager}}} is propagated by this method and {{{SIPApplication}}} can be started again. After this, any fatal errors will result in the SIPApplication being stopped and unusable, which means the whole application will need to stop. This method returns as soon as the twisted thread has been started, which means the application must wait for the {{{SIPApplicationDidStart}}} notification in order to know that the application started.
 '''stop'''(''self'')::
  Stop all the components started by the SIPApplication. This method returns immediately, but a {{{SIPApplicationDidEnd}}} notification is sent when all the components have been stopped.

=== Attributes ===

'''running'''::
 {{{True}}} if the SIPApplication is running (it has been started and it has not been told to stop), {{{False}}} otherwise.
 '''alert_audio_mixer'''::
  The {{{AudioMixer}}} object created on the alert audio device as defined by the configuration (by SIPSimpleSettings.audio.alert_device).
 '''alert_audio_bridge'''::
  An {{{AudioBridge}}} where {{{IAudioPort}}} objects can be added to playback sound to the alert device.
 '''alert_audio_device'''::
  An {{{AudioDevice}}} which corresponds to the alert device as defined by the configuration. This will always be part of the alert_audio_bridge.
 '''voice_audio_mixer'''::
  The {{{AudioMixer}}} object created on the voice audio device as defined by the configuration (by SIPSimpleSettings.audio.input_device and SIPSimpleSettings.audio.output_device).
 '''voice_audio_bridge'''::
  An {{{AudioBridge}}} where {{{IAudioPort}}} objects can be added to playback sound to the output device or record sound from the input device.
 '''voice_audio_device'''::
  An {{{AudioDevice}}} which corresponds to the voice device as defined by the configuration. This will always be part of the voice_audio_bridge.

=== Notifications ===

'''SIPApplicationWillStart'''::
  This notification is sent just after the configuration has been loaded and the twisted thread started, but before any other components have been initialized.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''SIPApplicationDidStart'''::
  This notification is sent when all the components have been initialized. Note: it doesn't mean that all components have succeeded, for example, the account might not have registered by this time, but the registration process will have started.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''SIPApplicationWillEnd'''::
  This notification is sent as soon as the {{{stop()}}} method has been called.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''SIPApplicationDidEnd'''::
  This notification is sent when all the components have been stopped. All components have been given reasonable time to shutdown gracefully, such as the account unregistering. However, because of factors outside the control of the middleware, such as network problems, some components might not have actually shutdown gracefully; this is needed because otherwise the SIPApplication could hang indefinitely (for example because the system is no longer connected to a network and it cannot be determined when it will be again).
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''SIPApplicationFailedToStartTLS'''::
  This notification is sent when a problem arises with initializing the TLS transport. In this case, the Engine will be started without TLS support and this notification contains the error which identifies the cause for not being able to start the TLS transport.
  [[BR]]timestamp:[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]error:[[BR]]
  The exception raised by the Engine which identifies the cause for not being able to start the TLS transport.

SIP Sessions

SIP sessions are supported by the {{{sipsimple.session.Session}}} class and independent stream classes, which need to implement the {{{sipsimple.streams.IMediaStream}}} interface. The {{{Session}}} class takes care of the signalling, while the streams offer the actual media support which is negotiated by the {{{Session}}}. The streams which are implemented in the SIP SIMPLE middleware are provided in modules within the {{{sipsimple.streams}}} package, but they are accessible for import directly from {{{sipsimple.streams}}}. Currently, the middleware implements two types of streams, one for RTP data, with a concrete implementation in the {{{AudioStream}}} class, and one for MSRP sessions, with concrete implementations in the {{{ChatStream}}}, {{{FileTransferStream}}} and {{{DesktopSharingStream}}} classes. However, the application can provide its own stream implementation, provided they respect the {{{IMediaStream}}} interface.

=== Session ===

Image(sipsimple-session-state-machine.png, align=right, width=400)

Implemented in [browser:sipsimple/session.py]

A {{{sipsimple.session.Session}}} object represents a complete SIP session between the local and a remote endpoints. Both incoming and outgoing sessions are represented by this class.

A {{{Session}}} instance is a stateful object, meaning that it has a {{{state}}} attribute and that the lifetime of the session traverses different states, from session creation to termination.
State changes are triggered by methods called on the object by the application or by received network events.
These states and their transitions are represented in the following diagram:

Although these states are crucial to the correct operation of the {{{Session}}} object, an application using this object does not need to keep track of these states, as a set of notifications is also emitted, which provide all the necessary information to the application.

The {{{Session}}} is completely independent of the streams it contains, which need to be implementations of the {{{sipsimple.streams.IMediaStream}}} interface. This interface provides the API by which the {{{Session}}} communicates with the streams. This API should not be used by the application, unless it also provides stream implementations or a SIP INVITE session implementation.

==== methods ====

'''!__init!__'''(''self'', '''account''')::
  Creates a new {{{Session}}} object in the {{{None}}} state.
  [[BR]]''account'':[[BR]]
  The local account to be associated with this {{{Session}}}.
 '''connect'''(''self'', '''to_header''', '''routes''', '''streams''')::
  Will set up the {{{Session}}} as outbound and propose the new session to the specified remote party and move the state machine to the {{{outgoing}}} state.
  Before contacting the remote party, a {{{SIPSessionNewOutgoing}}} notification will be emitted.
  If there is a failure or the remote party rejected the offer, a {{{SIPSessionDidFail}}} notification will be sent.
  Any time a ringing indication is received from the remote party, a {{{SIPSessionGotRingIndication}}} notification is sent.
  If the remote party accepted the session, a {{{SIPSessionWillStart}}} notification will be sent, followed by a {{{SIPSessionDidStart}}} notification when the session is actually established.
  This method may only be called while in the {{{None}}} state.
  [[BR]]''to_header'':[[BR]]
  A {{{sipsimple.core.ToHeader}}} object representing the remote identity to initiate the session to.
  [[BR]]''routes'':[[BR]]
  An iterable of {{{sipsimple.util.Route}}} objects, specifying the IP, port and transport to the outbound proxy.
  These routes will be tried in order, until one of them succeeds.
  [[BR]]''streams'':[[BR]]
  A list of stream objects which will be offered to the remote endpoint.
 '''send_ring_indication'''(''self'')::
  Sends a 180 provisional response in the case of an incoming session.
 '''accept'''(''self'', '''streams''')::
  Calling this methods will accept an incoming session and move the state machine to the {{{accepting}}} state.
  When there is a new incoming session, a {{{SIPSessionNewIncoming}}} notification is sent, after which the application can call this method on the sender of the notification.
  After this method is called, {{{SIPSessionWillStart}}} followed by {{{SIPSessionDidStart}}} will be emitted, or {{{SIPSessionDidFail}}} on an error.
  This method may only be called while in the {{{incoming}}} state.
  [[BR]]''streams'':[[BR]]
  A list of streams which needs to be a subset of the proposed streams which indicates which streams are to be accepted. All the other proposed streams will be rejected.
 '''reject'''(''self'', '''code'''={{{603}}}, '''reason'''={{{None}}})::
  Reject an incoming session and move it to the {{{terminaing}}} state, which eventually leads to the {{{terminated}}} state.
  Calling this method will cause the {{{Session}}} object to emit a {{{SIPSessionDidFail}}} notification once the session has been rejected.
  This method may only be called while in the {{{incoming}}} state.
  [[BR]]''code'':[[BR]]
  An integer which represents the SIP status code in the response which is to be sent. Usually, this is either 486 (Busy) or 603 (Decline/Busy Everywhere).
  [[BR]]''reason'':[[BR]]
  The string which is to be sent as the SIP status reason in the response, or None if PJSIP's default reason for the specified code is to be sent.
 '''accept_proposal'''(''self'', '''streams''')::
  When the remote party proposes to add some new streams, signaled by the {{{SIPSessionGotProposal}}} notification, the application can use this method to accept the stream(s) being proposed.
  After calling this method a {{{SIPSessionGotAcceptProposal}}} notification is sent, unless an error occurs while setting up the new stream, in which case a {{{SIPSessionHadProposalFailure}}} notification is sent and a rejection is sent to the remote party. As with any action which causes the streams in the session to change, a {{{SIPSessionDidRenegotiateStreams}}} notification is also sent.
  This method may only be called while in the {{{received_proposal}}} state.
  [[BR]]''streams'':[[BR]]
  A list of streams which needs to be a subset of the proposed streams which indicates which streams are to be accepted. All the other proposed streams will be rejected.
 '''reject_proposal'''(''self'', '''code'''={{{488}}}, '''reason'''={{{None}}})::
  When the remote party proposes new streams that the application does not want to accept, this method can be used to reject the proposal, after which a {{{SIPSessionGotRejectProposal}}} or {{{SIPSessionHadProposalFailure}}} notification is sent.
  This method may only be called while in the {{{received_proposal}}} state.
  [[BR]]''code'':[[BR]]
  An integer which represents the SIP status code in the response which is to be sent. Usually, this is 488 (Not Acceptable Here).
  [[BR]]''reason'':[[BR]]
  The string which is to be sent as the SIP status reason in the response, or None if PJSIP's default reason for the specified code is to be sent.
 '''add_stream'''(''self'', '''stream''')::
  Proposes a new stream to the remote party.
  Calling this method will cause a {{{SIPSessionGotProposal}}} notification to be emitted.
  After this, the state machine will move into the {{{sending_proposal}}} state until either a {{{SIPSessionGotAcceptProposal}}}, {{{SIPSessionGotRejectProposal}}} or {{{SIPSessionHadProposalFailure}}} notification is sent, informing the application if the remote party accepted the proposal. As with any action which causes the streams in the session to change, a {{{SIPSessionDidRenegotiateStreams}}} notification is also sent.
  This method may only be called while in the {{{connected}}} state.
 '''remove_stream'''(''self'', '''stream''')::
  Stop the stream and remove it from the session, informing the remote party of this. Although technically this is also done via an SDP negotiation which may fail, the stream will always get remove (if the remote party refuses the re-INVITE, the result will be that the remote party will have a different view of the active streams than the local party).
  This method may only be called while in the {{{connected}}} state.
 '''cancel_proposal'''(''self'')::
  This method cancels a proposal of adding a stream to the session by sending a CANCEL request. A {{{SIPSessionGotRejectProposal}}} notification will be sent with code 487.
 '''hold'''(''self'')::
  Put the streams of the session which support the notion of hold on hold.
  This will cause a {{{SIPSessionDidChangeHoldState}}} notification to be sent.
  This method may be called in any state and will send the re-INVITE as soon as it is possible.
 '''unhold'''(''self'')::
  Take the streams of the session which support the notion of hold out of hold.
  This will cause a {{{SIPSessionDidChangeHoldState}}} notification to be sent.
  This method may be called in any state and will send teh re-INVITE as soon as it is possible.
 '''end'''(''self'')::
  This method may be called any time after the {{{Session}}} has started in order to terminate the session by sending a BYE request.
  Right before termination a {{{SIPSessionWillEnd}}} notification is sent, after termination {{{SIPSessionDidEnd}}} is sent.

==== attributes ====

'''state'''::
  The state the object is currently in, being one of the states from the diagram above.
 '''account'''::
  The {{{sipsimple.account.Account}}} or {{{sipsimple.account.BonjourAccount}}} object that the {{{Session}}} is associated with.
  On an outbound session, this is the account the application specified on object instantiation.
 '''direction'''::
  A string indicating the direction of the initial negotiation of the session.
  This can be either {{{None}}}, "incoming" or "outgoing".
 '''transport'''::
  A string representing the transport this {{{Session}}} is using: {{{"udp"}}}, {{{"tcp"}}} or {{{"tls"}}}.
 '''start_time'''::
  The time the session started as a {{{datetime.datetime}}} object, or {{{None}}} if the session was not yet started.
 '''stop_time'''::
  The time the session stopped as a {{{datetime.datetime}}} object, or {{{None}}} if the session has not yet terminated.
 '''on_hold'''::
  Boolean indicating whether the session was put on hold, either by the local or the remote party.
 '''remote_user_agent'''::
  A string indicating the remote user agent, if it provided one.
  Initially this will be {{{None}}}, it will be set as soon as this information is received from the remote party (which may be never).
 '''local_identity'''::
  The {{{sipsimple.core.FrozenFromHeader}}} or {{{sipsimple.core.FrozenToHeader}}} identifying the local party, if the session is active, {{{None}}} otherwise.
 '''remote_identity'''::
  The {{{sipsimple.core.FrozenFromHeader}}} or {{{sipsimple.core.FrozenToHeader}}} identifying the remote party, if the session is active, {{{None}}} otherwise.
 '''streams'''::
  A list of the currently active streams in the {{{Session}}}.
 '''proposed_streams'''::
  A list of the currently proposed streams in the {{{Session}}}, or {{{None}}} if there is no proposal in progress.

==== notifications ====

'''SIPSessionNewIncoming'''::
  Will be sent when a new incoming {{{Session}}} is received.
  The application should listen for this notification to get informed of incoming sessions.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''streams'':[[BR]]
  A list of streams that were proposed by the remote party.
 '''SIPSessionNewOutgoing'''::
  Will be sent when the applcation requests a new outgoing {{{Session}}}.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''streams'':[[BR]]
  A list of streams that were proposed to the remote party.
 '''SIPSessionGotRingIndication'''::
  Will be sent when an outgoing {{{Session}}} receives an indication that a remote device is ringing.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''SIPSessionGotProvisionalResponse'''::
  Will be sent whenever the {{{Session}}} receives a provisional response as a result of sending a (re-)INVITE.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''code'':[[BR]]
  The SIP status code received.
  [[BR]]''reason'':[[BR]]
  The SIP status reason received.
 '''SIPSessionWillStart'''::
  Will be sent just before a {{{Session}}} completes negotiation.
  In terms of SIP, this is sent after the final response to the {{{INVITE}}}, but before the {{{ACK}}}.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''SIPSessionDidStart'''::
  Will be sent when a {{{Session}}} completes negotiation and all the streams have started.
  In terms of SIP this is sent after the {{{ACK}}} was sent or received.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''streams'':[[BR]]
  The list of streams which now form the active streams of the {{{Session}}}.
 '''SIPSessionDidFail'''::
  This notification is sent whenever the session fails before it starts.
  The failure reason is included in the data attributes.
  This notification is never followed by {{{SIPSessionDidEnd}}}.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''originator'':[[BR]]
  A string indicating the originator of the {{{Session}}}. This will either be "local" or "remote".
  [[BR]]''code'':[[BR]]
  The SIP error code of the failure.
  [[BR]]''reason'':[[BR]]
  A SIP status reason.
  [[BR]]''failure_reason'':[[BR]]
  A string which represents the reason for the failure, such as {{{"user_request"}}}, {{{"missing ACK"}}}, {{{"SIP core error..."}}}.
 '''SIPSessionWillEnd'''::
  Will be sent just before terminating a {{{Session}}}.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''SIPSessionDidEnd'''::
  Will be sent always when a {{{Session}}} ends as a result of remote or local session termination.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''originator'':[[BR]]
  A string indicating who originated the termination. This will either be "local" or "remote".
  [[BR]]''end_reason'':[[BR]]
  A string representing the termination reason, such as {{{"user_request"}}}, {{{"SIP core error..."}}}.
 '''SIPSessionDidChangeHoldState'''::
  Will be sent when the session got put on hold or removed from hold, either by the local or the remote party.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''originator'':[[BR]]
  A string indicating who originated the hold request, and consequently in which direction the session got put on hold.
  [[BR]]''on_hold'':[[BR]]
 {{{True}}} if there is at least one stream which is on hold and {{{False}}} otherwise.
  [[BR]]''partial'':[[BR]]
 {{{True}}} if there is at least one stream which is on hold and one stream which supports hold but is not on hold and {{{False}}} otherwise.
 '''SIPSessionGotProposal'''::
  Will be sent when either the local or the remote party proposes to add streams to the session.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''originator'':[[BR]]
  The party that initiated the stream proposal, can be either "local" or "remote".
  [[BR]]''streams'':[[BR]]
  A list of streams that were proposed.
 '''SIPSessionGotRejectProposal'''::
  Will be sent when either the local or the remote party rejects a proposal to have streams added to the session.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''originator'':[[BR]]
  The party that initiated the stream proposal, can be either "local" or "remote".
  [[BR]]''code'':[[BR]]
  The code with which the proposal was rejected.
  [[BR]]''reason'':[[BR]]
  The reason for rejecting the stream proposal.
  [[BR]]''streams'':[[BR]]
  The list of streams which were rejected.
 '''SIPSessionGotAcceptProposal'''::
  Will be sent when either the local or the remote party accepts a proposal to have stream( added to the session.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''originator'':[[BR]]
  The party that initiated the stream proposal, can be either "local" or "remote".
  [[BR]]''streams'':[[BR]]
  The list of streams which were accepted.
 '''SIPSessionHadProposalFailure'''::
  Will be sent when a re-INVITE fails because of an internal reason (such as a stream not being able to start).
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''failure_reason'':[[BR]]
  The error which caused the proposal to fail.
  [[BR]]''streams'':[[BR]]
  THe streams which were part of this proposal.
 '''SIPSessionDidRenegotiateStreams'''::
  Will be sent when a media stream is either activated or deactivated.
  An application should listen to this notification in order to know when a media stream can be used.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''action'':[[BR]]
  A string which is either {{{"add"}}} or {{{"remove"}}} which specifies what happened to the streams the notificaton referes to
  [[BR]]''streams'':[[BR]]
  A list with the streams which were added or removed.
 '''SIPSessionDidProcessTransaction'''::
  Will be sent whenever a SIP transaction is complete in order to provide low-level details of the progress of the INVITE dialog.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''originator'':[[BR]]
  The initiator of the transaction, {{{"local"}}} or {{{"remote"}}}.
  [[BR]]''method'':[[BR]]
  The method of the request.
  [[BR]]''code'':[[BR]]
  The SIP status code of the response.
  [[BR]]''reason'':[[BR]]
  The SIP status reason of the response.
  [[BR]]''ack_received'':[[BR]]
  This attribute is only present for INVITE transactions and has one of the values {{{True}}}, {{{False}}} or {{{"unknown"}}}. The last value may occur then PJSIP does not let us know whether the ACK was received or not.

As an example for how to use the {{{Session}}} object, the following provides a basic Python program that initiates an outgoing SIP session request:

{{{
from threading import Event

from application.notification, NotificationCenter

from sipsimple.core import SIPURI, ToHeader

from sipsimple.account import AccountManager
from sipsimple.application import SIPApplication
from sipsimple.session import Session
from sipsimple.streams import AudioStream
from sipsimple.util import Route

class SimpleCallApplication(SIPApplication):
def init(self, callee, route):
SIPApplication.__init__(self)
self.ended = Event()
self.callee = calee
self.route = route
self.session = None
notification_center = NotificationCenter()
notification_center.add_observer(self)

def _NH_SIPApplicationDidStart(self, notification):
        account = AccountManager().default_account
        self.session = Session(account)
        self.session.connect(self.callee, self.route, AudioStream(account))

def _NH_SIPSessionGotRingIndication(self, notification):
        print 'Ringing!'

def _NH_SIPSessionDidStart(self, notification):
        print 'Session started!'

def _NH_SIPSessionDidFail(self, notification):
        print 'Failed to connect'
        self.stop()

def _NH_SIPSessionDidEnd(self, notification):
        print 'Session ended'
        self.stop()

def _NH_SIPApplicationDidEnd(self, notification):
        self.ended.set()

1. place an audio call from the specified account to the specified URI, through
2. the specified SIP proxy
   application = SimpleCallApplication(ToHeader(SIPURI), Route("1.2.3.4"))
3. block waiting for user input
   print "Placing call, press enter to quit program"
   raw_input()
   application.session.end()
4. block until the SIPApplication has stopped
   application.ended.wait()
   }}}

=== SessionManager ===

Implemented in [browser:sipsimple/session.py]

The {{{sipsimple.session.SessionManager}}} class is a singleton, which acts as the central aggregation point for sessions within the middleware.
Although it is mainly used internally, the application can use it to query information about all active sessions.
The SessionManager is implemented as a singleton, meaning that only one instance of this class exists within the middleware. The SessionManager is started by the SIPApplication and takes care of handling incoming sessions.

==== attributes ====

'''sessions'''::
  A property providing a copy of the list of all active {{{Sesssion}}} objects within the application, meaning any {{{Session}}} object that exists globally within the application and is not in the {{{NULL}}} or {{{TERMINATED}}} state.

==== methods ====

'''!__init!__'''(''self'')::
  Instantiate a new {{{SessionManager}}} object.

'''start'''(''self'')::
  Start the {{{SessionManager}}} in order to be able to handle incoming sessions.

IMediaStream

Implemented in [browser:sipsimple/streams/__init__.py]

This module automatically registers media streams to a stream registry
allowing for a plug and play mechanism of various types of media negoticated
in a SIP session that can be added to this library by using a generic API.

For actual usage see rtp.py and msrp.py that implement media streams based
on their respective RTP and MSRP protocols.

=== Atributes ===

'''type''' (class attribute)::
 A string identifying the stream type (ex: audio, video, ...)
 '''priority'''::
 An integer value indicating the stream priority relative to the other streams types (higher numbers have higher priority)
 '''hold_supported'''::
 True if the stream supports hold
 '''on_hold_by_local'''::
 True if the stream is on hold by the local party
 '''on_hold_by_remote'''::
 True if the stream is on hold by the remote
 '''on_hold'''::
 True if either on_hold_by_local or on_hold_by_remote is true

=== Methods ===

'''!__init!__'''(''self'', ''account'')::
 Initializes the generic stream instance.
 '''new_from_sdp'''(''cls'', ''account'', ''remote_sdp'', ''stream_index'')::
 '''get_local_media'''(''self'', ''for_offer'')::
 '''initialize'''(''self'', ''session'', ''direction'')::
 Initializes the stream 
 '''start'''(''self'', ''local_sdp'', ''remote_sdp'', ''stream_index'')::
 Completes the stream related connection. [[BR]]
 When done, must fire StreamChatDidStart notification. 
 '''end'''(''self'')::
 Ends the stream.  When done, must fire StreamChatDidEnd notification. 
 '''validate_update'''(''self'', ''remote_sdp'', ''stream_index'')::
 '''update'''(''self'', ''local_sdp'', ''remote_sdp'', ''stream_index'')::
 '''deactivate'''(''self'')::
 '''hold'''(''self'')::
 Puts the stream on hold if supported by the stream. Typically used by audio and video streams.
 '''unhold'''(''self'')::
 Takes the stream off hold.

=== Notifications ===

These notifications must be generated by all streams in order for the upper layer (SIP session) to perform the right decissions.

'''MediaStreamDidInitialize'''::
 Sent when the {{{Stream}}} instance is initialized
 '''MediaStreamDidStart'''::
 Sent when the {{{Stream}}} instance has started.
 '''MediaStreamDidFail'''::
 Sent when the {{{Stream}}} instance has failed.
 '''MediaStreamWillEnd'''::
 Sent before the {{{Stream}}} instance will end.
 '''MediaStreamDidEnd'''::
 Sent when the {{{Stream}}} instance did ended.

MediaStreamRegistry

The MediaStream registry is used to register streams that can be automatically dealt with by the SIP session layer.

There are several pre-built streams based on the '''iMediaStream''' API:

• {{{sipsimple.streams.msrp.MSRPStreamBase}}} - MSRP base stream, all MSRP derived streams inherit this
• {{{sipsimple.streams.msrp.ChatStream}}} - Chat stream based on MSRP
• {{{sipsimple.streams.msrp.FileSelector}}} - Helper for selecting a file for FileTransferStream
• {{{sipsimple.streams.msrp.FileTransferStream}}} - File Transfer stream based on MSRP
• {{{sipsimple.streams.msrp.VNCConnectionError}}} - Helper class for DesktopSharingStream
• {{{sipsimple.streams.msrp.DesktopSharingHandlerBase}}} - Helper class for DesktopSharingStream
• {{{sipsimple.streams.msrp.InternalVNCViewerHandler}}} - Helper class for DesktopSharingStream
• {{{sipsimple.streams.msrp.InternalVNCViewerHandler}}} - Helper class for DesktopSharingStream
• {{{sipsimple.streams.msrp.ExternalVNCViewerHandler}}} - Helper class for DesktopSharingStream
• {{{sipsimple.streams.msrp.ExternalVNCServerHandler}}} - Helper class for DesktopSharingStream
• {{{sipsimple.streams.msrp.DesktopSharingStream}}} - Desktop Sharing stream based on VNC over MSRP
• {{{sipsimple.streams.msrp.NotificationProxyLogger}}} - Helper class for handling MSRP library logs

These classes are used internally by [wiki:SipMiddlewareApi#Session Session], which provides the necessary methods to access their features. The notifications posted by these classes are also handled internally by [wiki:SipMiddlewareApi#Session Session]. The notifications that are relevant to the user are then reposted by the Session instance. Refer to [wiki:SipMiddlewareApi#Session Session documentation] for details on the Session API.

AudioStream

Implemented in [browser:sipsimple/streams/rtp.py]

=== SDP Example ===

{{{
Content-Type: application/sdp
Content-Length: 1093

v=0
o=- 3467525278 3467525278 IN IP4 192.168.1.6
s=blink-0.10.7-beta
c=IN IP4 80.101.96.20
t=0 0
m=audio 55328 RTP/AVP 104 103 102 3 9 0 8 101
a=rtcp:55329 IN IP4 80.101.96.20
a=rtpmap:104 speex/32000
a=rtpmap:103 speex/16000
a=rtpmap:102 speex/8000
a=rtpmap:3 GSM/8000
a=rtpmap:9 G722/8000
a=rtpmap:0 PCMU/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-15
a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:esI6DbLY1+Aceu0JNswN9Z10DcFx5cZwqJcu91jb
a=crypto:2 AES_CM_128_HMAC_SHA1_32 inline:SHuEMm1BYJqOF4udKl73EaCwnsI57pO86bYKsg70
a=ice-ufrag:2701ed80
a=ice-pwd:6f8f8281
a=candidate:S 1 UDP 31 80.101.96.20 55328 typ srflx raddr 192.168.1.6 rport 55328
a=candidate:H 1 UDP 23 192.168.1.6 55328 typ host
a=candidate:H 1 UDP 23 10.211.55.2 55328 typ host
a=candidate:H 1 UDP 23 10.37.129.2 55328 typ host
a=candidate:S 2 UDP 30 80.101.96.20 55329 typ srflx raddr 192.168.1.6 rport 55329
a=candidate:H 2 UDP 22 192.168.1.6 55329 typ host
a=candidate:H 2 UDP 22 10.211.55.2 55329 typ host
a=candidate:H 2 UDP 22 10.37.129.2 55329 typ host
a=sendrecv
}}}

=== Atributes ===

'''sample_rate'''::
  If the audio stream was started, this attribute contains the sample rate of the audio negotiated.
 '''codec'''::
  If the audio stream was started, this attribute contains the name of the audio codec that was negotiated.
 '''srtp_active'''::
  If the audio stream was started, this boolean attribute indicates if SRTP is currently being used on the stream.
 '''local_rtp_address'''::
  If an audio stream is present within the session, this attribute contains the local IP address used for the audio stream.
 '''local_rtp_port'''::
  If an audio stream is present within the session, this attribute contains the local UDP port used for the audio stream.
 '''remote_rtp_address_sdp'''::
  If the audio stream was started, this attribute contains the IP address that the remote party gave to send audio to.
 '''remote_rtp_port_sdp'''::
  If the audio stream was started, this attribute contains the UDP port that the remote party gave to send audio to.
 '''remote_rtp_address_received'''::
  If the audio stream was started, this attribute contains the remote IP address from which the audio stream is being received.
 '''remote_rtp_port_received'''::
  If the audio stream was started, this attribute contains the remote UDP port from which the audio stream is being received.
 '''recording_file_name'''::
  If the audio stream is currently being recorded to disk, this property contains the name of the {{{.wav}}} file being recorded to.

=== Methods ===

'''start_recording'''(''self'', '''filename'''={{{None}}})::
  If an audio stream is present within this session, calling this method will record the audio to a {{{.wav}}} file.
  Note that when the session is on hold, nothing will be recorded to the file.
  Right before starting the recording a {{{SIPSessionWillStartRecordingAudio}}} notification will be emitted, followed by a {{{SIPSessionDidStartRecordingAudio}}}.
  This method may only be called while in the {{{ESTABLISHED}}} state.
  [[BR]]''file_name'':[[BR]]
  The name of the {{{.wav}}} file to record to.
  If this is set to {{{None}}}, a default file name including the session participants and the timestamp will be generated.
 '''stop_recording'''(''self'')::
  This will stop a previously started recording.
  Before stopping, a {{{SIPSessionWillStopRecordingAudio}}} notification will be sent, followed by a {{{SIPSessionDidStopRecordingAudio}}}.
  This method may only be called while in the {{{ESTABLISHED}}} state.
 '''send_dtmf'''(''self'', '''digit''')::
  If this session currently has an active audio stream, send a DTMF digit to the remote party over it.
  This method may only be called while in the {{{ESTABLISHED}}} state and if the session has an active audio stream.
  [[BR]]''digit'':[[BR]]
  This should a string of length 1, containing a valid DTMF digit value.

=== Notifications ===

'''AudioStreamDidChangeHoldState'''::
 '''AudioStreamWillStartRecordingAudio''::
  Will be sent when the application requested that the audio stream active within the session be record to a {{{.wav}}} file, just before recording starts.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''file_name'':[[BR]]
  The name of the recording {{{.wav}}} file, including full path.
 '''AudioStreamDidStartRecordingAudio'''::
  Will be sent when the application requested that the audio stream active within the session be record to a {{{.wav}}} file, just after recording starts.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''file_name'':[[BR]]
  The name of the recording {{{.wav}}} file, including full path.
 '''AudioStreamWillStopRecordingAudio'''::
  Will be sent when the application requested ending the recording to a {{{.wav}}} file, just before recording stops.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''file_name'':[[BR]]
  The name of the recording {{{.wav}}} file, including full path.
 '''AudioStreamDidStopRecordingAudio'''::
  Will be sent when the application requested ending the recording to a {{{.wav}}} file, just before recording stops.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''file_name'':[[BR]]
  The name of the recording {{{.wav}}} file, including full path.
 '''SIPSessionGotNoAudio'''::
  This notification will be sent if 5 seconds after the audio stream starts, no audio was received from the remote party.
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
 '''AudioStreamGotDTMF'''::
  Will be send if there is a DMTF digit received from the remote party on the audio stream. 
  [[BR]]''timestamp'':[[BR]]
  A {{{datetime.datetime}}} object indicating when the notification was sent.
  [[BR]]''digit'':[[BR]]
  The DTMF digit that was received, in the form of a string of length 1.

MSRPStreamBase

Implemented in [browser:sipsimple/streams/msrp.py]

=== Atributes ===

'''media_type'''::
 '''accept_types'''::
 '''accept_wrapped_types'''::
 '''use_msrp_session'''::

=== Notifications ===

'''MSRPLibraryLog'''::
 '''MSRPTransportTrace'''::

ChatStream

Implemented in [browser:sipsimple/streams/msrp.py]

{{{sipsimple.streams.msrp.ChatStream}}} implements Instant Messaging (IM) over MSRP for the [wiki:SipMiddlewareApi middleware]. This class performs the following functions:

• automatically wraps outgoing messages with Message/CPIM if that's necessary according to accept-types
• unwraps incoming Message/CPIM messages; for each incoming message, {{{ChatStreamGotMessage}}} is posted
• plays notification sounds on received/sent message
• reacts to and composes iscomposing payloads

=== SDP Example ===

{{{
Content-Type: application/sdp
Content-Length: 283

v=0
o=- 3467525214 3467525214 IN IP4 192.168.1.6
s=blink-0.10.7-beta
c=IN IP4 192.168.1.6
t=0 0
m=message 2855 TCP/TLS/MSRP
a=path:msrps://192.168.1.6:2855/ca7940f12ddef14c3c32;tcp
a=accept-types:message/cpim text/ application/im-iscomposing+xml
a=accept-wrapped-types:*
}}}

=== Methods === {{{
Failure-Report: partial
Success-Report: yes
}}}

'''send_composing_indication'''(''self'', ''state'', ''refresh'', ''last_active=None'', ''remote_identity=None'')::
 Send is composing notification.

=== Notifications ===

To communicate with the middleware, MSRPChat class uses the notification system provided by the [http://pypi.python.org/pypi/python-application python-application] package.

'''ChatStreamGotMessage'''::
 Sent whenever a new incoming message is received,
  [[BR]]''content'':[[BR]]
  The string that the remote user has typed.
  [[BR]]''content_type'':[[BR]]
  Content-Type of the user message.
  [[BR]]''cpim_headers'':[[BR]]
  A dictionary of CPIM headers. (Empty dictionary if no CPIM wrapper was used).
  [[BR]]''message'':[[BR]]
  A {{{msrplib.protocol.MSRPData}}} instance providing all the MSRP information about the chunk.
 '''ChatStreamDidDeliverMessage'''::
 Sent when a successful report is received.
  [[BR]]''message_id'':[[BR]]
  Text identifier of the message.
  [[BR]]''code'':[[BR]]
  Integer result code.
  [[BR]]''reason'':[[BR]]
  Text comment.
  [[BR]]''message'':[[BR]]
  A {{{msrplib.protocol.MSRPData}}} instance providing all the MSRP information about the report.
 '''ChatStreamDidNotDeliverMessage'''::
 Sent when a failure report of failure transaction response is received.
  [[BR]]''message_id'':[[BR]]
  Text identifier of the message.
  [[BR]]''code'':[[BR]]
  Integer result code.
  [[BR]]''reason'':[[BR]]
  Text comment.
  [[BR]]''message'':[[BR]]
  A {{{msrplib.protocol.MSRPData}}} instance providing all the MSRP information about the report.
 '''ChatStreamDidSendMessage'''::
 Sent when an outgoing message has been sent.
 '''ChatStreamGotComposingIndication'''::
 Sent when a iscomposing payload is received.

FileTransferStream

Implemented in [browser:sipsimple/streams/msrp.py]

=== SDP Example ===

{{{
Content-Type: application/sdp
Content-Length: 383

v=0
o=- 3467525166 3467525166 IN IP4 192.168.1.6
s=blink-0.10.7-beta
c=IN IP4 192.168.1.6
t=0 0
m=message 2855 TCP/TLS/MSRP
a=path:msrps://192.168.1.6:2855/e593357dc9abe90754bd;tcp
a=sendonly
a=accept-types:
a=accept-wrapped-types:*
a=file-selector:name:"reblink.pdf" type:com.adobe.pdf size:268759 hash:sha1:60:A1:BE:8D:71:DB:E3:8E:84:C9:2C:62:9E:F2:99:78:9D:68:79:F6
}}}

=== Methods === === Notifications ===

'''FileTransferStreamDidDeliverChunk'''::
 '''FileTransferStreamDidFinish'''::
 '''FileTransferStreamDidNotDeliverChunk'''::
 '''FileTransferStreamGotChunk'''::

DesktopSharingStream

Implemented in [browser:sipsimple/streams/msrp.py]

There is no standard defining this usage but is fairly easy to implement in clients that already support MSRP. To traverse a NAT-ed router, a [http://msrprelay.org MSRP relay] configured for the called party domain is needed. Below is an example of the Session Description Protocol used for establishing a Desktop sharing session.

=== SDP Example ===

{{{
m=application 2855 TCP/TLS/MSRP *
a=path:msrps://10.0.1.19:2855/b599b22d1b1d6a3324c8;tcp
a=accept-types:application/x-rfb
a=setup:active
}}}

=== Methods ===

=== Notifications ===

'''DesktopSharingHandlerDidFail'''::
 '''DesktopSharingStreamGotData'''::

Account

Implemented in [browser:sipsimple/account.py]

The {{{sipsimple.account.Account}}} objects represent the SIP accounts which are used by the middleware. It has a dual purpose: it acts as both a container for account-related settings and as a complex object which can be used to interact with various per-account functions, such as presence, registration etc. This page documents the latter case, while the former is explained in the [wiki:SipConfigurationAPI#Account Configuration API].

There is exactly one instance of {{{Account}}} per SIP account used and it is uniquely identifiable by its SIP ID, in the form ''user@domain''. It is a singleton, in the sense that instantiating {{{Account}}} using an already used SIP ID will return the same object. However, this is not the recommended way of accessing accounts, as this can lead to creation of new ones; the recommended way is by using the [wiki:SipMiddlewareApi#AccountManager AccountManager]. The next sections will use a lowercase, monospaced {{{account}}} to represent an instance of {{{Account}}}.

=== States ===

The {{{Account}}} objects have a setting flag called {{{enabled}}} which, if set to {{{False}}} will deactivate it: none of the internal functions will work in this case; in addition, the application using the middleware should not do anything with a disabled account. After changing it's value, the {{{save()}}} method needs to be called, as the flag is a setting and will not be used until this method is called: {{{
account.enabled = True
account.save()
}}}

The {{{Account}}} objects will activate automatically when they are loaded/created if the {{{enabled}}} flag is set to {{{True}}} and the {{{sipsimple.engine.Engine}}} is running; if it is not running, the accounts will activate after the engine starts.

In order to create a new account, just create a new instance of {{{Account}}} with an id which doesn't belong to any other account.

The other functions of {{{Account}}} which run automatically have other enabled flags as well. They will only be activated when both the global enabled flag is set and the function-specific one. These are:

'''Account.registration.enabled'''::
  This flag controls the automatic registration of the account. The notifications '''SIPAccountRegistrationDidSucceed''', '''SIPAccountRegistrationDidFail''' and '''SIPAccountRegistrationDidEnd''' are used to inform the status of this registration.
 '''Account.presence.enabled'''::
  This flag controls the automatic subscription to buddies for the ''presence'' event and the publication of data in this event. (Not implemented yet)
 '''Account.dialog_event.enabled'''::
  This flag controls the automatic subscription to buddies for the ''dialog-info'' event and the publication of data in this event. (Not implemented yet)
 '''Account.message_summary.enabled'''::
  This flag controls the automatic subscription to the ''message-summary'' event in order to find out about voicemail messages. (Not implemented yet)

The {{{save()}}} method needs to be called after changing these flags in order for them to take effect. The methods available on {{{Account}}} objects are inherited from [wiki:SipConfigurationAPI#SettingsObject SettingsObject].

=== Attributes ===

The following attributes can be used on an Account object and need to be considered read-only.

'''id'''::
  This attribute is of type {{{sipsimple.configuration.datatypes.SIPAddress}}} (a subclass of {{{str}}}) and contains the SIP id of the account. It can be used as a normal string in the form ''user@domain'', but it also allows access to the components via the attributes {{{username}}} and {{{domain}}}.
 {{{
  account.id # 'alice@example.com'
  account.id.username # 'alice'
  account.id.domain # 'example.com'
  }}}
 '''contact'''::
  This attribute can be used to construct the Contact URI for SIP requests sent on behalf of this account. It's type is {{{sipsimple.account.ContactURI}}} which is a subclass of {{{sipsimple.configuration.datatypes.SIPAddress}}}. In addition to the attributes defined in {{{SIPAddress}}}, it can be indexed by a string representing a transport ({{{'udp'}}}, {{{'tcp'}}} or {{{'tls'}}}) which will return a {{{sipsimple.core.SIPURI}}} object with the appropriate port and transport parameter. The username part is a randomly generated 8 character string consisting of lowercase letters; the domain part is the IP address on which the {{{Engine}}} is listening (as specified by the SIPSimpleSettings.local_ip setting).
 {{{
  account.contact # 'hnfkybrt@10.0.0.1'
  account.contact.username # 'hnfkybrt'
  account.contact.domain # '10.0.0.1'
  account.contact['udp'] # <SIPURI "sip:hnfkybrt@10.0.0.1:53024">
  account.contact['tls'] # <SIPURI "sip:hnfkybrt@10.0.0.1:54478;transport=tls">
  }}}
 '''credentials'''::
  This attribute is of type {{{sipsimple.core.Credentials}}} object which is built from the {{{id}}} attribute and {{{display_name}}} and {{{password}}} settings of the Account. Whenever one of these settings are changed, this attribute is updated.
 {{{
  account.credentials # <Credentials for '"Alice" <sip:alice@example.com>'>
  }}}

=== Notifications ===

'''CFGSettingsObjectDidChange'''::
  This notification is sent when the {{{save()}}} method is called on the account after some of the settings were changed. As the notification belongs to the {{{SettingsObject}}} class, it is exaplained in detail in [wiki:SipConfigurationAPI#SettingsObjectNotifications SettingsObject Notifications].
 '''SIPAccountDidActivate'''::
  This notification is sent when the {{{Account}}} activates. This can happen when the {{{Account}}} is loaded if it's enabled flag is set and the Engine is running, and at any later time when the status of the Engine changes or the enabled flag is modified. The notification does not contain any data.
 '''SIPAccountDidDeactivate'''::
  This notification is sent when the {{{Account}}} deactivates. This can happend when the {{{Engine}}} is stopped or when the enabled flag of the account is set to {{{False}}}. The notification does not contain any data.
 '''SIPAccountRegistrationDidSucceed'''::
  This notification is sent when a REGISTER request sent for the account succeeds (it is also sent for each refresh of the registration). The data contained in this notification is:
  [[BR]]''code'':[[BR]]
   The status code of the response for the REGISTER request.
  [[BR]]''reason'':[[BR]]
   The reason of the response for the REGISTER request.
  [[BR]]''contact_uri'':[[BR]]
   The Contact URI which was registered.
  [[BR]]''contact_uri_list'':[[BR]]
   A list containing all the contact URIs registered for this SIP account.
  [[BR]]''expires'':[[BR]]
   The amount in seconds in which this registration will expire.
  [[BR]]''registration'':[[BR]]
   The {{{sipsimple.core.Registration}}} object used to register this account.
 '''SIPAccountRegistrationDidFail'''::
  This notification is sent when a REGISTER request sent for the account fails. It can fail either because a negative response was returned or because PJSIP considered the request failed (e.g. on timeout). The data contained in this notification is:
  [[BR]]''code'':[[BR]]
   The status code of the response for the REGISTER request. This is only present if the notification is sent as a result of a response being received.
  [[BR]]''reason'':[[BR]]
   The reason for the failure of the REGISTER request.
  [[BR]]''registration'':[[BR]]
   The {{{sipsimple.core.Registration}}} object which failed.
  [[BR]]''next_route'':[[BR]]
   A {{{sipsimple.core.Route}}} object which will be tried next for registering the account, or {{{None}}} if a new DNS lookup needs to be performed.
  [[BR]]''delay'':[[BR]]
   The amount in seconds as a {{{float}}} after which the next route will be tried for registering the account.
 '''SIPAccountRegistrationDidEnd'''::
  This notification is sent when a registration is ended (the account is unregistered). The data contained in this notification is:
  [[BR]]''code'':[[BR]]
   The status code of the response for the REGISTER with {{{Expires: 0}}} request. This is only present if a response was received.
  [[BR]]''reason'':[[BR]]
   The reason returned in the response for the Register with {{{Expires: 0}}} request. This is only present if a response was received
  [[BR]]''registration'':[[BR]]
   The {{{sipsimple.core.Registration}}} object which ended.

BonjourAccount

Implemented in [browser:sipsimple/account.py]

The {{{sipsimple.account.BonjourAccount}}} represents the SIP account used for P2P mode; it does not interact with any server. The class is a singleton, as there can only be one such account on a system. Similar to the {{{Account}}}, it is used both as a complex object, which implements the functions for bonjour mode, as well as a container for the related settings.

=== States ===

The {{{BonjourAccount}}} has an {{{enabled}}} flags which controls whether this account will be used or not. If it is set to {{{False}}}, none of the internal functions will be activated and, in addition, the account should not be used by the application. The bonjour account can only activated if the Engine is running; once it is started, if the enabled flag is set, the account will activate. When the {{{BonjourAccount}}} is activated, it will broadcast the contact address on the LAN. (Not implemented yet)

=== Attributes ===

The following attributes can be used on an BonjourAccount object and need to be considered read-only.

'''id'''::
  This attribute is of type {{{sipsimple.configuration.datatypes.SIPAddress}}} (a subclass of {{{str}}}) and contains the SIP id of the account, which is {{{'bonjour@local'}}}. It can be used as a normal string, but it also allows access to the components via the attributes {{{username}}} and {{{domain}}}.
 {{{
  bonjour_account.id # 'bonjour@local'
  bonjour_account.id.username # 'bonjour'
  bonjour_account.id.domain # 'local'
  }}}
 '''contact'''::
  This attribute can be used to construct the Contact URI for SIP requests sent on behalf of this account. It's type is {{{sipsimple.account.ContactURI}}} which is a subclass of {{{sipsimple.configuration.datatypes.SIPAddress}}}. In addition to the attributes defined in {{{SIPAddress}}}, it can be indexed by a string representing a transport ({{{'udp'}}}, {{{'tcp'}}} or {{{'tls'}}}) which will return a {{{sipsimple.core.SIPURI}}} object with the appropriate port and transport parameter. The username part is a randomly generated 8 character string consisting of lowercase letters; the domain part is the IP address on which the {{{Engine}}} is listening (as specified by the SIPSimpleSettings.local_ip setting).
 {{{
  account.contact # 'lxzvgack@10.0.0.1'
  account.contact.username # 'lxzvgack'
  account.contact.domain # '10.0.0.1'
  account.contact['udp'] # <SIPURI "sip:lxzvgack@10.0.0.1:53024">
  account.contact['tls'] # <SIPURI "sip:lxzvgack@10.0.0.1:54478;transport=tls">
  }}}
 '''credentials'''::
  This attribute is of type {{{sipsimple.core.Credentials}}} object which is built from the {{{contact}}} attribute and {{{display_name}}} setting of the BonjourAccount; the password is set to the empty string. Whenever the display_name setting is changed, this attribute is updated.
 {{{
  account.credentials # <Credentials for '"Alice" <sip:lxzvgack@10.0.0.1>'>
  }}}

=== Notifications ===

'''CFGSettingsObjectDidChange'''::
  This notification is sent when the {{{save()}}} method is called on the account after some of the settings were changed. As the notification belongs to the {{{SettingsObject}}} class, it is exaplained in detail in [wiki:SipConfigurationAPI#SettingsObjectNotifications SettingsObject Notifications].
 '''SIPAccountDidActivate'''::
  This notification is sent when the {{{BonjourAccount}}} activates. This can happen when the {{{BonjourAccount}}} is loaded if it's enabled flag is set and the Engine is running, and at any later time when the status of the Engine changes or the enabled flag is modified. The notification does not contain any data.
 '''SIPAccountDidDeactivate'''::
  This notification is sent when the {{{BonjourAccount}}} deactivates. This can happend when the {{{Engine}}} is stopped or when the enabled flag of the account is set to {{{False}}}. The notification does not contain any data.

AccountManager

Implemented in [browser:sipsimple/account.py]

The {{{sipsimple.account.AccountManager}}} is the entity responsible for loading and keeping track of the existing accounts. It is a singleton and can be instantiated anywhere, obtaining the same instance. It cannot be used until its {{{start}}} method has been called.

=== Methods ===

'''!__init!__'''(''self'')::
  The {{{__init__}}} method allows the {{{AccountManager}}} to be instantiated without passing any parameters. A reference to the {{{AccountManager}}} can be obtained anywhere before it is started.
 '''start'''(''self'')::
  This method will load all the existing accounts from the configuration. If the Engine is running, the accounts will also activate. This method can only be called after the [wiki:SipConfigurationAPI#ConfigurationManager ConfigurationManager] has been started. A '''SIPAccountManagerDidAddAccount''' will be sent for each account loaded.
 '''stop'''(''self'')::
  Calling this method will deactivate all accounts managed by the {{{AccountManager}}}.
 '''has_account'''(''self'', '''id''')::
  This method returns {{{True}}} if an account which has the specifed SIP ID (must be a string) exists and {{{False}}} otherwise.
 '''get_account'''(''self'', '''id''')::
  Returns the account (either an {{{Account}}} instance or the {{{BonjourAccount}}} instance) with the specified SIP ID. Will raise a {{{KeyError}}} if such an account does not exist.
 '''get_accounts'''(''self'')::
  Returns a list containing all the managed accounts.
 '''iter_accounts'''(''self'')::
  Returns an iterator through all the managed accounts.
 '''find_account'''(''self'', '''contact_uri''')::
  Returns an account with matches the specified {{{contact_uri}}} which must be a {{{sipsimple.core.SIPURI}}} instance. Only the accounts with the enabled flag set will be considered. Returns None if such an account does not exist.

=== Notifications ===

'''SIPAccountManagerDidAddAccount'''::
  This notification is sent when a new account becomes available to the {{{AccountManager}}}. The notification is also sent when the accounts are loaded from the configuration. The data contains a single attribute, {{{account}}} which is the account object which was added.
 '''SIPAccountManagerDidRemoveAccount'''::
  This notification is sent when an account is deleted using the {{{delete}}} method. The data contains a single attribute, {{{account}}} which is the account object which was deleted.
 '''SIPAccountManagerDidChangeDefaultAccount'''::
  This notification is sent when the default account changes. The notification contains two attributes:
  [[BR]]''old_account'':[[BR]]
   This is the account object which used to be the default account.
  [[BR]]''account'':[[BR]]
   This is the account object which is the new default account.