zapISipDialog Interface Reference
[ZAP SIP UA layer]

import "zapISipDialog.idl";

List of all members.

Public Member Functions
void	terminateDialog ()
	Terminate this dialog.
zapISipNonInviteRC	createNonInviteRequestClient (in ACString method)
	Obtain a request client object for transactionally sending a NON-INVITE request within this dialog.
zapISipInviteRC	createInviteRequestClient ()
void	getRouteSet (out unsigned long count,[array, retval, size_is(count)] out zapISipAddress routeset)
	Route set (taken from Record-Route header).
Public Attributes
attribute zapISipDialogListener	listener
attribute zapISipRequestHandler	requestHandler
readonly attribute ACString	dialogID
	Call-ID + ";" + localTag + ";" + remoteTag.
readonly attribute ACString	callID
	Call-ID.
readonly attribute ACString	localTag
	For dialogs constructed at UAS end, the local tag equals the To tag of response that established the dialog.
readonly attribute ACString	remoteTag
	For dialogs constructed at UAS end, the remote tag equals the From tag of request that led to establishing of the dialog.
readonly attribute unsigned long	localSequenceNumber
	Local sequence number for sequencing requests sent from the local side of this dialog.
readonly attribute unsigned long	remoteSequenceNumber
	Remote sequence number for sequencing requests sent from the remote side of this dialog.
readonly attribute zapISipURI	localURI
	Local URI.
readonly attribute zapISipURI	remoteURI
	Remote URI.
readonly attribute zapISipURI	remoteTarget
	Remote target (taken from Contact field of initial request/response).
readonly attribute boolean	secure
	Secure flag.
readonly attribute ACString	dialogState
	"EARLY", "CONFIRMED" or "TERMINATED"
const unsigned long	UNINITIALIZED_SEQUENCE_NUMBER = 0xFFFFFFFF
	2^32-1 constant indicating an uninitialized sequence number.

---

Member Function Documentation

zapISipInviteRC zapISipDialog::createInviteRequestClient (   )

zapISipNonInviteRC zapISipDialog::createNonInviteRequestClient (  in ACString  method  )

Obtain a request client object for transactionally sending a NON-INVITE request within this dialog. The zapISipNonInviteRC::request attribute will be initialized with a suitable request template for the given method.

void zapISipDialog::getRouteSet (  out unsigned long  count, [array, retval, size_is(count)] out zapISipAddress  routeset )

Route set (taken from Record-Route header).

void zapISipDialog::terminateDialog (   )

Terminate this dialog.

---

Member Data Documentation

readonly attribute ACString zapISipDialog::callID

Call-ID.

readonly attribute ACString zapISipDialog::dialogID

Call-ID + ";" + localTag + ";" + remoteTag.

readonly attribute ACString zapISipDialog::dialogState

"EARLY", "CONFIRMED" or "TERMINATED"

attribute zapISipDialogListener zapISipDialog::listener

readonly attribute unsigned long zapISipDialog::localSequenceNumber

Local sequence number for sequencing requests sent from the local side of this dialog. The special value 2^32-1 (UNINITIALIZED_SEQUENCE_NUMBER) indicates that the sequence number is not initialized yet (because there has not been a request inside the dialog from our end).

readonly attribute ACString zapISipDialog::localTag

For dialogs constructed at UAS end, the local tag equals the To tag of response that established the dialog. For dialog constructed at UAC end, the local tag equals the From tag of request that led to establishing of the dialog.

readonly attribute zapISipURI zapISipDialog::localURI

Local URI.

readonly attribute unsigned long zapISipDialog::remoteSequenceNumber

Remote sequence number for sequencing requests sent from the remote side of this dialog. The special value 2^32-1 (UNINITIALIZED_SEQUENCE_NUMBER) indicates that the sequence number is not initialized yet (because there has not been a request inside the dialog from the remote end).

readonly attribute ACString zapISipDialog::remoteTag

For dialogs constructed at UAS end, the remote tag equals the From tag of request that led to establishing of the dialog. For dialogs constructed at UAC end, the remote tag equals the To tag of response that established dialog.

readonly attribute zapISipURI zapISipDialog::remoteTarget

Remote target (taken from Contact field of initial request/response).

readonly attribute zapISipURI zapISipDialog::remoteURI

Remote URI.

attribute zapISipRequestHandler zapISipDialog::requestHandler

readonly attribute boolean zapISipDialog::secure

Secure flag.

const unsigned long zapISipDialog::UNINITIALIZED_SEQUENCE_NUMBER = 0xFFFFFFFF

2^32-1 constant indicating an uninitialized sequence number. (By virtue of initial sequence number being < 2^31, we can assume that 2^32-1 will never be reached within a dialog)

---

The documentation for this interface was generated from the following file:

• /home/alex/devel/zap/mozilla/zap/sip/idl/zapISipDialog.idl

---