WikiStart
Version 402 (Adrian Georgescu, 01/26/2009 09:34 am)
1 | 298 | Adrian Georgescu | = Description = |
---|---|---|---|
2 | 95 | Ruud Klaver | |
3 | 292 | Adrian Georgescu | [[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]] |
4 | 377 | Adrian Georgescu | |
5 | 346 | Adrian Georgescu | SIP SIMPLE client is Python software library built on top of PJSIP that |
6 | 377 | Adrian Georgescu | together with middleware allows for easy development of Internet |
7 | 378 | Adrian Georgescu | communications end-points based on SIP and related protocols for voice, |
8 | 386 | Adrian Georgescu | rich presence, instant messaging (IM), file transfers and desktop sharing. |
9 | 386 | Adrian Georgescu | Other session types can be easily added by using an extensible API. |
10 | 1 | ||
11 | 378 | Adrian Georgescu | The software is provided under the [source:LICENSE GPL LICENSE] |
12 | 1 | ||
13 | 346 | Adrian Georgescu | == Background == |
14 | 346 | Adrian Georgescu | |
15 | 346 | Adrian Georgescu | SIP stands for 'Sessions Initiation Protocol', an IETF standard described by |
16 | 382 | Adrian Georgescu | [http://tools.ietf.org/html/rfc3261 RFC 3261]. SIP is an Internet application-layer control protocol that can establish, |
17 | 346 | Adrian Georgescu | modify and terminate multimedia sessions such as Internet telephony calls |
18 | 346 | Adrian Georgescu | (VoIP). Media can be added to (and removed from) an existing session. |
19 | 346 | Adrian Georgescu | |
20 | 346 | Adrian Georgescu | SIP transparently supports name mapping and redirection services, which |
21 | 346 | Adrian Georgescu | supports personal mobility, users can maintain a single externally visible |
22 | 346 | Adrian Georgescu | address identifier, which can be in the form of a standard email address or |
23 | 346 | Adrian Georgescu | E.164 telephone number regardless of their physical network location. |
24 | 346 | Adrian Georgescu | |
25 | 346 | Adrian Georgescu | SIP allows the endpoints to negotiate and combine any type of session they |
26 | 383 | Adrian Georgescu | mutually understand like audio, video, instant messaging (IM), file transfer, |
27 | 346 | Adrian Georgescu | desktop sharing and provides a generic event notification system with |
28 | 346 | Adrian Georgescu | real-time publications and subscriptions about state changes that can be |
29 | 346 | Adrian Georgescu | used for asynchronous services like presence, message waiting indicator and |
30 | 346 | Adrian Georgescu | busy line appearance. |
31 | 331 | Adrian Georgescu | |
32 | 1 | == Features == |
|
33 | 1 | ||
34 | 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. |
35 | 344 | Adrian Georgescu | |
36 | 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. |
37 | 344 | Adrian Georgescu | |
38 | 370 | Adrian Georgescu | * Locating SIP services [http://tools.ietf.org/html/rfc3263 RFC3263] |
39 | 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] |
40 | 370 | Adrian Georgescu | * Watcher-info event package [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858] |
41 | 1 | * XCAP protocol [http://www.tools.ietf.org/html/rfc4825 RFC4825] |
|
42 | 381 | Adrian Georgescu | * XCAP presence rules [http://www.tools.ietf.org/html/rfc5025 RFC5025], 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 | 387 | Adrian Georgescu | * Desktop sharing [http://tools.ietf.org/html/draft-garcia-mmusic-sdp-collaboration-00 draft-garcia-mmusic-sdp-collaboration-00] |
50 | 370 | Adrian Georgescu | * Message summary event package [http://tools.ietf.org/html/rfc3842 RFC3842] |
51 | 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] |
52 | 344 | Adrian Georgescu | |
53 | 1 | == Documentation == |
|
54 | 1 | ||
55 | 363 | Adrian Georgescu | For download and installation instructions, API description and other |
56 | 363 | Adrian Georgescu | documentation see the files under docs/ directory. |
57 | 363 | Adrian Georgescu | |
58 | 402 | Adrian Georgescu | * [wiki:ProjectStatus Project status] |
59 | 366 | Adrian Georgescu | * [wiki:SipInstallation Installation guide] |
60 | 393 | Adrian Georgescu | * [browser:docs/Upgrade.txt Upgrade guide] |
61 | 365 | Adrian Georgescu | * [wiki:SipApiDocumentation API documentation] |
62 | 360 | Adrian Georgescu | * [wiki:SipMiddleware Middleware design] |
63 | 385 | Adrian Georgescu | * [wiki:SipTesting Testing the library] |
64 | 1 | * [wiki:SipPorting Supported platforms] |
|
65 | 401 | Adrian Georgescu | * [wiki:SipContributions Contributions] |
66 | 401 | Adrian Georgescu | |
67 | 311 | Adrian Georgescu | |
68 | 235 | Adrian Georgescu | == Support == |
69 | 235 | Adrian Georgescu | |
70 | 399 | Adrian Georgescu | The project is developed and supported by AG Projects. The support is provided on a |
71 | 392 | Adrian Georgescu | best-effort basis. "best-effort" means that we try to solve the bugs you |
72 | 392 | Adrian Georgescu | report or help fix your problems as soon as we can, subject to available |
73 | 1 | resources. |
|
74 | 1 | ||
75 | 400 | Adrian Georgescu | To request support you must use the mailing list available at |
76 | 1 | ||
77 | 392 | Adrian Georgescu | http://lists.ag-projects.com/mailman/listinfo/sipclient |
78 | 1 | ||
79 | 399 | Adrian Georgescu | Patches and bug reports must be submitted by opening a ticket at |
80 | 396 | Adrian Georgescu | |
81 | 392 | Adrian Georgescu | http://sipsimpleclient.com/newticket |
82 | 392 | Adrian Georgescu | |
83 | 399 | Adrian Georgescu | To open ticket please Register first. |
84 | 400 | Adrian Georgescu | |
85 | 400 | Adrian Georgescu | If you wish to contribute as an active developer, send your request by email to pypjua-devel@ag-projects.com. |