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 and media planes

 * 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

== NAT traversal ==

The client library support best NAT traversal techniques available today:

 * Client side support by using STUN and ICE

 * Server side support by using rport and media relays

 * Symmetric media (same port for sending and receiving media) 

 * Keep-alive

== SIP transport ==

 * UDP/TCP/TLS transports

 * RFC 3263 next hop resolution lookup

 * Other lookup mechanisms can be easily added

== SDP negotiation ==

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)

Except for MSRP file transfer, all media types can be combined together in the same session.

== SIP Methods  ==

 * REGISTER

 * INVITE

 * PRACK

 * ACK

 * BYE

 * re-INVITE (hold/un-hold, adding and removing other media types)

 * CANCEL

 * MESSAGE

 * PUBLISH

 * SUBSCRIBE

 * NOTIFY

 * OPTIONS

== Audio ==

 * Echo cancelation control

 * Hold/On-hold

 * DTMF

 * Codecs: speex (wideband), g711, ilbc, gsm, g722

 * sRTP

 * zRTP

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

== Presence ==

 * Rich presence data model [http://tools.ietf.org/html/rfc3856 RFC3856], [http://tools.ietf.org/html/rfc3863 RFC3863 ], [http://tools.ietf.org/html/rfc4479 RFC4479], [http://tools.ietf.org/html/rfc4481 RFC4481], [http://tools.ietf.org/html/rfc4482 RFC4482], [http://tools.ietf.org/html/rfc5196 RFC5196]

 * Presence watcher-info event package [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]

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

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

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

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

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

 * TCP and TLS transports

 * XCAP trace capability

== Instant Messaging ==

 * 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/rfc3842 RFC3994]

 * TCP and TLS transports

== File transfer ==

 * MSRP file transfer [http://tools.ietf.org/html/draft-ietf-mmusic-file-transfer-mech-11 draft-ietf-mmusic-file-transfer-mech-11]

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

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