zapISipInviteRC Interface Reference
[ZAP SIP UA layer]

import "zapISipInviteRC.idl";

List of all members.

Public Member Functions
void	sendInvite (in zapISipInviteResponseHandler rh)
	Send the current INVITE request.
void	cancel ()
	Cancel the ongoing invite by sending a CANCEL request (RFC3261 9.1).
Public Attributes
attribute zapISipRequest	request
	INVITE request object that will be sent out by sendInvite().
attribute zapISipInviteRCListener	listener
	A listener receiving notifications of received responses.
readonly attribute zapISipDialog	dialog
	The dialog associated with this request.

---

Member Function Documentation

void zapISipInviteRC::cancel (   )

Cancel the ongoing invite by sending a CANCEL request (RFC3261 9.1). Must only be called AFTER a request has been sent using zapISipInviteRC::sendInvite() and BEFORE a final response has been received. If cancel() is called before the request client has received a provisional response, sending of the CANCEL request will be delayed until the request client receives such a response. (RFC3261 9.1)

void zapISipInviteRC::sendInvite (  in zapISipInviteResponseHandler  rh  )

Send the current INVITE request. Once a request has been sent it can be cancelled with a call to zapISipInviteRC::cancel(). sendInvite() may be called repeatedly but only AFTER a FINAL FAILURE RESPONSE has been received. For requests outside of a dialog, the CSeq number will automatically be incremented by 1 for each request (RFC3261 8.1.3.5). For requests within a dialog, CSeq will be set to the incremented local sequence number.

---

Member Data Documentation

readonly attribute zapISipDialog zapISipInviteRC::dialog

The dialog associated with this request. Will be null if this is a request outside of a dialog.

attribute zapISipInviteRCListener zapISipInviteRC::listener

A listener receiving notifications of received responses. The request client user must remove the listener by setting this attribute to null once finished with the request client. This is important to prevent potential leaks due to circular references.

attribute zapISipRequest zapISipInviteRC::request

INVITE request object that will be sent out by sendInvite(). Request client users should ammend the request as appropriate before calling sendInvite().

---

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

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

---