SIP SIMPLE Client SDK

= Library  Features =

[[TOC(WikiStart, Sip*, depth=2)]]

SIP SIMPLE client is a Software Development Kit for easy development of Real Time Applications based on SIP and related protocols for Presence, Audio, Instant Messaging (IM), File Transfers and Desktop Sharing. Other media types can be easily added by using an extensible high-level API.

The software has undergone in the past years several interoperability tests at [http://sipit.net SIPIT] and today is of industry strength quality. 

== General Features ==

 * Written in Python language

 * Non-blocking asynchronous design

 * Event driven Application Programming Interface

 * TLS security for both signaling (SIP) and media planes (MSRP, XCAP)

 * Fail-over for DNS lookups, SIP next hop routing and MSRP relay reservation 

 * Multiple SIP accounts support

 * Multiple media types per session (e.g. Audio + Instant Messaging + Desktop Sharing)

 * Multiple active session support with add/remove of media within same session

 * Compatible with SIMPLE functionality of OpenSIPS and OpenXCAP servers

 * Trace capability for all underlying protocols

 * Cross platform capability on Linux, OSX and Windows (roadmap)

== Location Discovery ==

 * [http://tools.ietf.org/html/rfc3263 RFC3263] next hop resolution lookup

 * Bonjour multicast DNS [http://tools.ietf.org/html/draft-lee-sip-dns-sd-uri-03] (not implemented yet)

 * Other lookup mechanisms can be easily added (e.g. P2PSIP or DHT)

The library uses a separated from the core lookup mechanism for the next hop routing. This important feature allows the library to be used for building SIP clients that operate in combination with any SIP provider (by employing RFC 3263 DNS lookups), in a server-less LAN operation (using Bonjour protocol) or integrated into a network overlay developed by a third party (e.g. P2PSIP overlay).

== SIP Transport ==

 * Session Initiation Protocol [http://tools.ietf.org/html/rfc3261 RFC3261] 

 * Support for UDP, TCP  and TLS transports

== SDP Negotiation ==

 * Session Description Protocol [http://tools.ietf.org/html/rfc4566 RFC4566] 

 * An Offer/Answer Model with Session Description Protocol (SDP) [http://tools.ietf.org/html/rfc4566 RFC4566] 

 * Support of re-INVITE for adding and removing media streams

Supported media types:

 * Audio (RTP/sRTP with or without ICE and STUN)

 * Instant messaging over MSRP (with or without MSRP relay support)

 * File transfer over MSRP (with or without MSRP relay support)

 * Desktop sharing (VNC over MSRP)

All media can be combined together in the same SIP session.

== NAT Traversal ==

The client library support best NAT traversal techniques available today:

 * SIP Signaling: Symmetric Response Routing Symmetric media [http://tools.ietf.org/html/rfc3581 RFC3581] and Keep-alive

 * Audio: STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)  [http://tools.ietf.org/html/rfc3489 RFC3489] and Interactive Connectivity Establishment (ICE): A Methodology for NAT Traversal for Offer/Answer Protocols  [http://www.ietf.org/internet-drafts/draft-ietf-mmusic-ice-19.txt draft-ietf-mmusic-ice-19]

 * IM and File Transfer: MSRP protocol relay extension [http://tools.ietf.org/html/rfc4976 RFC4976]

== Audio ==

 * A Transport Protocol for Real-Time Applications [http://tools.ietf.org/html/rfc3550 RFC3550]

 * Real Time Control Protocol (RTCP) attribute in Session Description Protocol (SDP) [http://tools.ietf.org/html/rfc3605 RFC3605]

 * Generation and parsing of RFC 2833/telephone-events payload in both RTP and SDP [http://tools.ietf.org/html/rfc2833 RFC2833]

 * The Secure Real-time Transport Protocol (SRTP)  [http://tools.ietf.org/html/rfc3711 RFC3711]

 * Echo cancelation control

 * Hold

 * DTMF tone generator

 * Conference bridge

 * Wav player and recorder

 * RTP timeout detection

 * Codecs: speex, g711, ilbc, gsm, g722

== Presence ==

All features have been built-in and tested with [http://opensips.org OpenSIPS] Presence Agent.

 * SIP Specific Event Notification [http://tools.ietf.org/html/rfc3265 RFC3265]

 * Presence data model [http://tools.ietf.org/html/rfc3863 RFC3863], [http://tools.ietf.org/html/rfc3379 RFC3379], [http://tools.ietf.org/html/rfc4479 RFC4479]

 * Rich presence extensions [http://tools.ietf.org/html/rfc4480 RFC4480], [http://tools.ietf.org/html/rfc4481 RFC4481], [http://tools.ietf.org/html/rfc4482 RFC4482], [http://tools.ietf.org/html/rfc5196 RFC5196]

 * Watcher-info [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]

 * Policy [http://www.tools.ietf.org/html/rfc4745 RFC4745]  

== XCAP ==

All features have been built-in and tested with [http://openxcap.org OpenXCAP] server.

 * XCAP protocol [http://www.tools.ietf.org/html/rfc4825 RFC4825]

 * Presence rules [http://www.tools.ietf.org/html/rfc5025 RFC5025]

 * Resource-lists [http://www.tools.ietf.org/html/rfc4826 RFC4826]

 * RLS-services [http://www.tools.ietf.org/html/rfc4826 RFC4826]

 * PIDF manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]

 * xcap-diff [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt draft-ietf-simple-xcap-diff-09]

 * OMA specifications org.openmobilealliance.xcap-directory and oma_status.icon

== Instant Messaging ==

 * Common Presence and Instant Messaging (CPIM): [http://tools.ietf.org/html/rfc3862 RFC 3862]

 * Session Initiation Protocol (SIP) Extension for Instant Messaging  [http://tools.ietf.org/html/rfc3428 RFC3428]

 * MSRP protocol [http://tools.ietf.org/html/rfc4975 RFC4975]

 * Indication of Message Composition for Instant Messaging [http://tools.ietf.org/html/rfc3994 RFC3994]

 * Message summary event package [http://tools.ietf.org/html/rfc3842 RFC3842] (not implemented yet)

== File Transfer ==

 * MSRP file transfer [http://tools.ietf.org/html/rfc5547 RFC5547]

== Desktop Sharing ==

 * Variation of [http://tools.ietf.org/html/draft-garcia-mmusic-sdp-collaboration-00 draft-garcia-mmusic-sdp-collaboration-00] using RFB over MSRP

== Conferencing ==

 * Conference event package [http://tools.ietf.org/html/rfc4575 RFC4575] (not implemented yet)

 * MSRP ad-hoc multi-party chat sessions [http://tools.ietf.org/html/draft-ietf-simple-chat-05 draft-ietf-simple-chat-05] (not implemented yet)