SIP SIMPLE Client SDK

= Testing =

[[TOC(Sip*, depth=3)]]

Included with the library, a set of command line tools are available for

setting up audio, instant messaging (IM) and file transfer sessions, publish

and subscribe to presence or other type of events.

You need a SIP account from a service provider or to setup your own SIP infrastructure using the following elements:

 * OpenSIPS  from [http://opensips.org http://opensips.org]

 * OpenXCAP from [http://openxcap.org http://openxcap.org]

 * MSRPRelay from [http://msrprelay.org http://msrprelay.org]

For multi-party IM conferencing you can use:

 * SIP chatserver from http://chatserver.ag-projects.com 

A SIP account with all SIP SIMPLE client features can be obtained for free from http://sip2sip.info

== Configuration ==

The command line tools require the presence of a configuration file ~/.sipclient/config.ini that contains at least one SIP account. Each SIP account definition contains the credentials and other settings. 

For a full description of the configuration file and its settings is available in the [wiki:SipConfiguration Configuration] chapter. 

Command line tools:

=== Session establishment ===

 * [wiki:sip_rtp_audio_session sip_audio_session] - Setup a voice audio session (Voice over IP)

 * [wiki:sip_msrp_im_session sip_im_session] - Setup IM session and File transfer using MSRP protocol

 * [wiki:sip_desktop_sharing sip_desktop_sharing] - Share desktop using VNC protocol over MSRP transport

 * [wiki:sip_message sip_message] - Send/receive text in page mode using SIP MESSAGE method

=== Presence signalling ===

 * [wiki:sip_publish_presence sip_publish_presence] - PUBLISH presence to a SIP Presence Agent

 * [wiki:sip_subscribe_presence sip_subscribe_presence]  - SUBSCRIBE to presence information

 * [wiki:sip_subscribe_winfo sip_subscribe_winfo] - SUBSCRIBE to watcher list on a SIP Presence Agent

 * [wiki:sip_subscribe_rls sip_subscribe_rls] - SUBSCRIBE to lists managed by Resource List Server

=== Presence policy ===

 * [wiki:xcapclient xcapclient] - PUT/GET/DELETE full or partial documents on an XCAP server

 * [wiki:xcap_pres_rules xcap_pres_rules] - Manage content of pres-rules XCAP document

 * [wiki:xcap_rls_services] - Manage content of RLS services XCAP document

=== Register ===

 * [wiki:sip_register sip_register] - REGISTER a SIP end-point with a SIP Registrar