SIP SIMPLE Client SDK

= Library features =

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

This library implements RTP audio sessions (VoIP), session based Instant Messaging (IM), file transfer and multi-party chat sessions using MSRP protocol and its relay extension, publication and subscription for rich presence information such as availability, moods, activities and geo-location, management for the presence rules, resource lists, RLS services documents using XCAP protocol.

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).

== General  ==

 * Written in Python language

 * High level event driven  API and low level components API

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

 * Non-blocking design for all components

 * 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 SIP SIMPLE functionality of OpenSIPS and OpenXCAP servers

 * Cross platform (Linux, OSX, Windows)

 * Trace capability for all underlying protocols

== SIP transport ==

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

== 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] 

Supported media types:

 * Audio (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.

== Location discovery ==

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

 * Bonjour multicast DNS [http://www.ietf.org/internet-drafts/draft-lee-sip-dns-sd-uri-03.txt draft-lee-sip-dns-sd-uri-03]

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

== NAT traversal ==

The client library support best NAT traversal techniques available today:

 * STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs)  [http://tools.ietf.org/html/rfc3489 RFC3489]

 * Interactive Connectivity Establishment (ICE): A Methodology for Network Address Translator (NAT) Traversal for Offer/Answer Protocols  [http://www.ietf.org/internet-drafts/draft-ietf-mmusic-ice-19.txt draft-ietf-mmusic-ice-19]

 * Server side support by using rport and media relays

 * Symmetric Response Routing Symmetric media [http://tools.ietf.org/html/rfc3581 RFC3581]

 * Keep-alive

== 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/On-hold

 * Tone generator

 * RTP timeout detection

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

== Presence ==

 * 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 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]

== Instant Messaging ==

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

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

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

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

== File transfer ==

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

== Conferencing ==

 * Conference event package [http://tools.ietf.org/html/rfc4575 RFC4575]

 * MSRP ad-hoc multi-party chat sessions [http://tools.ietf.org/html/draft-ietf-simple-chat-04 draft-ietf-simple-chat-04]

== Other ==

 * Desktop sharing, variation of [http://tools.ietf.org/html/draft-garcia-mmusic-sdp-collaboration-00 draft-garcia-mmusic-sdp-collaboration-00]

 * Message summary event package [http://tools.ietf.org/html/rfc3842 RFC3842]