Difference between revisions of "Get Started"

From reSIProcate
Jump to navigation Jump to search
Line 11: Line 11:
 
**There is information on this wiki - [[Resip Overview]].
 
**There is information on this wiki - [[Resip Overview]].
 
**Some crude design diagrams and documentation can be found in [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/stack/doc/ main/resip/stack/doc]
 
**Some crude design diagrams and documentation can be found in [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/stack/doc/ main/resip/stack/doc]
**There is also Doxygen generated documentation for the [http://svn.resiprocate.org/dox/stack/annotated.html stack] and the underlying [http://svn.resiprocate.org/dox/rutil/annotated.html rutil] library.
+
**There is Doxygen generated documentation for the [http://svn.resiprocate.org/dox/stack/annotated.html stack] and the underlying [http://svn.resiprocate.org/dox/rutil/annotated.html rutil] library.
 
*Samples:  The unit test programs provide good sample uses of the classes, they can be found at [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/stack/test/ main/resip/stack/test] and [https://svn.resiprocate.org/viewsvn/resiprocate/main/rutil/test/ main/rutil/test].  In particular, check out [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/stack/test/testStack.cxx?view=markup testStack.cxx].
 
*Samples:  The unit test programs provide good sample uses of the classes, they can be found at [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/stack/test/ main/resip/stack/test] and [https://svn.resiprocate.org/viewsvn/resiprocate/main/rutil/test/ main/rutil/test].  In particular, check out [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/stack/test/testStack.cxx?view=markup testStack.cxx].
  
Line 20: Line 20:
 
**There is information on this wiki - [[DUM Overview]].
 
**There is information on this wiki - [[DUM Overview]].
 
**Some crude design diagrams and documentation can be found in [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/dum/doc/ main/resip/dum/doc]
 
**Some crude design diagrams and documentation can be found in [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/dum/doc/ main/resip/dum/doc]
**There is also Doxygen generated documentation for [http://svn.resiprocate.org/dox/dum/annotated.html DUM].
+
**There is Doxygen generated documentation for [http://svn.resiprocate.org/dox/dum/annotated.html DUM].
 
*Samples:  The unit test programs provide good sample uses, they can be found at [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/dum/test/ main/resip/dum/test].  In particular, check out the files pre-fixed as basicClient.
 
*Samples:  The unit test programs provide good sample uses, they can be found at [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/dum/test/ main/resip/dum/test].  In particular, check out the files pre-fixed as basicClient.
  
Line 30: Line 30:
 
**Some documentation can be found in [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/recon/doc/ main/resip/recon/doc].
 
**Some documentation can be found in [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/recon/doc/ main/resip/recon/doc].
 
*Samples:  The unit test programs provide good sample uses, they can be found at [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/recon/test/ main/resip/recon/test].  In particular, check out [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/recon/test/testUA.cxx?view=markup testUA.cxx].
 
*Samples:  The unit test programs provide good sample uses, they can be found at [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/recon/test/ main/resip/recon/test].  In particular, check out [https://svn.resiprocate.org/viewsvn/resiprocate/main/resip/recon/test/testUA.cxx?view=markup testUA.cxx].
 +
 +
===repro SIP Proxy===
 +
*Overview:  Sits above the core SIP stack, uses DUM for registration handling and the core stack to proxy SIP messaging. 
 +
*Location in SVN: main/repro
 +
*Documentation: 
 +
**There is information on this wiki - [[About repro]].
 +
**There is also Doxygen generated documentation for [http://svn.resiprocate.org/dox/repro/annotated.html repro].

Revision as of 09:27, 30 May 2011

How to Get Started

#1 - Get a copy of the code

Either grab a tarball of the latest release from the ReSIProcate Releases page or use Subversion/SVN to grab the latest working code (Quick_Subversion_Checkout_and_Compilation_HOWTO).

#2 - Select Project/API to Start Working With

reSIProcate stack

  • Overview: Core SIP stack. Handles SIP transactions, manages transports. Does not work with SIP messaging at the Dialog layer. Most users will not start by exclusively using this layer, instead start with either the DUM, repro, or recon layers.
  • Location in SVN: main/resip/stack
  • Documentation:
    • There is information on this wiki - Resip Overview.
    • Some crude design diagrams and documentation can be found in main/resip/stack/doc
    • There is Doxygen generated documentation for the stack and the underlying rutil library.
  • Samples: The unit test programs provide good sample uses of the classes, they can be found at main/resip/stack/test and main/rutil/test. In particular, check out testStack.cxx.

The Dialog Usage Manager (DUM)

  • Overview: Sits above the core SIP stack and deals with SIP Dialog creation and handling. Can be used to setup Registrations, Calls/InviteSessions, Subscriptions, Publications, etc. For Invite Sessions, hands received SDP bodies to the application for handling. Does not have any logic for forming an SDP answer from an offer, or any media handling capability. Most applications start with this layer, as it offers the high degree of flexibility and extensibility for building SIP based applications.
  • Location in SVN: main/resip/dum
  • Documentation:
    • There is information on this wiki - DUM Overview.
    • Some crude design diagrams and documentation can be found in main/resip/dum/doc
    • There is Doxygen generated documentation for DUM.
  • Samples: The unit test programs provide good sample uses, they can be found at main/resip/dum/test. In particular, check out the files pre-fixed as basicClient.

Conversation Manager (recon)

  • Overview: Sits above the core SIP stack and DUM layers and deals with media, Offer/Answer and the required SIP messaging. Uses the sipXtapi media stack to provide audio RTP handling.
  • Location in SVN: main/resip/recon
  • Documentation:
  • Samples: The unit test programs provide good sample uses, they can be found at main/resip/recon/test. In particular, check out testUA.cxx.

repro SIP Proxy

  • Overview: Sits above the core SIP stack, uses DUM for registration handling and the core stack to proxy SIP messaging.
  • Location in SVN: main/repro
  • Documentation:
    • There is information on this wiki - About repro.
    • There is also Doxygen generated documentation for repro.