Difference between revisions of "How to use dum"

From reSIProcate
Jump to navigation Jump to search
(The DUM doc outline page has been merged with this page. Explanations have moved to their own pages)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=== [[Introduction to the DialogUsageManager]] ===
+
=== Introduction to the DialogUsageManager ===
 +
The DialogUsageManager (or DUM) class sits on top of the transaction layer of the SIP stack. It keeps track of all of the Dialog-related data structures in multiple DialogSets. Each DialogSet contains all the Dialogs created by an initial request, which share the same SIP Call-Id and From tag. Inside a specific DialogSet on the UAC side, a BaseCreator can represent the intial request that generated the dialog. The DialogSet also contains several objects derived from BaseUsage that are using this particular dialog. There are several Usages available to a dialog: one InviteSession, one Registration, one Publication, multiple Subscriptions and multiple OutOfDialogRequests. Note: OutOfDialogRequests resemble a dialog, but are actually transactions that do not fit of the other categories. Requests that result in OutOfDialogRequests are MESSAGE and OPTIONS.
 +
 
 +
An initial SIP request is created by calling the makeX interfaces on the DUM. It is then sent using the send interface on the DUM. When a response is returned for the request, a callback from one of the Handler classes notifies the application. This will pass up some type of client or server usages class that can be used to send aditional messages and responses in the context of this particularr usage of the dialog.
  
 
=== [[DUM Definitions|Definitions]] ===
 
=== [[DUM Definitions|Definitions]] ===
  
 
=== How to use DUM ===
 
=== How to use DUM ===
*[[DUM Overview|Overview]]
 
 
*[[DUM Handlers|Handlers]]
 
*[[DUM Handlers|Handlers]]
 
*[[DUM Application Initialization|Application Initialization]]
 
*[[DUM Application Initialization|Application Initialization]]
 
*[[DUM Application Shutdown|Application Shutdown]]
 
*[[DUM Application Shutdown|Application Shutdown]]
 +
*[[DUM Registering and Authenticating]]
 
*[[DUM Creating New Sessions and Requests|Creating New Sessions and Requests]]
 
*[[DUM Creating New Sessions and Requests|Creating New Sessions and Requests]]
 +
*[[DUM Ending an Invite Session|Ending an Invite Session]]
 +
*[[DUM Creating New Client Subscriptions|Creating New Client Subscriptions]]
 
*[[DUM Associating Application Data with DialogSets and Dialogs|Associating Application Data with DialogSets and Dialogs]]
 
*[[DUM Associating Application Data with DialogSets and Dialogs|Associating Application Data with DialogSets and Dialogs]]
 
*[[DUM Configuration and Profiles|Configuration and Profiles]]
 
*[[DUM Configuration and Profiles|Configuration and Profiles]]
Line 16: Line 21:
 
*[[DUM Exception Handling|Exception Handling]]
 
*[[DUM Exception Handling|Exception Handling]]
 
*[[DUM Threading|Threading]]
 
*[[DUM Threading|Threading]]
 +
*[[DUM Application Timers]]
 
*[[DUM Common Errors|Common Errors]]
 
*[[DUM Common Errors|Common Errors]]
 
+
*[[DUM Client Outbound Support|Client Outbound Support (RFC 5626)]]
=== DUM Internals ===
 
*[[DUM Handles|Handles]]
 
*[[DUM HandleManager|DUM HandleManager]]
 
*[[DUM Usages|Usages]]
 

Latest revision as of 11:15, 27 February 2011

Introduction to the DialogUsageManager[edit]

The DialogUsageManager (or DUM) class sits on top of the transaction layer of the SIP stack. It keeps track of all of the Dialog-related data structures in multiple DialogSets. Each DialogSet contains all the Dialogs created by an initial request, which share the same SIP Call-Id and From tag. Inside a specific DialogSet on the UAC side, a BaseCreator can represent the intial request that generated the dialog. The DialogSet also contains several objects derived from BaseUsage that are using this particular dialog. There are several Usages available to a dialog: one InviteSession, one Registration, one Publication, multiple Subscriptions and multiple OutOfDialogRequests. Note: OutOfDialogRequests resemble a dialog, but are actually transactions that do not fit of the other categories. Requests that result in OutOfDialogRequests are MESSAGE and OPTIONS.

An initial SIP request is created by calling the makeX interfaces on the DUM. It is then sent using the send interface on the DUM. When a response is returned for the request, a callback from one of the Handler classes notifies the application. This will pass up some type of client or server usages class that can be used to send aditional messages and responses in the context of this particularr usage of the dialog.

Definitions[edit]

How to use DUM[edit]