WikiStart

Version 370 (Adrian Georgescu, 01/10/2009 06:31 pm)

1 298 Adrian Georgescu
= Description =
2 95 Ruud Klaver
3 292 Adrian Georgescu
[[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]]
4 346 Adrian Georgescu
SIP SIMPLE client is Python software library built on top of PJSIP that
5 346 Adrian Georgescu
together with middleware allows for easy development of Client/Server and
6 346 Adrian Georgescu
Peer-to-Peer Internet communications end-points based on SIP SIMPLE family
7 346 Adrian Georgescu
of protocols for voice, video, presence, instant messaging (IM) and file
8 346 Adrian Georgescu
transfer capabilities.
9 1
10 367 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE]
11 1
12 346 Adrian Georgescu
== Background ==
13 346 Adrian Georgescu
14 346 Adrian Georgescu
SIP stands for 'Sessions Initiation Protocol', an IETF standard described by
15 348 Adrian Georgescu
[http://tools.ietf.org/html/rfc3261 RFC 3261]. SIP is an application-layer control protocol that can establish,
16 346 Adrian Georgescu
modify and terminate multimedia sessions such as Internet telephony calls
17 346 Adrian Georgescu
(VoIP). Media can be added to (and removed from) an existing session.
18 346 Adrian Georgescu
19 346 Adrian Georgescu
SIP transparently supports name mapping and redirection services, which
20 346 Adrian Georgescu
supports personal mobility, users can maintain a single externally visible
21 346 Adrian Georgescu
address identifier, which can be in the form of a standard email address or
22 346 Adrian Georgescu
E.164 telephone number regardless of their physical network location.
23 346 Adrian Georgescu
24 346 Adrian Georgescu
SIP allows the endpoints to negotiate and combine any type of session they
25 346 Adrian Georgescu
mutually understand like video, instant messaging (IM), file transfer,
26 346 Adrian Georgescu
desktop sharing and provides a generic event notification system with
27 346 Adrian Georgescu
real-time publications and subscriptions about state changes that can be
28 346 Adrian Georgescu
used for asynchronous services like presence, message waiting indicator and
29 346 Adrian Georgescu
busy line appearance.
30 331 Adrian Georgescu
31 1
== Features ==
32 1
33 368 Adrian Georgescu
The software allows you to create elegant real-time communications applications without having to read [http://www.rfc3261.net the +1200 RFC documents] behind it. As a library with a high-level [wiki:SipApiDocumentation API], the toolkit can be used to add voice, IM and Presence functionality to any network devices as long as Python/C environment is supported by such platform.
34 344 Adrian Georgescu
35 369 Adrian Georgescu
Additional to the SIP standards implemented by the underlying PJSIP library and exposes through a Python API, this project implements 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 presence rules, resource lists, RLS services documents using XCAP protocol.
36 344 Adrian Georgescu
37 370 Adrian Georgescu
 * Locating SIP services [http://tools.ietf.org/html/rfc3263 RFC3263]
38 370 Adrian Georgescu
 * Rich Presence Information Data model and Format (RPIDF) [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]
39 370 Adrian Georgescu
 * Watcher-info event package [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]
40 1
 * XCAP protocol [http://www.tools.ietf.org/html/rfc4825 RFC4825]
41 370 Adrian Georgescu
 * XCAP presence rules [http://www.tools.ietf.org/html/rfc5025 RFC5025]
42 370 Adrian Georgescu
 * XCAP resource-lists and RLS-services [http://www.tools.ietf.org/html/rfc4826 RFC4826]
43 370 Adrian Georgescu
 * XCAP PIDF manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]
44 370 Adrian Georgescu
 * XCAP-diff event package [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt draft-ietf-simple-xcap-diff-09]
45 370 Adrian Georgescu
 * Conference event package [http://tools.ietf.org/html/rfc4575 RFC4575]
46 344 Adrian Georgescu
 * MSRP protocol [http://tools.ietf.org/html/rfc4975 RFC4975]
47 344 Adrian Georgescu
 * MSRP protocol relay extension [http://tools.ietf.org/html/rfc4976 RFC4976]
48 344 Adrian Georgescu
 * MSRP ad-hoc multi-party chat sessions [http://tools.ietf.org/html/draft-ietf-simple-chat-03 draft-ietf-simple-chat-03]
49 370 Adrian Georgescu
 * Message summary event package [http://tools.ietf.org/html/rfc3842 RFC3842]
50 370 Adrian Georgescu
 * Bonjour multicast DNS [http://www.ietf.org/internet-drafts/draft-lee-sip-dns-sd-uri-03.txt draft-lee-sip-dns-sd-uri-03]
51 344 Adrian Georgescu
52 1
== Documentation ==
53 1
54 363 Adrian Georgescu
For download and installation instructions, API description and other 
55 363 Adrian Georgescu
documentation see the files under docs/ directory.
56 363 Adrian Georgescu
57 366 Adrian Georgescu
 * [wiki:SipInstallation Installation guide]
58 365 Adrian Georgescu
 * [wiki:SipApiDocumentation API documentation]
59 360 Adrian Georgescu
 * [wiki:SipMiddleware Middleware design]
60 365 Adrian Georgescu
 * [wiki:SipTesting Testing the client] 
61 311 Adrian Georgescu
62 235 Adrian Georgescu
== Support ==
63 235 Adrian Georgescu
64 351 Adrian Georgescu
The project is developed and supported by [http://ag-projects.com AG Projects] via the wiki collaboration system available at http://sipsimpleclient.com. To request support you must open a ticket. To open ticket please [/register Register] first. The source browser and ticketing system are available only for registered users. 
65 191 Adrian Georgescu
66 202 Adrian Georgescu
If you wish to contribute and become an active developer of this project, send your request by email to pypjua-devel@ag-projects.com.