zapISipMessage Interface Reference
[ZAP SIP syntax layer]

import "zapISipMessage.idl";

Inheritance diagram for zapISipMessage:

List of all members.

Public Member Functions
AUTF8String	headerNameAt (in unsigned long i)
	Returns the canonical header name for the header at position 'i'.
zapISipHeader	headerAt (in unsigned long i)
void	appendHeader (in zapISipHeader header)
void	insertHeaderBefore (in zapISipHeader header, in unsigned long i)
void	removeHeaderAt (in unsigned long i)
void	removeHeader (in zapISipHeader header)
void	getHeaders (in ACString name, out unsigned long count,[retval, array, size_is(count)] out zapISipHeader headers)
	Helper to get a (possibly empty) list of all headers with the given name.
void	getHeaderIndices (in ACString name, out unsigned long count,[retval, array, size_is(count)] out unsigned long indices)
	Helper to get the indices of all headers with the given name.
void	removeHeaders (in ACString name)
	Helper to remove all headers with the given name.
zapISipHeader	getTopHeader (in ACString name)
	Helper to get the top-most header with the given name.
zapISipHeader	getSingleHeader (in ACString name)
	Helper to get a single header of the given name Throws an error if there are multiple headers with the given name.
zapISipViaHeader	getTopViaHeader ()
	Helper to get the top-most Via header.
zapISipRouteHeader	getTopRouteHeader ()
	Helper to get the top-most Route header.
zapISipContactHeader	getTopContactHeader ()
	Helper to get the top-most Contact header.
zapISipCallIDHeader	getCallIDHeader ()
	Helper to get the Call-ID header.
zapISipToHeader	getToHeader ()
	Helper to get the To header.
zapISipFromHeader	getFromHeader ()
	Helper to get the From header.
zapISipCSeqHeader	getCSeqHeader ()
	Helper to get the CSeq header.
void	setContent (in ACString contentType, in ACString contentSubType, in ACString bodyContent)
	Helper to set Content-Type, Content-Length and body content .
void	ensureContentLengthHeader ()
	Add a Content-Length header if there isn't one already.
Public Attributes
attribute boolean	isRequest
	true if this message is a request (and implements zapISipRequest) false if this message is a response (and implements zapISipResponse)
attribute ACString	version
readonly attribute unsigned long	headerCount
attribute ACString	body

---

Member Function Documentation

void zapISipMessage::appendHeader (  in zapISipHeader  header  )

void zapISipMessage::ensureContentLengthHeader (   )

Add a Content-Length header if there isn't one already. This is called by SipTransport::sendRequest() and SipTransport::sendResponse() to ensure that outgoing SIP messages are correctly framed for delivery over TCP.

zapISipCallIDHeader zapISipMessage::getCallIDHeader (   )

Helper to get the Call-ID header. Throws an error if there are multiple Call-ID headers, null if there is none.

zapISipCSeqHeader zapISipMessage::getCSeqHeader (   )

Helper to get the CSeq header. Throws an error if there are multiple CSeq headers, null if there is none.

zapISipFromHeader zapISipMessage::getFromHeader (   )

Helper to get the From header. Throws an error if there are multiple From headers, null if there is none.

void zapISipMessage::getHeaderIndices (  in ACString  name, out unsigned long  count, [retval, array, size_is(count)] out unsigned long  indices )

Helper to get the indices of all headers with the given name. The list will be sorted with the top-most matching header coming first (low->high indices)

void zapISipMessage::getHeaders (  in ACString  name, out unsigned long  count, [retval, array, size_is(count)] out zapISipHeader  headers )

Helper to get a (possibly empty) list of all headers with the given name. The list will be sorted with the top-most matching header coming first.

zapISipHeader zapISipMessage::getSingleHeader (  in ACString  name  )

Helper to get a single header of the given name Throws an error if there are multiple headers with the given name.

zapISipToHeader zapISipMessage::getToHeader (   )

Helper to get the To header. Throws an error if there are multiple To headers, null if there is none.

zapISipContactHeader zapISipMessage::getTopContactHeader (   )

Helper to get the top-most Contact header.

zapISipHeader zapISipMessage::getTopHeader (  in ACString  name  )

Helper to get the top-most header with the given name. Returns null if no matching header can be found.

zapISipRouteHeader zapISipMessage::getTopRouteHeader (   )

Helper to get the top-most Route header.

zapISipViaHeader zapISipMessage::getTopViaHeader (   )

Helper to get the top-most Via header.

zapISipHeader zapISipMessage::headerAt (  in unsigned long  i  )

AUTF8String zapISipMessage::headerNameAt (  in unsigned long  i  )

Returns the canonical header name for the header at position 'i'. Short header names defined in RFC3261 will be expanded into their long equivalents.

void zapISipMessage::insertHeaderBefore (  in zapISipHeader  header, in unsigned long  i )

void zapISipMessage::removeHeader (  in zapISipHeader  header  )

void zapISipMessage::removeHeaderAt (  in unsigned long  i  )

void zapISipMessage::removeHeaders (  in ACString  name  )

Helper to remove all headers with the given name.

void zapISipMessage::setContent (  in ACString  contentType, in ACString  contentSubType, in ACString  bodyContent )

Helper to set Content-Type, Content-Length and body content .

---

Member Data Documentation

attribute ACString zapISipMessage::body

readonly attribute unsigned long zapISipMessage::headerCount

attribute boolean zapISipMessage::isRequest

true if this message is a request (and implements zapISipRequest) false if this message is a response (and implements zapISipResponse)

attribute ACString zapISipMessage::version

---

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

• /home/alex/devel/zap/mozilla/zap/sip/idl/syntax/zapISipMessage.idl

---