zapISipSyntaxFactory Interface Reference
[ZAP SIP syntax layer]

import "zapISipSyntaxFactory.idl";

List of all members.

---

Detailed Description

An API for constructing syntacically correct SIP messages.

(see RFC 3261)

Implemented by component '@mozilla.org/zap/sipsyntaxfactory;1'

Public Member Functions
zapISipMessage	deserializeMessage (in ACString octets)
	Deserialize an RFC3261 'request' or 'response' into a zapISipRequest or zapISipResponse object.
zapISipURI	deserializeURI (in ACString octets)
	Deserialize an RFC3261 'SIP-URI', 'SIPS-URI' or 'absoluteURI'.
zapISipAddress	deserializeAddress (in ACString octets)
	Deserialize an RFC3261 'name-addr' or 'addr-spec' into a zapISipAddress object.
zapISipHeader	deserializeHeader (in ACString headerName, in ACString headerValue)
	Deserialize the given headerName and headerValue into a zapISipHeader structure.
void	deserializeRouteSet (in ACString octets, out unsigned long count,[array, retval, size_is(count)] out zapISipAddress routeset)
	Deserialize a comma-separated list of RFC3261 'name-addr' into an array of zapISipAddress objects.
zapISipRequest	createRequest ()
	Create a blank request object.
zapISipResponse	createResponse ()
	Create a blank response object.
zapISipAddress	createAddress (in AUTF8String displayName, in zapISipURI uri)
	Create a zapISipAddress from the URI and display name.
zapISipHeader	createHeader (in ACString name)
	Create a generic header.
zapISipToHeader	createToHeader (in zapISipAddress address)
	Create a To header from the given address.
zapISipFromHeader	createFromHeader (in zapISipAddress address)
	Create a From header from the given address.
zapISipRouteHeader	createRouteHeader (in zapISipAddress address)
	Create a Route header from the given address.
zapISipCallIDHeader	createCallIDHeader (in ACString callID)
	Create a Call-ID header from the given callID.
zapISipCSeqHeader	createCSeqHeader (in ACString method, in unsigned long sequenceNumber)
	Create a CSeq header from the given method and sequenceNumber.
zapISipMaxForwardsHeader	createMaxForwardsHeader ()
	Create a Max-Forwards header with default value (70).
zapISipViaHeader	createViaHeader ()
	Create a Via header with protocol name and version set to SIP/2.0.
zapISipContentTypeHeader	createContentTypeHeader (in ACString contentType, in ACString contentSubType)
	Create a Content-Type header from the given type/subtype.
zapISipContentLengthHeader	createContentLengthHeader (in unsigned long contentLength)
	Create a Content-Length header with the given value.
zapISipContactHeader	createContactHeader (in zapISipAddress address)
	Create a Contact Header from the given address.
zapISipRequireHeader	createRequireHeader (in ACString optionTag)
	Create a Require header with the given value.
zapISipRequireHeader	createUnsupportedHeader (in ACString optionTag)
	Create an Unsupported header with the given value.
zapISipAllowHeader	createAllowHeader (in ACString method)
	Create an Allow header with the given value.
ACString	getStandardReasonPhrase (in ACString statusCode)
	Get the standard RFC3261 or RFC3265 reason phrase for the given status code.

---

Member Function Documentation

zapISipAddress zapISipSyntaxFactory::createAddress (  in AUTF8String  displayName, in zapISipURI  uri )

Create a zapISipAddress from the URI and display name.

zapISipAllowHeader zapISipSyntaxFactory::createAllowHeader (  in ACString  method  )

Create an Allow header with the given value.

zapISipCallIDHeader zapISipSyntaxFactory::createCallIDHeader (  in ACString  callID  )

Create a Call-ID header from the given callID.

zapISipContactHeader zapISipSyntaxFactory::createContactHeader (  in zapISipAddress  address  )

Create a Contact Header from the given address. The address object will not be cloned.

zapISipContentLengthHeader zapISipSyntaxFactory::createContentLengthHeader (  in unsigned long  contentLength  )

Create a Content-Length header with the given value.

zapISipContentTypeHeader zapISipSyntaxFactory::createContentTypeHeader (  in ACString  contentType, in ACString  contentSubType )

Create a Content-Type header from the given type/subtype.

zapISipCSeqHeader zapISipSyntaxFactory::createCSeqHeader (  in ACString  method, in unsigned long  sequenceNumber )

Create a CSeq header from the given method and sequenceNumber.

zapISipFromHeader zapISipSyntaxFactory::createFromHeader (  in zapISipAddress  address  )

Create a From header from the given address. The address object will not be cloned.

zapISipHeader zapISipSyntaxFactory::createHeader (  in ACString  name  )

Create a generic header. The returned value can be QIed to one of the zapISipHeader subclasses, as appropriate for the given header name.

zapISipMaxForwardsHeader zapISipSyntaxFactory::createMaxForwardsHeader (   )

Create a Max-Forwards header with default value (70).

zapISipRequest zapISipSyntaxFactory::createRequest (   )

Create a blank request object.

zapISipRequireHeader zapISipSyntaxFactory::createRequireHeader (  in ACString  optionTag  )

Create a Require header with the given value.

zapISipResponse zapISipSyntaxFactory::createResponse (   )

Create a blank response object.

zapISipRouteHeader zapISipSyntaxFactory::createRouteHeader (  in zapISipAddress  address  )

Create a Route header from the given address. The address object will not be cloned.

zapISipToHeader zapISipSyntaxFactory::createToHeader (  in zapISipAddress  address  )

Create a To header from the given address. The address object will not be cloned.

zapISipRequireHeader zapISipSyntaxFactory::createUnsupportedHeader (  in ACString  optionTag  )

Create an Unsupported header with the given value.

zapISipViaHeader zapISipSyntaxFactory::createViaHeader (   )

Create a Via header with protocol name and version set to SIP/2.0.

zapISipAddress zapISipSyntaxFactory::deserializeAddress (  in ACString  octets  )

Deserialize an RFC3261 'name-addr' or 'addr-spec' into a zapISipAddress object.

zapISipHeader zapISipSyntaxFactory::deserializeHeader (  in ACString  headerName, in ACString  headerValue )

Deserialize the given headerName and headerValue into a zapISipHeader structure. The returned value can be QIed to one of the zapISipHeader subclasses, as appropriate for the given header name.

zapISipMessage zapISipSyntaxFactory::deserializeMessage (  in ACString  octets  )

Deserialize an RFC3261 'request' or 'response' into a zapISipRequest or zapISipResponse object.

void zapISipSyntaxFactory::deserializeRouteSet (  in ACString  octets, out unsigned long  count, [array, retval, size_is(count)] out zapISipAddress  routeset )

Deserialize a comma-separated list of RFC3261 'name-addr' into an array of zapISipAddress objects. The syntax parsed is that of a Route or Record-Route header value (or an empty string): '0*1(route-param *(COMMA route-param))' rr-params will be ignored.

zapISipURI zapISipSyntaxFactory::deserializeURI (  in ACString  octets  )

Deserialize an RFC3261 'SIP-URI', 'SIPS-URI' or 'absoluteURI'. Currently only 'SIP-URI' and 'SIPS-URI' parsing is implemented. The returned object will implement zapISipSIPURI.

ACString zapISipSyntaxFactory::getStandardReasonPhrase (  in ACString  statusCode  )

Get the standard RFC3261 or RFC3265 reason phrase for the given status code.

---

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

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

---