HP-UX C SIP Stack Message Layer Reference Guide HP-UX 11i v3 Version 4.5 Manufacturing Part Number: 5992-4079 February 2008 © Copyright 2007-2008 Hewlett-Packard Development Company, L.P.
Legal Notices © Copyright 2007-2008 Hewlett-Packard Development Company, L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation and Technical Data for Commercial Items are licensed to the U.S. Government under vendor’s standard commercial license. The information contained herein is subject to change without notice.
CONTENTS 1 Message Object Functions Control Functions Get and Set Functions 2 4 5 12 Address Functions Control Functions 70 Get and Set Functions 82 Address Comparison Functions 87 SIP URL: Get and Set Functions 3 4 89 Absolute URI: Get and Set Functions 121 TEL URI: Get and Set Functions 126 Allow Header Functions Control Functions 144 Get and Set Functions 152 Allow-Events Header Functions Control Functions 162 Get and Set Functions 170 Authentication Header Functions Control F
Get and Set Functions 6 7 8 9 10 11 iv 192 Authentication-Info Header Functions Control Functions 232 Get and Set Functions 240 Authorization Header Functions Control Functions 260 Get and Set Functions 268 Contact Header Functions Control Functions 312 Get and Set Functions 320 Content-Disposition Header Functions Control Functions 344 Get and Set Functions 353 Content-Type Header Functions Control Functions 368 Get and Set Functions 376 CSeq Header Functions Control Functions 401
12 13 14 15 16 17 18 Date Header Functions Control Functions 422 Get and Set Functions 432 Event Header Functions Control Functions 452 Get and Set Functions 461 Expires Header Functions Control Functions 480 Get and Set Functions 489 Min-SE Header Functions Control Functions 500 Get and Set Functions 508 Other Header Functions Control Functions 518 Get and Set Functions 525 Party Header Functions Control Functions 538 Get and Set Functions 550 RAck Header Functions Control Function
19 20 21 22 23 24 25 vi Refer-To Header Functions Control Functions 590 Get and Set Functions 598 Referred-By Header Functions Control Functions 614 Get and Set Functions 622 Retry-After Header Functions Control Functions 640 Get and Set Functions 648 Route-Hop Header Functions Control Functions 666 Get and Set Functions 674 RSeq Header Functions Control Functions 692 Get and Set Functions 700 Session-Expires Header Functions Control Functions 710 Get and Set Functions 718 Subscrip
26 27 28 Via Header Functions Control Functions 760 Get and Set Functions 768 Body Functions Control Functions 802 Get and Set Functions 811 Functions for All Headers Control Functions 29 826 Message Type Definitions Handle Type Definitions 834 String Name Type Definitions 865 Message API Type Definitions 894 Index 1 vii
viii HP C SIP Stack Message Layer Reference Guide
ABOUT THIS DOCUMENT The C SIP Stack (B.11.31.01.001) consists a suite of APIs, sample code and user documentation for developers who wish to build SIP applications. The current software conforms to RFC 3261 and numerous SIP extensions stack. The HP-UX C SIP Stack Reference Guide and the HP-UX C SIP Stack Message Layer Reference Guide are for developers of SIP applications. These Reference Guides list the Application Programming Interfaces (API) functions of the SIP Stack.
Document Organization The HP-UX C SIP Stack Message Layer Reference Guide is organized as follows: x Chapter 1 Message Object Functions Describes message object functions found in the RvSipMsg.h header file. Chapter 2 Address Functions Describes the Address functions found in the RvSipAddress.h header file. Chapter 3 Allow Header Functions Describes the Allow header functions found in the RvSipAllowHeader.h header file.
Chapter 15 Expires Header Functions Describes the Expires header functions found in the RvSipExpiresHeader.h header file. Chapter 16 Min-SE Header Functions Describes the Min-SE header functions found in the RvSipMin-SEHeader.h header file. Chapter 17 Other Header Functions Describes the contains the Other header functions included in the RvSipOtherHeader.h header file. Chapter 18 Party Header Functions Describes the Party header functions, for To/From headers, found in the RvSipPartyHeader.
Chapter 29 Functions for All Headers Describes the functions that can be used for all headers, and are found in the RvSipHeader.h header file. Chapter 30 Message Type Definitions Describes the SIP Stack Message type definitions defined in the RvSipMsgTypes.h and RvSipXXXHeader.h header files. Typographic Conventions This document uses the following typographic conventions: monospace Computer output, files, directories, software elements such as command options, function names, and parameters.
HP-UX C SIP Stack Programmer’s Guide HP-UX Java SIP Stack Programmer’s Guide The following related documents are available for the SIP product: Request for Comments (RFC) documents: RFC 2246 (The TLS Protocol Version 1.0) http://www.ietf.org/rfc/rfc2246.txt?number=2246 RFC 2848 (The PINT Service Protocol) http://www.ietf.org/rfc/rfc2848.txt?number=2848 RFC 2806 (URLs for Telephone Calls) http://www.ietf.org/rfc/rfc2806.txt?number=2806 RFC 2976 (The SIP INFO Method) http://www.ietf.
RFC 3515 (The Session Initiation Protocol (SIP) Refer Method) http://www.ietf.org/rfc/rfc3515.txt?number=3515 RFC 3581 (An Extension to the Session Initiation Protocol (SIP) for Symmetric Response Routing) http://www.ietf.org/rfc/rfc3581.txt?number=3581 RFC 3841 (Caller Preferences for the Session Initiation Protocol (SIP)) http://www.ietf.org/rfc/rfc3841.
MESSAGE MODULE The Message API provides access to SIP message content enabling the application to browse and edit any part of the message. There are API functions for complete SIP messages and also for message parts such as headers and URLs. The Message API is also the interface to the parsers and encoders provided with the SIP Stack. You can copy, store and re-use messages and message-parts.
Refer-To Header Functions Retry-After Header Functions Route-Hop Header Functions RSeq Header Functions Via Header Functions Functions for All Headers Body Functions Body Part Functions
1 MESSAGE OBJECT FUNCTIONS A message object (message) represents a SIP message and holds all SIP message information including start-line, headers and message body. Message object functions enable you to construct, destruct, copy, encode, parse, access and change message object parameters and manage the list of headers in messages. This section contains message object functions found in the RvSipMsg.h header file.
Control Functions CONTROL FUNCTIONS 4 The Control functions are: RvSipMsgConstruct() RvSipMsgDestruct() RvSipMsgCopy() RvSipMsgEncode() RvSipMsgParse() RvSipMsgConstructHeaderInMsgByType() RvSipMsgForceCompactForm() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipMsgConstruct() RvSipMsgConstruct() DESCRIPTION Constructs a SIP message. The message is constructed on a page taken from a given memory pool. SYNTAX RvStatus RvSipMsgConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, OUT RvSipMsgHandle* hSipMsg); PARAMETERS hMsgMgr The handle to the MessageMgr. hPool The handle to the memory pool. The RvSipMsgConstruct() function uses a page from this pool for the newly created message. hSipMsg The handle to the new message.
Control Functions RvSipMsgDestruct() RvSipMsgDestruct() DESCRIPTION A destructor. Destroys the message and frees all the object resources. SYNTAX void RvSipMsgDestruct( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to the message to destruct. RETURN VALUES None.
Control Functions RvSipMsgCopy() RvSipMsgCopy() DESCRIPTION Copies all parameters from a source message to a destination message. You should construct the destination message before using this function. SYNTAX RvStatus RvSipMsgCopy( INOUT RvSipMsgHandle hDestination, IN hSource); RvSipMsgHandle PARAMETERS hDestination The handle to the destination message to which values are copied. hSource The handle to the source message. RETURN VALUES Returns RvStatus.
Control Functions RvSipMsgEncode() RvSipMsgEncode() DESCRIPTION Encodes a message to a textual SIP message. The textual SIP message is placed on a page taken from a given memory pool. To copy the message from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipMsgEncode( IN RvSipMsgHandle hSipMsg, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hSipMsg The handle to the message to encode. hPool The handle to a pool.
Control Functions RvSipMsgParse() RvSipMsgParse() DESCRIPTION Parses a SIP textual message into a message. All the textual parameters are placed inside the object. Note that the given message buffer must be ended with two CRLFs. One CRLF must separate between headers in the message. SYNTAX RvStatus RvSipMsgParse( IN RvSipMsgHandle hMsg, IN RvChar* buffer, IN RvInt32 bufferLen); PARAMETERS hMsg The handle to the message. buffer The buffer containing a textual message ending with two CRLFs.
Control Functions RvSipMsgConstructHeaderInMsgByType() RvSipMsgConstructHeaderInMsgByType() DESCRIPTION Constructs a header in a message according to the header type. SYNTAX RvStatus RvSipMsgConstructHeaderInMsgByType( IN RvSipMsgHandle hMsg, IN RvSipHeaderType eType, IN RvBool bPushHeaderAtHead, OUT void** phHeader); PARAMETERS hMsg The handle to the message. eType The type of the header to construct.
Control Functions RvSipMsgForceCompactForm() RvSipMsgForceCompactForm() DESCRIPTION Instructs a message to force all its headers to use compact form. If compact form is forced and a message is encoded, all headers that can take compact form will be encoded with compact form. Headers that are handled by the Stack as Other headers and are added to the message by the application will not use compact form. It is the responsibility of the application to set such header names with compact form.
Get and Set Functions GET AND SET FUNCTIONS 12 The Get and Set functions are: RvSipMsgGetStringLength() RvSipMsgGetMsgType() RvSipMsgGetRequestMethod() RvSipMsgGetStrRequestMethod() RvSipMsgSetMethodInRequestLine() RvSipMsgGetRequestUri() RvSipMsgSetRequestUri() RvSipMsgGetStatusCode() RvSipMsgSetStatusCode() RvSipMsgGetReasonPhrase() RvSipMsgSetReasonPhrase() RvSipMsgGetHeader() RvSipMsgGetHeaderByType() RvSipMsgGetHeaderByName() RvSipMsgGe
Get and Set Functions RvSipMsgSetContentTypeHeader() RvSipMsgGetBody() RvSipMsgSetBody() RvSipMsgGetBodyObject() RvSipMsgSetBodyObject() RvSipMsgGetRpoolString() RvSipMsgSetRpoolString() RvSipMsgGetStrBadSyntaxStartLine() RvSipMsgStartLineFix() RvSipMsgSetCallIdCompactForm() RvSipMsgGetCallIdCompactForm() RvSipMsgSetContentLengthCompactForm() RvSipMsgGetContentLengthCompactForm() Message Object Functions 13
Get and Set Functions RvSipMsgGetStringLength() RvSipMsgGetStringLength() DESCRIPTION Some of the message parameters are kept in a string format, for example, the reason phrase of a response message. In order to get such a parameter from the message, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipMsgGetMsgType() RvSipMsgGetMsgType() DESCRIPTION Gets the message type: request, response or undefined. SYNTAX RvSipMsgType RvSipMsgGetMsgType( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to the message. RETURN VALUES Returns the enumeration of the message type. For more information, see Message Type Definitions.
Get and Set Functions RvSipMsgGetRequestMethod() RvSipMsgGetRequestMethod() DESCRIPTION Gets the method type enumeration from the message request line. For more information, see RvSipMethodType in Message Type Definitions. SYNTAX RvSipMethodType RvSipMsgGetRequestMethod( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to the message. RETURN VALUES Returns the request method type.
Get and Set Functions RvSipMsgGetStrRequestMethod() RvSipMsgGetStrRequestMethod() DESCRIPTION Copies the method type string from the message request line into a given buffer. Use this function if RvSipMsgGetRequestMethod() returns RVSIP_METHOD_OTHER. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipMsgSetMethodInRequestLine() RvSipMsgSetMethodInRequestLine() DESCRIPTION Sets the method type in the request line of the message. The function gets an enumeration and string as input. The string is set as method only if the enumeration is RVSIP_METHOD_OTHER. Otherwise, the string is ignored. SYNTAX RvStatus RvSipMsgSetMethodInRequestLine( INOUT RvSipMsgHandle hSipMsg, IN RvSipMethodType eRequestMethod, IN RvChar* strMethod); PARAMETERS hSipMsg The handle to a message.
Get and Set Functions RvSipMsgGetRequestUri() RvSipMsgGetRequestUri() DESCRIPTION Gets the request URI address object handle. SYNTAX RvSipAddressHandle RvSipMsgGetRequestUri( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to a message. RETURN VALUES Returns a handle to the URI address object or NULL if no URI address exists.
Get and Set Functions RvSipMsgSetRequestUri() RvSipMsgSetRequestUri() DESCRIPTION Sets the request URI address in the message request line. SYNTAX RvStatus RvSipMsgSetRequestUri( IN RvSipMsgHandle hSipMsg, IN RvSipAddressHandle hSipUrl); PARAMETERS hSipMsg The handle to a message. hSipUrl The handle to an address object with the request URI. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgGetStatusCode() RvSipMsgGetStatusCode() DESCRIPTION Gets the response code from the message start-line. SYNTAX RvSipMsgGetStatusCode( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to the message. RETURN VALUES Returns a response code or UNDEFINED if there is no response code or the message represents a request message.
Get and Set Functions RvSipMsgSetStatusCode() RvSipMsgSetStatusCode() DESCRIPTION Sets a status code in the message status line. This will set the message to represent a response message. SYNTAX RvStatus RvSipMsgSetStatusCode( IN RvSipMsgHandle hSipMsg, IN RvBool code, IN RvBool insertDefaultReasonPhrase); PARAMETERS hSipMsg The handle to a message. code Status response code to be set in the message.
Get and Set Functions RvSipMsgGetReasonPhrase() RvSipMsgGetReasonPhrase() DESCRIPTION Copies the reason phrase from the message status line into a given buffer. If the bufferLen size adequate, the function copies the parameter into the strBuffer. Otherwise, it returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipMsgSetReasonPhrase() RvSipMsgSetReasonPhrase() DESCRIPTION Sets the reason phrase in the message status line. SYNTAX RvStatus RvSipMsgSetReasonPhrase( IN RvSipMsgHandle hSipMsg, IN RvChar* strReasonPhrase); PARAMETERS hSipMsg The handle to the message. strReasonPhrase The reason phrase to be set in the message. If NULL is supplied, the existing reason phrase of the message is removed RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgGetHeader() RvSipMsgGetHeader() DESCRIPTION Gets a header from the header list. The message holds most headers in a sequential list except, To, From, CallId, Cseq, ContentLength and Content-Type headers. The function returns the handle to the requested header as a void pointer. You should check the pHeaderType parameter and cast the return value to the appropriate header handle. Note The RvSipMsgGetHeaderExt() function is an extension of this function.
Get and Set Functions RvSipMsgGetHeader() RETURN VALUES Returns the header handle as void*, or NULL if there is no header to retrieve.
Get and Set Functions RvSipMsgGetHeaderByType() RvSipMsgGetHeaderByType() DESCRIPTION Gets a header by type from the header list. The message holds most headers in a sequential list except, To, From, CallId, Cseq, ContentLength and Content-Type headers. The function returns the handle to the requested header as a void pointer. You should cast the return value to the header type you requested. Note The RvSipMsgGetHeaderByTypeExt() function is an extension of this function.
Get and Set Functions RvSipMsgGetHeaderByType() RETURN VALUES Returns the header handle as void*, or NULL if there is no header to retrieve.
Get and Set Functions RvSipMsgGetHeaderByName() RvSipMsgGetHeaderByName() DESCRIPTION Gets a header by name from the header list. The message holds most headers in a sequential list except, To, From, CallId, Cseq, ContentLength and ContentType headers. This function should be used only for headers of type RVSIP_HEADERTYPE_OTHER. Note The RvSipMsgGetHeaderByNameExt() function is an extension of this function.
Get and Set Functions RvSipMsgGetHeaderByName() RETURN VALUES Returns the Other header handle, or NULL if no Other header handle with the same name exists.
Get and Set Functions RvSipMsgGetHeaderExt() RvSipMsgGetHeaderExt() DESCRIPTION Gets a header from the header list. The message holds most headers in a sequential list except for the To, From, CallId, Cseq, ContentLength and Content-Type headers. This function returns the handle to the requested header as a void pointer. You should check the pHeaderType parameter and cast the return value to the appropriate header handle. The header list can hold both valid syntax and badsyntax headers.
Get and Set Functions RvSipMsgGetHeaderExt() hListElem The handle to the current position in the list. Supply this value if you chose next or previous in the location parameter. This is also an output parameter and will be set with a link to requested header in the list. hListElem The handle to the current position in the list. Supply this value if you chose “next” or “previous” in the location parameter. This is also an output parameter and will be set with a link to requested header in the list.
Get and Set Functions RvSipMsgGetHeaderByTypeExt() RvSipMsgGetHeaderByTypeExt() DESCRIPTION Gets a header by type from the header list. The message holds most headers in a sequential list except for the To, From, CallId, Cseq, ContentLength and Content-Type headers. This function returns the handle to the requested header as a void pointer. You should cast the return value to the header type you requested. The header list can hold both valid syntax and bad-syntax headers.
Get and Set Functions RvSipMsgGetHeaderByTypeExt() eOption Specifies whether the application wishes to get only legal syntax headers, or any header (legal and illegal headers). hListElem The handle to the current position in the list. Supply this value if you chose “next” or “previous” in the location parameter. This is also an output parameter and will be set with a link to requested header in the list. hListElem The handle to the current position in the list.
Get and Set Functions RvSipMsgGetHeaderByNameExt() RvSipMsgGetHeaderByNameExt() DESCRIPTION Gets a header by name from the header list. The message holds most headers in a sequential list except for the To, From, CallId, Cseq, ContentLength and Content-Type headers. This function should be used only for headers of the RVSIP_HEADERTYPE_OTHER type. The header list can hold both valid syntax and bad-syntax headers.
Get and Set Functions RvSipMsgGetHeaderByNameExt() eOption Specifies whether the application wishes to get only legal syntax headers, or any header (legal and illegal headers). hListElem The handle to the current position in the list. Supply this value if you chose “next” or “previous” in the location parameter. This is also an output parameter and will be set with a link to requested header in the list. hListElem The handle to the current position in the list.
Get and Set Functions RvSipMsgGetBadSyntaxHeaders() RvSipMsgGetBadSyntaxHeaders() DESCRIPTION Gets a header with a syntax error from the message. The message holds most headers in a sequential list. To, From, CallId, Cseq, ContentLength and ContentType headers are held separately. This function scans all headers in the message (the ones that are in the header list and the ones that are not) and retrieves only headers with syntax errors.
Get and Set Functions RvSipMsgGetBadSyntaxHeaders() hListElem The handle to the current position in the list. Supply this value if you chose “next” or “previous” in the location parameter. This is also an output parameter and will be set with a link to the requested header in the list. pHeaderType The type of retrieved header. RETURN VALUES Returns the header handle as void*, or NULL if there is no header to retrieve.
Get and Set Functions RvSipMsgPushHeader() RvSipMsgPushHeader() DESCRIPTION Inserts a given header into the header list based on a given location. For example, first, last, before or after a given element. The message holds most headers in a sequential list except, To, From, CallId, Cseq, ContentLength and Content-Type headers. The header you supply is copied before it is inserted into the list. The pNewHeader output parameter contains the handle to the actual header pushed into the list.
Get and Set Functions RvSipMsgPushHeader() hListElem The handle to the current position in the list. Supply this value if you chose next or previous in the location parameter. This is also an output parameter and will be set with a link to requested header in the list. pNewHeader The handle of the actual header that is inserted into the list. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgRemoveHeaderAt() RvSipMsgRemoveHeaderAt() DESCRIPTION Removes an header from the header list. The message holds most headers in a sequential list except, To, From, CallId, Cseq, ContentLength and Content-Type headers. You should supply this function with the list element of the header you wish to remove. SYNTAX RvStatus RvSipMsgRemoveHeaderAt( IN RvSipMsgHandle hSipMsg, IN RvSipHeaderListElemHandle hListElem); PARAMETERS hSipMsg The handle to the message.
Get and Set Functions RvSipMsgGetToHeader() RvSipMsgGetToHeader() DESCRIPTION Gets the handle to the To header from the message. SYNTAX RvSipPartyHeaderHandle RvSipMsgGetToHeader( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to a message. RETURN VALUES Returns RvSipPartyHeaderHandle, or NULL if the message does not contain a To header.
Get and Set Functions RvSipMsgSetToHeader() RvSipMsgSetToHeader() DESCRIPTION Sets a To header in the message. If there is no To header in the message, the function constructs a To header. SYNTAX RvStatus RvSipMsgSetToHeader( IN RvSipMsgHandle hSipMsg, IN RvSipPartyHeaderHandle hToHeader); PARAMETERS hSipMsg The handle to the message. hToHeader The handle to the To header to be set. If a NULL is supplied, the existing To header is removed from the message. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgGetFromHeader() RvSipMsgGetFromHeader() DESCRIPTION Gets a handle to the From header from the message. SYNTAX RvSipPartyHeaderHandle RvSipMsgGetFromHeader( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to a message. RETURN VALUES MsgPartyHeader handle, or NULL if the message does not contain a From header.
Get and Set Functions RvSipMsgSetFromHeader() RvSipMsgSetFromHeader() DESCRIPTION Sets a From header in the message. If no From header exists in the message, the function constructs a From header. SYNTAX RvStatus RvSipMsgSetFromHeader( IN RvSipMsgHandle hSipMsg, IN RvSipPartyHeaderHandle hFromHeader); PARAMETERS hSipMsg The handle to a message. hFromHeader The handle to the From header to be set. If a NULL value is supplied, the existing From header is removed from the message.
Get and Set Functions RvSipMsgGetContentLengthHeader() RvSipMsgGetContentLengthHeader() DESCRIPTION Gets the content length of the message. The content length indicates the size of the body string. SYNTAX RvInt32 RvSipMsgGetContentLengthHeader( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to the message. RETURN VALUES Returns content length or UNDEFINED if no body is set in the message.
Get and Set Functions RvSipMsgSetContentLengthHeader() RvSipMsgSetContentLengthHeader() DESCRIPTION Sets a Content Length value in the message. The Content Length indicates the size of the message body. SYNTAX RvStatus RvSipMsgSetContentLengthHeader( IN RvSipMsgHandle hSipMsg, IN RvInt32 contentLen); PARAMETERS hSipMsg The handle to the message. contentLen The Content Length value to be set. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgGetCSeqHeader() RvSipMsgGetCSeqHeader() DESCRIPTION Gets the handle to the Cseq header from the message. SYNTAX RvSipCSeqHeaderHandle RvSipMsgGetCSeqHeader( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to a message. RETURN VALUES Returns the CSeq header handle, or NULL if no CSeq header handle exists.
Get and Set Functions RvSipMsgSetCSeqHeader() RvSipMsgSetCSeqHeader() DESCRIPTION Sets a CSeq header in the message. If there is no CSeq header in the message, the function constructs one. SYNTAX RvStatus RvSipMsgSetCSeqHeader( IN RvSipMsgHandle hSipMsg, IN RvSipCSeqHeaderHandle hCSeqHeader); PARAMETERS hSipMsg The handle to the message. hCSeqHeader The handle to the Cseq header to be set. If NULL value is supplied, the existing CSeq header is removed from the message. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgGetCallIdHeader() RvSipMsgGetCallIdHeader() DESCRIPTION Copies the message Call-ID into a given buffer. If the bufferLen size is adequate, the function copies the Call-ID into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipMsgSetCallIdHeader() RvSipMsgSetCallIdHeader() DESCRIPTION Sets a Call-ID in the message. SYNTAX RvStatus RvSipMsgSetCallIdHeader( IN RvSipMsgHandle hSipMsg, IN RvChar* strCallId); PARAMETERS hSipMsg The handle to the message. strCallId The new Call-ID string to be set in the message. If a NULL value is supplied, the existing Call-ID is removed from the message. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgGetContentTypeHeader() RvSipMsgGetContentTypeHeader() DESCRIPTION Copies the Content-Type of the message into a given buffer. If the bufferLen size is adequate, the function copies the Content-Type, into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipMsgSetContentTypeHeader() RvSipMsgSetContentTypeHeader() DESCRIPTION Sets a Content-Type string in the message. SYNTAX RvStatus RvSipMsgSetContentTypeHeader( IN RvSipMsgHandle hSipMsg, IN RvChar* pContentType); PARAMETERS hSipMsg The handle to a message. pContentType The ContentType string to be set in the message. If a NULL value is supplied, the existing Content-Type header is removed from the message. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgGetBody() RvSipMsgGetBody() DESCRIPTION Copies the body from the message into a given buffer. If the bufferLen is adequate, the function copies the message body into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length. SYNTAX RvStatus RvSipMsgGetBody( IN RvSipMsgHandle hSipMsg, IN RvChar* strBuffer, IN RvUint OUT RvUint* bufferLen, actualLen); PARAMETERS hSipMsg The handle to the message.
Get and Set Functions RvSipMsgGetBody() REMARKS If the message body is of multipart type, it may be represented as a list of body parts, and not as a string. In this case, the body object will first be encoded and then will be copied to the given buffer.
Get and Set Functions RvSipMsgSetBody() RvSipMsgSetBody() DESCRIPTION Sets a body in the message and updates the content-length parameter with the body length. Remember to update the Content-Type value according to the new body type. SYNTAX RvStatus RvSipMsgSetBody( IN RvSipMsgHandle hSipMsg, IN RvChar* strBody); PARAMETERS hSipMsg The handle to the message. strBody SIP message body to be set in the message.
Get and Set Functions RvSipMsgGetBodyObject() RvSipMsgGetBodyObject() DESCRIPTION Gets the body object from the given message. The handle of the body object is returned. Any changes that are made to this body object will be reflected in the message. SYNTAX RvSipBodyHandle RvSipMsgGetBodyObject( IN RvSipMsgHandle hSipMsg); PARAMETERS hSipMsg The handle to the message. RETURN VALUES Returns the handle to the body object.
Get and Set Functions RvSipMsgSetBodyObject() RvSipMsgSetBodyObject() DESCRIPTION Sets a body object in a given message. The given body is copied to the message. If the body object contains a Content-Type header, it is copied to the message as well. SYNTAX RvStatus RvSipMsgSetBodyObject( IN RvSipMsgHandle hSipMsg, IN RvSipBodyHandle hBody); PARAMETERS hSipMsg The handle to the message. hBody The body object to be set to the message. If NULL is supplied, the existing body is removed from the message.
Get and Set Functions RvSipMsgGetRpoolString() RvSipMsgGetRpoolString() DESCRIPTION Copies a string parameter from the message into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipMsgGetRpoolString( IN RvSipMsgHandle hSipMsg, IN RvSipMessageStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipMsg The handle to the message. eStringName The string that the user wishes to get.
Get and Set Functions RvSipMsgSetRpoolString() RvSipMsgSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the message. The given string is located in an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipMsgSetRpoolString( IN RvSipMsgHandle hSipMsg, IN RvSipMessageStringName eStringName, IN RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipMsg The handle to the message. eStringName The string the user wishes to set.
Get and Set Functions RvSipMsgGetStrBadSyntaxStartLine() RvSipMsgGetStrBadSyntaxStartLine() DESCRIPTION Copies the bad-syntax start line from the message into a given buffer. When a message is received and the start line contains a syntax error, the start line is kept as a separate bad-syntax string. This function retrieves this string. If the bufferLen size adequate, this function copies the parameter into the strBuffer.
Get and Set Functions RvSipMsgGetStrBadSyntaxStartLine() actualLen The length of the bad-syntax start line + 1, to include a NULL value at the end of the parameter. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgStartLineFix() RvSipMsgStartLineFix() DESCRIPTION Fixes a start-line with bad-syntax information. When a message is received with a syntax error in the start line, the start line string is kept as a separate badsyntax string. You use this function to fix the start line by parsing a given correct start line string to the supplied message. If parsing succeeds, the function places all parameters inside the message start line and removes the bad-syntax string.
Get and Set Functions RvSipMsgSetCallIdCompactForm() RvSipMsgSetCallIdCompactForm() DESCRIPTION Instructs the message to use the compact header name when the Call-ID header is encoded. SYNTAX RvStatus RvSipMsgSetCallIdCompactForm( IN RvSipMsgHandle hSipMsg, IN RvBool bIsCompact); PARAMETERS hSipMsg The handle to the message. bIsCompact Specifies whether or not to use a compact form. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgGetCallIdCompactForm() RvSipMsgGetCallIdCompactForm() DESCRIPTION Gets the compact form indication of the Call-ID header found in the supplied message. SYNTAX RvStatus RvSipMsgGetCallIdCompactForm( IN RvSipMsgHandle hSipMsg, IN RvBool *pbIsCompact) PARAMETERS hSipMsg The handle to the message. bIsCompact Specifies whether or not compact form is used. RV_TRUE if the header uses compact form, otherwise RV_FALSE. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMsgSetContentLengthCompactForm() RvSipMsgSetContentLengthCompactForm() DESCRIPTION Instructs the message to use the compact header name when the Content-Length header is encoded. SYNTAX RvStatus RvSipMsgSetContentLengthCompactForm( IN RvSipMsgHandle hSipMsg, IN RvBool bIsCompact); PARAMETERS hSipMsg The handle to the message. bIsCompact Specifies whether or not to use a compact form. RETURN VALUE Returns RvStatus.
Get and Set Functions RvSipMsgGetContentLengthCompactForm() RvSipMsgGetContentLengthCompactForm() DESCRIPTION Gets the compact form indication of the Content-Length header found in the supplied message. SYNTAX RvStatus RvSipMsgGetContentLengthCompactForm( IN RvSipMsgHandle hSipMsg, IN RvBool *pbIsCompact) PARAMETERS hSipMsg The handle to the message. pbIsCompact Specifies whether or not compact form is used. RV_TRUE if the header uses compact form, otherwise RV_FALSE. RETURN VALUE Returns RvStatus.
Get and Set Functions RvSipMsgGetContentLengthCompactForm() 68 HP C SIP Stack Message Layer Reference Guide
2 ADDRESS FUNCTIONS The Address API functions enable you to construct, copy, encode, parse, access and change address object (address) parameters. The Address API includes dedicated functions for both SIP URL and Absolute URI. This section contains Address functions found in the RvSipAddress.h header file.
Control Functions CONTROL FUNCTIONS 70 The Control functions are: RvSipAddrConstructInStartLine() RvSipAddrConstructInPartyHeader() RvSipAddrConstructInContactHeader() RvSipAddrConstructInAuthorizationHeader() RvSipAddrConstructInRouteHopHeader() RvSipAddrConstructInReferToHeader() RvSipAddrConstructInReferredByHeader() RvSipAddrConstruct() RvSipAddrCopy() RvSipAddrEncode() RvSipAddrParse() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipAddrConstructInStartLine() RvSipAddrConstructInStartLine() DESCRIPTION Constructs an address inside the Request line of a given message. The new address is set as the request URI of the Request line. The handle of the address is returned. SYNTAX RvStatus RvSipAddrConstructInStartLine( IN RvSipMsgHandle hSipMsg, IN RvSipAddressType eAddrType, OUT RvSipAddressHandle* hSipAddr); PARAMETERS hSipMsg The handle to the SIP message. eAddrType The type of address to construct.
Control Functions RvSipAddrConstructInPartyHeader() RvSipAddrConstructInPartyHeader() DESCRIPTION Constructs the address-spec address inside a given To or From Party header. The address handle is returned. SYNTAX RvStatus RvSipAddrConstructInPartyHeader( IN RvSipPartyHeaderHandle hHeader, IN RvSipAddressType eAddrType, OUT RvSipAddressHandle* hSipAddr); PARAMETERS hHeader The handle to the Party header. eAddrType The type of address to construct—in this version, only URL.
Control Functions RvSipAddrConstructInContactHeader() RvSipAddrConstructInContactHeader() DESCRIPTION Constructs the address-spec address inside a given Contact header. The address handle is returned. SYNTAX RvStatus RvSipAddrConstructInContactHeader( IN RvSipContactHeaderHandle hHeader, IN RvSipAddressType eAddrType, OUT RvSipAddressHandle* hSipAddr); PARAMETERS hHeader The handle to the Contact header. eAddrType The type of address to construct—in this version, only URL.
Control Functions RvSipAddrConstructInAuthorizationHeader() RvSipAddrConstructInAuthorizationHeader() DESCRIPTION Constructs the digest URI address inside a given Authorization header. The address handle is returned. SYNTAX RvStatus RvSipAddrConstructInAuthorizationHeader( IN RvSipAuthorizationHeaderHandle hHeader, IN RvSipAddressType eAddrType, OUT RvSipAddressHandle* hSipAddr); PARAMETERS hHeader The handle to the Authorization header.
Control Functions RvSipAddrConstructInRouteHopHeader() RvSipAddrConstructInRouteHopHeader() DESCRIPTION Constructs the address-spec address inside a given Route-Hop header. The address handle is returned. SYNTAX RvStatus RvSipAddrConstructInRouteHopHeader( IN RvSipRouteHopHeaderHandle hHeader, IN RvSipAddressType eAddrType, OUT RvSipAddressHandle* hSipAddr); PARAMETERS hHeader The handle to the Route-Hop header. eAddrType The type of address to construct.
Control Functions RvSipAddrConstructInReferToHeader() RvSipAddrConstructInReferToHeader() DESCRIPTION Constructs the address-spec address inside a given Refer-To header. The address handle is returned. SYNTAX RvStatus RvSipAddrConstructInReferToHeader( IN RvSipReferToHeaderHandle hHeader, IN RvSipAddressType eAddrType, OUT RvSipAddressHandle* hSipAddr); PARAMETERS hHeader The handle to the Refer-To header. eAddrType The type of address to construct. In the current version, eAddrType is only URL.
Control Functions RvSipAddrConstructInReferredByHeader() RvSipAddrConstructInReferredByHeader() DESCRIPTION Constructs the address-spec address inside a given Referred-By header. The address handle is returned. SYNTAX RvStatus RvSipAddrConstructInReferredByHeader( IN RvSipReferredByHeaderHandle hHeader, IN RvSipAddressType eAddrType, IN RvSipReferredByUrl eUrlEntity, OUT RvSipAddressHandle* hSipAddr); PARAMETERS hHeader The handle to the Referred-By header.
Control Functions RvSipAddrConstruct() RvSipAddrConstruct() DESCRIPTION Constructs and initializes a stand-alone address. The object is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipAddrConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE hPage, IN RvSipAddressType eAddrType, OUT RvSipAddressHandle* hSipAddr); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipAddrCopy() RvSipAddrCopy() DESCRIPTION Copies all parameters from a source address to a destination address. You must construct the destination object before using this function. SYNTAX RvStatus RvSipAddrCopy( INOUT RvSipAddressHandle hDestination, IN hSource); RvSipAddressHandle PARAMETERS hDestination The handle to the destination address. hSource The handle to the source address. RETURN VALUES Returns RvStatus.
Control Functions RvSipAddrEncode() RvSipAddrEncode() DESCRIPTION Encodes an address to a textual address. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipAddrEncode( IN RvSipAddressHandle hSipAddr, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hSipAddr The handle to the address. hPool The handle to the specified memory pool.
Control Functions RvSipAddrParse() RvSipAddrParse() DESCRIPTION Parses a SIP textual address, such as, “sip:bob@hp.com”, into an address. All the textual parameters are placed inside the object. SYNTAX RvStatus RvSipAddrParse( INOUT RvSipAddressHandle hSipAddr, IN buffer); RvChar* PARAMETERS hSipAddr A handle to the address. buffer The buffer containing a textual address. RETURN VALUES Returns RvStatus. REMARKS You must construct an address before using this function.
Get and Set Functions GET AND SET FUNCTIONS 82 The Get and Set functions are: RvSipAddrGetStringLength() RvSipAddrGetAddrType() RvSipAddrGetRpoolString() RvSipAddrSetRpoolString() HP C SIP Stack Message Layer Reference Guide
Get and Set Functions RvSipAddrGetStringLength() RvSipAddrGetStringLength() DESCRIPTION Some of the address parameters are kept in a string format, such as the address host name. In order to get such a parameter from the address, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipAddrGetAddrType() RvSipAddrGetAddrType() DESCRIPTION Gets the address type of an address. SYNTAX RvSipAddressType RvSipAddrGetAddrType( IN RvSipAddressHandle hSipAddr); PARAMETERS hSipAddr The handle to the address. RETURN VALUES Returns RvSipAddressType. For more information see RvSipAddressType in Message Type Definitions.
Get and Set Functions RvSipAddrGetRpoolString() RvSipAddrGetRpoolString() DESCRIPTION Copies a string parameter from the address into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipAddrGetRpoolString( IN RvSipAddressHandle hAddr, IN RvSipAddressStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hAddr The handle to the address. eStringName The string the user wishes to get. pRpoolPtr A pointer to a location inside an RPOOL.
Get and Set Functions RvSipAddrSetRpoolString() RvSipAddrSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the address. The given string is located in an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipAddrSetRpoolString( IN RvSipAddressHandle hAddr, IN RvSipAddressStringName eStringName, IN RPOOL_Ptr *pRpoolPtr); PARAMETERS hAddr The handle to the address. eStringName The string the user wishes to set.
Address Comparison Functions ADDRESS COMPARISON FUNCTIONS The Address Comparison functions are: RvSipAddrIsEqual() Address Functions 87
Address Comparison Functions RvSipAddrIsEqual() RvSipAddrIsEqual() DESCRIPTION Compares two SIP addresses, as specified in RFC 2543. SYNTAX RvBool RvSipAddrIsEqual( IN RvSipAddressHandle hAddress, IN RvSipAddressHandle hOtherAddress); PARAMETERS hAddress The handle to the first address. hOtherAddress The handle to the second address with which a comparison is being made. RETURN VALUES Returns RV_TRUE if the addresses are equal. Otherwise returns RV_FALSE.
SIP URL: Get and Set Functions SIP URL: GET AND SET FUNCTIONS The SIP URL Get and Set functions are: RvSipAddrUrlGetUser() RvSipAddrUrlSetUser() RvSipAddrUrlGetHost() RvSipAddrUrlSetHost() RvSipAddrUrlGetPortNum() RvSipAddrUrlSetPortNum() RvSipAddrUrlGetTtlNum() RvSipAddrUrlSetTtlNum() RvSipAddrUrlGetLrParam() RvSipAddrUrlSetLrParam() RvSipAddrUrlGetLrParamType() RvSipAddrUrlSetLrParamType() RvSipAddrUrlGetMethod() RvSipAddrUrlGetStrMethod()
SIP URL: Get and Set Functions RvSipAddrUrlGetUser() RvSipAddrUrlGetUser() DESCRIPTION Copies the user parameter from the address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
SIP URL: Get and Set Functions RvSipAddrUrlSetUser() RvSipAddrUrlSetUser() DESCRIPTION Sets the user string value in the address URL object. SYNTAX RvStatus RvSipAddrUrlSetUser( IN RvSipAddressHandle hSipAddr, IN RvChar* strUser); PARAMETERS hSipAddr The handle to the address. strUser The user value to be set in the object. If NULL is supplied, the existing strUser is removed from the address. RETURN VALUES Returns RvStatus.
SIP URL: Get and Set Functions RvSipAddrUrlGetHost() RvSipAddrUrlGetHost() DESCRIPTION Copies the host parameter from the address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
SIP URL: Get and Set Functions RvSipAddrUrlSetHost() RvSipAddrUrlSetHost() DESCRIPTION Sets the host in the URL object or removes the existing host from the URL object. SYNTAX RvStatus RvSipAddrUrlSetHost( IN RvSipAddressHandle hSipAddr, IN RvChar* strHost); PARAMETERS hSipAddr The handle to the URL address. strHost The host value to be set in the object. If NULL is supplied, the existing host is removed. RETURN VALUES Returns RvStatus.
SIP URL: Get and Set Functions RvSipAddrUrlGetPortNum() RvSipAddrUrlGetPortNum() DESCRIPTION Gets the port number from the URL object. SYNTAX RvInt32 RvSipAddrUrlGetPortNum( IN RvSipAddressHandle hSipUrl); PARAMETERS hSipUrl The handle to the URL address. RETURN VALUES Returns the port number, or UNDEFINED if the port is not set.
SIP URL: Get and Set Functions RvSipAddrUrlSetPortNum() RvSipAddrUrlSetPortNum() DESCRIPTION Sets the port number in the URL object. SYNTAX RvStatus RvSipAddrUrlSetPortNum( IN RvSipAddressHandle hSipUrl, IN RvInt32 portNum); PARAMETERS hSipUrl The handle to the URL address. portNum The port number value to be set in the object. In order to remove the port number from the address, you can set this parameter to UNDEFINED. RETURN VALUES Returns RvStatus.
SIP URL: Get and Set Functions RvSipAddrUrlGetTtlNum() RvSipAddrUrlGetTtlNum() DESCRIPTION Gets the ttl number from the URL object. SYNTAX RvSipAddrUrlTtlNum( IN RvSipAddressHandle hSipAddr); PARAMETERS hSipAddr The handle to the URL address. RETURN VALUES Returns the ttl number, or UNDEFINED if ttl is not set.
SIP URL: Get and Set Functions RvSipAddrUrlSetTtlNum() RvSipAddrUrlSetTtlNum() DESCRIPTION Sets the ttl number in the address URL object. SYNTAX RvStatus RvSipAddrUrlSetTtlNum( IN RvSipAddressHandle hSipAddr, IN RvInt16 ttlNum); PARAMETERS hSipAddr The handle to the URL address. ttlNum The ttl number value to be set in the object. In order to remove the ttl number from the address, you can set this parameter to UNDEFINED. RETURN VALUES Returns RvStatus.
SIP URL: Get and Set Functions RvSipAddrUrlGetLrParam() RvSipAddrUrlGetLrParam() DESCRIPTION Specifies whether or not the lr param exists in the address. SYNTAX RvBool RvSipAddrUrlGetLrParam( IN RvSipAddressHandle hSipAddr); PARAMETERS hSipAddr The handle to the URL address. RETURN VALUES Returns RV_TRUE if the lr param exists in the address. Otherwise returns RV_FALSE.
SIP URL: Get and Set Functions RvSipAddrUrlSetLrParam() RvSipAddrUrlSetLrParam() DESCRIPTION Sets the lr parameter in the address URL object. SYNTAX RvStatus RvSipAddrUrlSetLrParam( IN RvSipAddressHandle hSipAddr, IN RvBool bLrParam); PARAMETERS hSipAddr The handle to the URL address. bLrParam RV_TRUE specifies that the lr exists in the address. RETURN VALUES Returns RvStatus.
SIP URL: Get and Set Functions RvSipAddrUrlGetLrParamType() RvSipAddrUrlGetLrParamType() DESCRIPTION Returns the type of the lr param that exists in the address (lr; lr-true; lr=1;). SYNTAX RvSipUrlLrType RvSipAddrUrlGetLrParamType( IN RvSipAddressHandle PARAMETERS hSipAddr The handle to the URL address. RETURN VALUES Returns the RvSipUrlLrType.
SIP URL: Get and Set Functions RvSipAddrUrlSetLrParamType() RvSipAddrUrlSetLrParamType() DESCRIPTION Sets the lr parameter type in the address URL object (lr; lr-true; lr=1;). SYNTAX RvStatus RvSipAddrUrlSetLrParamType( IN RvSipAddressHandle hSipAddr, IN RvSipUrlLrType eLrParamType); PARAMETERS hSipAddr The handle to the URL address. eLrParamType The type of lr parameter. RETURN VALUES Returns RvStatus.
SIP URL: Get and Set Functions RvSipAddrUrlGetMethod() RvSipAddrUrlGetMethod() DESCRIPTION Gets the method type enumeration from the URL address. If this function returns RVSIP_METHOD_OTHER, call RvSipAddrUrlGetStrMethod() to get the actual method in a string format. SYNTAX RvSipMethodType RvSipAddrUrlGetMethod( IN RvSipAddressHandle hSipAddr); PARAMETERS hSipAddr The handle to the URL address. RETURN VALUES Returns the method type enumeration from the URL address.
SIP URL: Get and Set Functions RvSipAddrUrlGetStrMethod() RvSipAddrUrlGetStrMethod() DESCRIPTION Retrieves the method type string value from the URL address. If the value of bufferLen is big enough, the function will copy the parameter into the strBuffer. Otherwise, it will return RV_ERROR_INSUFFICIENT_BUFFER, and the actualLen parameter will contain the needed buffer length.
SIP URL: Get and Set Functions RvSipAddrUrlSetMethod() RvSipAddrUrlSetMethod() DESCRIPTION Sets the method type in the URL address. If eMethodType is RVSIP_METHOD_OTHER, strMethodType is copied to the header. Otherwise strMethodType is ignored. SYNTAX RvStatus RvSipAddrUrlSetMethod( IN RvSipAddressHandle hSipAddr, IN RvSipMethodType eMethodType, IN RvChar* pMethodTypeStr); PARAMETERS hHeader The handle to the URL address. eMethodType The method type to be set in the object.
SIP URL: Get and Set Functions RvSipAddrUrlGetTransport() RvSipAddrUrlGetTransport() DESCRIPTION Gets the transport protocol enumeration value from the URL object. If the returned Transport enumeration is RVSIP_TRANSPORT_OTHER, you can get the transport protocol string by calling RvSipAddrUrlGetStrTransport(). SYNTAX RvSipTransport RvSipAddrUrlGetTransport( IN RvSipAddressHandle hSipAddr); PARAMETERS hSipAddr The handle to the URL address. RETURN VALUES Returns the transportType enumeration value.
SIP URL: Get and Set Functions RvSipAddrUrlGetStrTransport() RvSipAddrUrlGetStrTransport() DESCRIPTION Copies the transport protocol string from the URL address into a given buffer. Use this function if RvSipAddrUrlGetTransport() returns RVSIP_TRANSPORT_OTHER. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
SIP URL: Get and Set Functions RvSipAddrUrlSetTransport() RvSipAddrUrlSetTransport() DESCRIPTION Sets the transport protocol value in the URL object. SYNTAX RvStatus RvSipAddrUrlSetTransport( IN RvSipAddressHandle hSipAddr, IN RvSipTransport eTransport, IN RvChar* strTransport); PARAMETERS hSipAddr The handle to the URL address. eTransport The transport protocol enumeration value to be set in the object.
SIP URL: Get and Set Functions RvSipAddrUrlGetMaddrParam() RvSipAddrUrlGetMaddrParam() DESCRIPTION Copies the maddr parameter from the address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
SIP URL: Get and Set Functions RvSipAddrUrlSetMaddrParam() RvSipAddrUrlSetMaddrParam() DESCRIPTION Sets the value of the maddr parameter in the URL object or removes the maddr parameter from the object. SYNTAX RvStatus RvSipAddrUrlSetMaddrParam( IN RvSipAddressHandle hSipUrl, IN RvChar* strMaddrParam); PARAMETERS hSipUrl The handle to the URL address. strMaddrParam The maddr parameter to be set in the object. If NULL is supplied, the maddr parameter is removed from the URL object.
SIP URL: Get and Set Functions RvSipAddrUrlGetUserParam() RvSipAddrUrlGetUserParam() DESCRIPTION Gets the user parameter enumeration value from the URL object. If eUserParam is RVSIP_USERPARAM_OTHER, then you can get the user parameter string value using RRvSipAddrUrlGetStrUserParam(). SYNTAX RvSipUserParam RvSipAddrUrlGetUserParam( IN RvSipAddressHandle hSipAddr); PARAMETERS hSipAddr The handle to the URL address. RETURN VALUES The enumeration value of the requested userParam.
SIP URL: Get and Set Functions RvSipAddrUrlGetStrUserParam() RvSipAddrUrlGetStrUserParam() DESCRIPTION Copies the user param string from the URL address into a given buffer. Use this function if RvSipAddrUrlGetUserParam() returns RVSIP_USERPARAM_OTHER. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
SIP URL: Get and Set Functions RvSipAddrUrlSetUserParam() RvSipAddrUrlSetUserParam() DESCRIPTION Sets the user param value within the URL object. If eUserParam is set to RVSIP_USERPARAM_OTHER, the string in strUserParam is set to the URL user parameter. Otherwise, strUserParam is ignored. SYNTAX RvStatus RvSipAddrUrlSetUserParam( IN RvSipAddressHandle hSipAddr, IN RvSipUserParam eUserParam, IN RvChar* strUserParam); PARAMETERS hSipAddr The handle to the URL address.
SIP URL: Get and Set Functions RvSipAddrUrlGetHeaders() RvSipAddrUrlGetHeaders() DESCRIPTION Copies the headers parameter of the address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
SIP URL: Get and Set Functions RvSipAddrUrlSetHeaders() RvSipAddrUrlSetHeaders() DESCRIPTION Used to set the headers parameter in the URL address. SYNTAX RvStatus RvSipAddrUrlSetHeaders( IN RvSipAddressHandle hSipUrl, IN RvChar* strHeaders); PARAMETERS hSipUrl The handle to the URL address. strHeaders The headers parameter to be set in the object. If NULL is supplied, the existing headers parameter is removed. RETURN VALUES Returns RvStatus.
SIP URL: Get and Set Functions RvSipAddrUrlGetHeadersList() RvSipAddrUrlGetHeadersList() DESCRIPTION Takes the URL headers parameter as a string, and parses it into a list of headers. The application must supply a list structure and a consecutive buffer with the URL headers parameter string. SYNTAX RvStatus RvSipAddrUrlGetHeadersList( IN RvSipAddressHandle hSipAddr, IN RvSipCommonListHandle hHeadersList, IN RvChar* pHeadersBuffer); PARAMETERS hSipAddr The handle to the address.
SIP URL: Get and Set Functions RvSipAddrUrlSetHeadersList() RvSipAddrUrlSetHeadersList() DESCRIPTION Sets the headers parameter from the headers list. This function encodes all headers. During encoding, each header coverts reserved characters to its escaped form. Each header also sets an equal sign (=) instead of a colon (:) after the header name. This function also sets an ampersand (&) between headers.
SIP URL: Get and Set Functions RvSipAddrUrlGetOtherParams() RvSipAddrUrlGetOtherParams() DESCRIPTION Copies the URL other-params parameter of the address into a given buffer. Not all the address parameters have separated parameters in the address. Parameters with no specific parameters are referred to as “other-params. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”. If the bufferLen is adequate, this function copies the parameter into the strBuffer.
SIP URL: Get and Set Functions RvSipAddrUrlSetOtherParams() RvSipAddrUrlSetOtherParams() DESCRIPTION Sets the other-params parameter in the address. Not all the address parameters have separated parameters in the address. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
SIP URL: Get and Set Functions RvSipAddrUrlIsSecure() RvSipAddrUrlIsSecure() DESCRIPTION Specifies whether or not the URL address scheme is secure. (The URL address is secure with the “sips:” prefix and is not secure with the “sip:” prefix.) SYNTAX RvBool RvSipAddrUrlIsSecure( IN RvSipAddressHandle hSipAddr); PARAMETERS hSipAddr The handle to the URL address. RETURN VALUES Returns whether or not the URL is secure.
SIP URL: Get and Set Functions RvSipAddrUrlSetIsSecure() RvSipAddrUrlSetIsSecure() DESCRIPTION Sets the URL address to be secure or not secure. (The URL address is secure if it set with the “sips:” prefix and not secure if set with the “sip:” prefix.) SYNTAX RvStatus RvSipAddrUrlSetIsSecure( IN RvSipAddressHandle hSipAddr, IN RvBool bIsSecure); PARAMETERS hSipAddr The handle to the URL address. bIsSecure Indicates whether or not the URL is secure. RETURN VALUES Returns RvStatus.
Absolute URI: Get and Set Functions ABSOLUTE URI: GET AND SET FUNCTIONS The Absolute URI Get and Set functions are: RvSipAddrAbsUriGetScheme() RvSipAddrAbsUriSetScheme() RvSipAddrAbsUriGetIdentifier() RvSipAddrAbsUriSetIdentifier() Address Functions 121
Absolute URI: Get and Set Functions RvSipAddrAbsUriGetScheme() RvSipAddrAbsUriGetScheme() DESCRIPTION Copies the scheme parameter from the address into a given buffer. If the bufferLen is adequate, this function copies the parameter into the strBuffer. Otherwise, this function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Absolute URI: Get and Set Functions RvSipAddrAbsUriSetScheme() RvSipAddrAbsUriSetScheme() DESCRIPTION Sets the scheme string in the absolute URI address. SYNTAX RvStatus RvSipAddrAbsUriSetScheme( IN RvSipAddressHandle hSipAddr, IN RvChar* strScheme); PARAMETERS hSipAddr The handle to the absolute URI address. strScheme The scheme to be set in the object. If NULL is supplied, the existing scheme is removed from the address. RETURN VALUES Returns RvStatus.
Absolute URI: Get and Set Functions RvSipAddrAbsUriGetIdentifier() RvSipAddrAbsUriGetIdentifier() DESCRIPTION Copies the identifier parameter from the absolute URI address into a given buffer. If the bufferLen is adequate, this function copies the parameter into the strBuffer. Otherwise, this function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Absolute URI: Get and Set Functions RvSipAddrAbsUriSetIdentifier() RvSipAddrAbsUriSetIdentifier() DESCRIPTION Sets the identifier string in the absolute URI address. SYNTAX RvStatus RvSipAddrAbsUriSetIdentifier( IN RvSipAddressHandle hSipAddr, IN RvChar* strIdentifier); PARAMETERS hSipAddr The handle to the absolute URI address. strIdentifier The identifier string to be set in the object. If NULL is supplied, the existing identifier is removed from the address. RETURN VALUES Returns RvStatus.
TEL URI: Get and Set Functions TEL URI: GET AND SET FUNCTIONS 126 The TEL URI Get and Set functions are: RvSipAddrTelUriSetIsGlobalPhoneNumber() RvSipAddrTelUriGetIsGlobalPhoneNumber() RvSipAddrTelUriSetPhoneNumber() RvSipAddrTelUriGetPhoneNumber() RvSipAddrTelUriSetExtension() RvSipAddrTelUriGetExtension() RvSipAddrTelUriSetIsdnSubAddr() RvSipAddrTelUriGetIsdnSubAddr() RvSipAddrTelUriSetPostDial() RvSipAddrTelUriGetPostDial() RvSipAddrTelUriSetContext() RvSipAddrTelUriG
TEL URI: Get and Set Functions RvSipAddrTelUriSetIsGlobalPhoneNumber() RvSipAddrTelUriSetIsGlobalPhoneNumber() DESCRIPTION Indicates whether or not this TEL URL address is a global phone number. SYNTAX RvStatus RvSipAddrTelUriSetIsGlobalPhoneNumber( IN RvSipAddressHandle hSipAddr, IN RvBool bIsGlobalPhoneNumber); PARAMETERS hSipAddr The handle to the TEL URI address. bIsGlobalPhoneNumber RV_TRUE indicates that this TEL URI represents a global phone number. Otherwise, RV_FALSE.
TEL URI: Get and Set Functions RvSipAddrTelUriGetIsGlobalPhoneNumber() RvSipAddrTelUriGetIsGlobalPhoneNumber() DESCRIPTION Returns RV_TRUE if this address indicates a global phone number. SYNTAX RvBool RvSipAddrTelUriGetIsGlobalPhoneNumber( IN RvSipAddressHandle hSipAddr); PARAMETERS hSipAddr The handle to the TEL URI address. RETURN VALUES Returns RV_TRUE if this address indicates a global phone number.
TEL URI: Get and Set Functions RvSipAddrTelUriSetPhoneNumber() RvSipAddrTelUriSetPhoneNumber() DESCRIPTION Sets the phone-number string in the TEL URI address. SYNTAX RvStatus RvSipAddrTelUriSetPhoneNumber( IN RvSipAddressHandle hSipAddr, IN RvChar* strPhoneNumber); PARAMETERS hSipAddr The handle to the TEL URI address. strPhoneNumber The phone-number string to be set in the object. If NULL is supplied, the existing phone-number is removed from the address. RETURN VALUES Returns RvStatus.
TEL URI: Get and Set Functions RvSipAddrTelUriGetPhoneNumber() RvSipAddrTelUriGetPhoneNumber() DESCRIPTION Copies the phone-number parameter from the TEL URI address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
TEL URI: Get and Set Functions RvSipAddrTelUriSetExtension() RvSipAddrTelUriSetExtension() DESCRIPTION Sets the extension string in the TEL URI address. SYNTAX RvStatus RvSipAddrTelUriSetExtension( IN RvSipAddressHandle hSipAddr, IN RvChar* strExtension); PARAMETERS hSipAddr The handle to the TEL URI address. strExtension The extension string to be set in the object. If NULL is supplied, the existing extension is removed from the address. RETURN VALUES Returns RvStatus.
TEL URI: Get and Set Functions RvSipAddrTelUriGetExtension() RvSipAddrTelUriGetExtension() DESCRIPTION Copies the extension parameter from the TEL URI address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
TEL URI: Get and Set Functions RvSipAddrTelUriSetIsdnSubAddr() RvSipAddrTelUriSetIsdnSubAddr() DESCRIPTION Sets the isdn-sub-address string in the TEL URI address. SYNTAX RvStatus RvSipAddrTelUriSetIsdnSubAddr( IN RvSipAddressHandle hSipAddr, IN RvChar* strIsdnSubAddr); PARAMETERS hSipAddr The handle to the TEL URI address. strIsdnSubAddr The Isdn-sub-address string to be set in the object. If NULL is supplied, the existing Isdn-sub-address is removed from the address. RETURN VALUES Returns RvStatus.
TEL URI: Get and Set Functions RvSipAddrTelUriGetIsdnSubAddr() RvSipAddrTelUriGetIsdnSubAddr() DESCRIPTION Copies the isdn-sub-address parameter from the TEL URI address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
TEL URI: Get and Set Functions RvSipAddrTelUriSetPostDial() RvSipAddrTelUriSetPostDial() DESCRIPTION Sets the post-dial string in the TEL URI address. SYNTAX RvStatus RvSipAddrTelUriSetPostDial( IN RvSipAddressHandle hSipAddr, IN RvChar* strPostDial); PARAMETERS hSipAddr The handle to the TEL URI address. strPostDial The post-dial string to be set in the object. If NULL is supplied, the existing post-dial is removed from the address. RETURN VALUES Returns RvStatus.
TEL URI: Get and Set Functions RvSipAddrTelUriGetPostDial() RvSipAddrTelUriGetPostDial() DESCRIPTION Copies the post-dial parameter from the TEL URI address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
TEL URI: Get and Set Functions RvSipAddrTelUriSetContext() RvSipAddrTelUriSetContext() DESCRIPTION Sets the context string in the TEL URI address. SYNTAX RvStatus RvSipAddrTelUriSetContext( IN RvSipAddressHandle hSipAddr, IN RvChar* strContext); PARAMETERS hSipAddr The handle to the TEL URI address. strContext The context string to be set in the object. If NULL is supplied, the existing context is removed from the address. RETURN VALUES Returns RvStatus.
TEL URI: Get and Set Functions RvSipAddrTelUriGetContext() RvSipAddrTelUriGetContext() DESCRIPTION Copies the context parameter from the TEL URI address into a given buffer. If the bufferLen is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
TEL URI: Get and Set Functions RvSipAddrTelUriSetEnumdiParamType() RvSipAddrTelUriSetEnumdiParamType() DESCRIPTION Sets the enumdi parameter type in a TEL URI address (undefined or exists and empty). SYNTAX RvStatus RvSipAddrTelUriSetEnumdiParamType( IN RvSipAddressHandle hSipAddr, IN RvSipTelUriEnumdiType eEnumdiType); PARAMETERS hSipAddr The handle to the TEL URI address. eEnumdiType The type of the enumdi parameter. RETURN VALUES Returns RvStatus.
TEL URI: Get and Set Functions RvSipAddrTelUriGetEnumdiParamType() RvSipAddrTelUriGetEnumdiParamType() DESCRIPTION Returns the type of the enumdi param in a TEL URI address (undefined or exists and empty). SYNTAX RvSipTelUriEnumdiType RvSipAddrTelUriGetEnumdiParamType( IN RvSipAddressHandle PARAMETERS hSipAddr The handle to the TEL URI address. RETURN VALUES Returns RvSipTelUriEnumdiType.
TEL URI: Get and Set Functions RvSipAddrTelUriSetOtherParams() RvSipAddrTelUriSetOtherParams() DESCRIPTION Sets the other-params parameter in the TEL URI address. Not all the address parameters have separated parameters in the address. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the form: “name=value;name=value...”.
TEL URI: Get and Set Functions RvSipAddrTelUriGetOtherParams() RvSipAddrTelUriGetOtherParams() DESCRIPTION Copies the URL other-params parameter of the address into a given buffer. Not all the address parameters have separated parameters in the address. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the form: “name=value;name=value...”.
3 ALLOW HEADER FUNCTIONS The Allow header functions enable you to construct, copy, encode, parse, access and change Allow header parameters. This section contains Allow header functions found in the RvSipAllowHeader.h header file.
Control Functions CONTROL FUNCTIONS 144 The Control functions are: RvSipAllowHeaderConstructInMsg() RvSipAllowHeaderConstruct() RvSipAllowHeaderCopy() RvSipAllowHeaderEncode() RvSipAllowHeaderParse() RvSipAllowHeaderParseValue() RvSipAllowHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipAllowHeaderConstructInMsg() RvSipAllowHeaderConstructInMsg() DESCRIPTION Constructs an Allow header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the header list. SYNTAX RvStatus RvSipAllowHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipAllowHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipAllowHeaderConstruct() RvSipAllowHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Allow header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipAllowHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipAllowHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipAllowHeaderCopy() RvSipAllowHeaderCopy() DESCRIPTION Copies all parameters from a source Allow header to a destination Allow header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipAllowHeaderCopy( INOUT RvSipAllowHeaderHandle hDestination, IN hSource); RvSipAllowHeaderHandle PARAMETERS hDestination The handle to the destination Allow header. hSource The handle to the source Allow header. RETURN VALUES Returns RvStatus.
Control Functions RvSipAllowHeaderEncode() RvSipAllowHeaderEncode() DESCRIPTION Encodes an Allow header to a textual Allow header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipAllowHeaderEncode( IN RvSipAllowHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hHeader The handle to the Allow header.
Control Functions RvSipAllowHeaderParse() RvSipAllowHeaderParse() DESCRIPTION Parses a SIP textual Allow header into an Allow header. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipAllowHeaderParseValue() RvSipAllowHeaderParseValue() DESCRIPTION Parses a SIP textual Allow header value into an Allow header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipAllowHeaderFix() RvSipAllowHeaderFix() DESCRIPTION Fixes an Allow header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Get and Set Functions GET AND SET FUNCTIONS 152 The Get and Set functions are: RvSipAllowHeaderGetStringLength() RvSipAllowHeaderGetMethodType() RvSipAllowHeaderGetStrMethodType() RvSipAllowHeaderSetMethodType() RvSipAllowHeaderGetStrBadSyntax() RvSipAllowHeaderSetStrBadSyntax() HP C SIP Stack Message Layer Reference Guide
Get and Set Functions RvSipAllowHeaderGetStringLength() RvSipAllowHeaderGetStringLength() DESCRIPTION Some of the Allow header parameters are kept in a string format, for example, the method string. In order to get such a parameter from the Allow header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipAllowHeaderGetMethodType() RvSipAllowHeaderGetMethodType() DESCRIPTION Gets the method type enumeration from the Allow header. SYNTAX RvSipMethodType RvSipAllowHeaderGetMethodType( IN RvSipAllowHeaderHandle hHeader); PARAMETERS hHeader The handle to the Allow header. RETURN VALUES Returns the method type enumeration from the header. REMARKS If this function returns RVSIP_METHOD_OTHER, call RvSipAllowHeaderGetStrMethodType(), to get the actual method in a string format.
Get and Set Functions RvSipAllowHeaderGetStrMethodType() RvSipAllowHeaderGetStrMethodType() DESCRIPTION Copies the method type string from the Allow header into a given buffer. Use this function if RvSipAllowHeaderGetMethodType() returns RVSIP_METHOD_OTHER. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAllowHeaderSetMethodType() RvSipAllowHeaderSetMethodType() DESCRIPTION Sets the method type in the Allow header. SYNTAX RvStatus RvSipAllowHeaderSetMethodType( IN RvSipAllowHeaderHandle hHeader, IN RvSipMethodTypeeM ethodType, IN RvChar* strMethodType); PARAMETERS hHeader The handle to the Allow header. eMethodType The method type to be set in the object. strMethodType You can use this parameter only if the eMethodType parameter is set to RVSIP_METHOD_OTHER.
Get and Set Functions RvSipAllowHeaderGetStrBadSyntax() RvSipAllowHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipAllowHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAllowHeaderSetStrBadSyntax() RvSipAllowHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. Using this function, you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipAllowHeaderSetStrBadSyntax() 160 HP C SIP Stack Message Layer Reference Guide
4 ALLOW-EVENTS HEADER FUNCTIONS The Allow-Events header functions enable you to construct, copy, encode, parse, access and change Allow-Events header parameters. This section contains Allow-Events header functions found in the RvSipAllowEventsHeader.h header file.
Control Functions CONTROL FUNCTIONS 162 The Control functions are: RvSipAllowEventsHeaderConstructInMsg() RvSipAllowEventsHeaderConstruct() RvSipAllowEventsHeaderCopy() RvSipAllowEventsHeaderEncode() RvSipAllowEventsHeaderParse() RvSipAllowEventsHeaderParseValue() RvSipAllowEventsHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipAllowEventsHeaderConstructInMsg() RvSipAllowEventsHeaderConstructInMsg() DESCRIPTION Constructs an Allow-Events header inside a given message. The header is kept in the header list of the message.You can choose to insert the header either at the head or tail of the header list. SYNTAX RvStatus RvSipAllowEventsHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipAllowEventsHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipAllowEventsHeaderConstruct() RvSipAllowEventsHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Allow-Events header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipAllowEventsHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipAllowEventsHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle of the MessageMgr.
Control Functions RvSipAllowEventsHeaderCopy() RvSipAllowEventsHeaderCopy() DESCRIPTION Copies all parameters from a source Allow-Events header to a destination Allow-Events header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipAllowEventsHeaderCopy( INOUT RvSipAllowEventsHeaderHandle hDestination, IN hSource); RvSipAllowEventsHeaderHandle PARAMETERS hDestination The handle to the destination Allow-Events header.
Control Functions RvSipAllowEventsHeaderEncode() RvSipAllowEventsHeaderEncode() DESCRIPTION Encodes an Allow-Events header to a textual Allow-Events header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipAllowEventsHeaderParse() RvSipAllowEventsHeaderParse() DESCRIPTION Parses a SIP textual Allow-Events header into an Allow-Events header. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipAllowEventsHeaderParseValue() RvSipAllowEventsHeaderParseValue() DESCRIPTION Parses a SIP textual Allow-Events header value into an Allow-Events header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipAllowEventsHeaderFix() RvSipAllowEventsHeaderFix() DESCRIPTION Fixes a Allow-Events header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 170 The Get and Set functions are: RvSipAllowEventsHeaderGetStringLength() RvSipAllowEventsHeaderGetRpoolString() RvSipAllowEventsHeaderSetRpoolString() RvSipAllowEventsHeaderGetEventPackage() RvSipAllowEventsHeaderSetEventPackage() RvSipAllowEventsHeaderGetEventTemplate() RvSipAllowEventsHeaderSetEventTemplate() RvSipAllowEventsHeaderGetStrBadSyntax() RvSipAllowEventsHeaderSetStrBadSyntax() RvSipAllowEventsHeaderSetCompactForm() RvSipAl
Get and Set Functions RvSipAllowEventsHeaderGetStringLength() RvSipAllowEventsHeaderGetStringLength() DESCRIPTION Some of the Allow-Events header parameters are kept in a string format. In order to get such a parameter from the Allow-Events header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipAllowEventsHeaderGetRpoolString() RvSipAllowEventsHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Allow-Events header into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipAllowEventsHeaderGetRpoolString( IN RvSipAllowEventsHeaderHandle hSipAllowEventsHeader, IN RvSipAllowEventsHeaderStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipAllowEventsHeader The handle to the Allow-Events header.
Get and Set Functions RvSipAllowEventsHeaderSetRpoolString() RvSipAllowEventsHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Allow-Events header. The given string is located in an RPOOL memory and is not consecutive.
Get and Set Functions RvSipAllowEventsHeaderGetEventPackage() RvSipAllowEventsHeaderGetEventPackage() DESCRIPTION Copies the event-package string from the Allow-Events header into a given buffer. If bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAllowEventsHeaderSetEventPackage() RvSipAllowEventsHeaderSetEventPackage() DESCRIPTION Sets the event-package in the Allow-Events header. SYNTAX RvStatus RvSipAllowEventsHeaderSetEventPackage( IN RvSipAllowEventsHeaderHandle hHeader, IN RvChar* strEventPackage); PARAMETERS hHeader The handle to the Allow-Events header. strEventPackage The event string. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAllowEventsHeaderGetEventTemplate() RvSipAllowEventsHeaderGetEventTemplate() DESCRIPTION Copies the Event template string from the Allow-Events header into a given buffer. If bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAllowEventsHeaderSetEventTemplate() RvSipAllowEventsHeaderSetEventTemplate() DESCRIPTION Sets the Event template in the Allow-Events header. SYNTAX RvStatus RvSipAllowEventsHeaderSetEventTemplate( IN RvSipAllowEventsHeaderHandle hHeader, IN RvChar* strEvent); PARAMETERS hHeader The handle to the Allow-Events header. strEvent The event string. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAllowEventsHeaderGetStrBadSyntax() RvSipAllowEventsHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipAllowEventsHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAllowEventsHeaderSetStrBadSyntax() RvSipAllowEventsHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipAllowEventsHeaderSetCompactForm() RvSipAllowEventsHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipAllowEventsHeaderSetCompactForm( IN RvSipAllowEventsHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Allow-Events header. bIsCompact Specifies whether or not to use a compact form. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAllowEventsHeaderGetCompactForm() RvSipAllowEventsHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the header. SYNTAX RvStatus RvSipAllowEventsHeaderGetCompactForm( IN RvSipAllowEventsHeaderHandle hHeader, IN RvBool *pbIsCompact); PARAMETERS hHeader The handle to the Allow-Events header. pbIsCompact Specifies whether or not to use a compact form. RETURN VALUES Returns RvStatus.
5 AUTHENTICATION HEADER FUNCTIONS Authentication header functions enable you to construct, copy, encode, parse, access and change Authentication header parameters. This chapter contains Authentication header functions found in the RvSipAuthenticationHeader.h header file.
Control Functions CONTROL FUNCTIONS 184 The Control functions are: RvSipAuthenticationHeaderConstructInMsg() RvSipAuthenticationHeaderConstruct() RvSipAuthenticationHeaderCopy() RvSipAuthenticationHeaderEncode() RvSipAuthenticationHeaderParse() RvSipAuthenticationHeaderParseValue() RvSipAuthenticationHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipAuthenticationHeaderConstructInMsg() RvSipAuthenticationHeaderConstructInMsg() DESCRIPTION Constructs an Authentication header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list.
Control Functions RvSipAuthenticationHeaderConstruct() RvSipAuthenticationHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Authentication header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipAuthenticationHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipAuthenticationHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipAuthenticationHeaderCopy() RvSipAuthenticationHeaderCopy() DESCRIPTION Copies all parameters from a source Authentication header to a destination Authentication header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipAuthenticationHeaderCopy( IN RvSipAuthenticationHeaderHandle hDestination, IN RvSipAuthenticationHeaderHandle hSource); PARAMETERS hDestination The handle to the destination Authentication header.
Control Functions RvSipAuthenticationHeaderEncode() RvSipAuthenticationHeaderEncode() DESCRIPTION Encodes an Authentication header to a textual Authentication header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipAuthenticationHeaderParse() RvSipAuthenticationHeaderParse() DESCRIPTION Parses a SIP textual Authentication header into an Authentication header. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipAuthenticationHeaderParseValue() RvSipAuthenticationHeaderParseValue() DESCRIPTION Parses a SIP textual Authentication header value into an Authentication header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipAuthenticationHeaderFix() RvSipAuthenticationHeaderFix() DESCRIPTION Fixes an Authentication header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 192 The Get and Set functions are: RvSipAuthenticationHeaderGetStringLength() RvSipAuthenticationHeaderGetAuthScheme() RvSipAuthenticationHeaderGetStrAuthScheme() RvSipAuthenticationHeaderSetAuthScheme() RvSipAuthenticationHeaderGetRealm() RvSipAuthenticationHeaderSetRealm() RvSipAuthenticationHeaderGetDomain() RvSipAuthenticationHeaderSetDomain() RvSipAuthenticationHeaderGetNonce() RvSipAuthenti
Get and Set Functions RvSipAuthenticationHeaderSetStrIntegrityKey() RvSipAuthenticationHeaderGetStrCipherKey() RvSipAuthenticationHeaderSetStrCipherKey() Authentication Header Functions 193
Get and Set Functions RvSipAuthenticationHeaderGetStringLength() RvSipAuthenticationHeaderGetStringLength() DESCRIPTION Some of the Authentication header parameters are kept in a string format, for example, the nonce parameter. In order to get such a parameter from the Authentication header, your application should supply an adequate buffer to where the string will be copied.
Get and Set Functions RvSipAuthenticationHeaderGetAuthScheme() RvSipAuthenticationHeaderGetAuthScheme() DESCRIPTION Gets the authentication scheme enumeration from the Authentication header. SYNTAX RvSipAuthScheme RvSipAuthenticationHeaderGetAuthScheme( IN RvSipAuthenticationHeaderHandle hHeader); PARAMETERS hHeader The handle to the Authentication header. RETURN VALUES Returns the authentication scheme enumeration from the header.
Get and Set Functions RvSipAuthenticationHeaderGetStrAuthScheme() RvSipAuthenticationHeaderGetStrAuthScheme() DESCRIPTION Copies the authentication scheme string value from the authentication object into a given buffer. Use this function if RvSipAuthenticationHeaderGetAuthScheme() returns RVSIP_AUTH_SCHEME_OTHER. If the bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipAuthenticationHeaderSetAuthScheme() RvSipAuthenticationHeaderSetAuthScheme() DESCRIPTION Sets the authentication scheme in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetAuthScheme( IN RvSipAuthenticationHeaderHandle hHeader, IN RvSipAuthScheme eAuthScheme, IN RvChar* strAuthScheme); PARAMETERS hHeader The handle to the Authentication header. eAuthScheme The authentication scheme to be set in the object.
Get and Set Functions RvSipAuthenticationHeaderGetRealm() RvSipAuthenticationHeaderGetRealm() DESCRIPTION Copies the realm value of the Authentication header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationHeaderSetRealm() RvSipAuthenticationHeaderSetRealm() DESCRIPTION Sets the realm string in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetRealm( IN RvSipAuthenticationHeaderHandle hHeader, IN RvChar* pRealm); PARAMETERS hHeader The handle to the Authentication header. pRealm The realm to be set in the Authentication header. If a NULL value is supplied, the existing realm string in the header is removed. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderGetDomain() RvSipAuthenticationHeaderGetDomain() DESCRIPTION Copies the domain value of the authentication object into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationHeaderSetDomain() RvSipAuthenticationHeaderSetDomain() DESCRIPTION Sets the domain string in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetDomain( IN RvSipAuthenticationHeaderHandle hHeader, IN RvChar* pDomain); PARAMETERS hHeader The handle to the Authentication header. pDomain The domain to be set in the Authentication header. If a NULL value is supplied, the existing domain string in the header is removed.
Get and Set Functions RvSipAuthenticationHeaderGetNonce() RvSipAuthenticationHeaderGetNonce() DESCRIPTION Copies the nonce value of the authentication object into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationHeaderSetNonce() RvSipAuthenticationHeaderSetNonce() DESCRIPTION Sets the nonce string in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetNonce( IN RvSipAuthenticationHeaderHandle hHeader, IN RvChar* pNonce); PARAMETERS hHeader The handle to the Authentication header. pNonce The nonce to be set in the Authentication header. If a NULL value is supplied, the existing nonce string in the header is removed. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderGetOpaque() RvSipAuthenticationHeaderGetOpaque() DESCRIPTION Copies the opaque value of the authentication object into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationHeaderSetOpaque() RvSipAuthenticationHeaderSetOpaque() DESCRIPTION Sets the opaque string in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetOpaque( IN RvSipAuthenticationHeaderHandle hHeader, IN RvChar* pOpaque); PARAMETERS hHeader The handle to the Authentication header. pOpaque The opaque string to be set in the Authentication header. If a NULL value is supplied, the existing opaque string in the header is removed.
Get and Set Functions RvSipAuthenticationHeaderGetStrQop() RvSipAuthenticationHeaderGetStrQop() DESCRIPTION Copies the Qop string value of the authentication object into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationHeaderSetStrQop() RvSipAuthenticationHeaderSetStrQop() DESCRIPTION Sets the Qop string in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetStrQop( IN RvSipAuthenticationHeaderHandle hHeader, IN RvChar* pQop); PARAMETERS hHeader The handle to the Authentication header. pQop The Qop string to be set in the Authentication header. If a NULL value is supplied, the existing Qop string in the header is removed. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderGetStale() RvSipAuthenticationHeaderGetStale() DESCRIPTION Gets the stale enumeration from the Authentication header. SYNTAX RvSipAuthStale RvSipAuthenticationHeaderGetStale( IN RvSipAuthenticationHeaderHandle hSipAuthHeader); PARAMETERS hSipAuthHeader The handle to the Authentication header. RETURN VALUES Returns the stale enumeration value from the Authentication header.
Get and Set Functions RvSipAuthenticationHeaderSetStale() RvSipAuthenticationHeaderSetStale() DESCRIPTION Sets the stale parameter in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetStale( IN RvSipAuthenticationHeaderHandle hSipAuthHeader, IN RvSipAuthStale eStale); PARAMETERS hSipAuthHeader The handle to the Authentication header. eStale The stale value to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderGetAuthAlgorithm() RvSipAuthenticationHeaderGetAuthAlgorithm() DESCRIPTION Gets the algorithm type enumeration from the Authentication header. SYNTAX RvSipAuthAlgorithm RvSipAuthenticationHeaderGetAuthAlgorithm( IN RvSipAuthenticationHeaderHandle hHeader); PARAMETERS hHeader The handle to the Authentication header. RETURN VALUES Returns the algorithm type enumeration of the header.
Get and Set Functions RvSipAuthenticationHeaderGetStrAuthAlgorithm() RvSipAuthenticationHeaderGetStrAuthAlgorithm() DESCRIPTION Copies the authentication algorithm string from the Authentication header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationHeaderSetAuthAlgorithm() RvSipAuthenticationHeaderSetAuthAlgorithm() DESCRIPTION Sets the authentication algorithm in authentication object. SYNTAX RvStatus RvSipAuthenticationHeaderSetAuthAlgorithm( IN RvSipAuthenticationHeaderHandle Header, IN RvSipAuthAlgorithm eAuthAlgorithm, IN RvChar *strAuthAlgorithm); PARAMETERS hHeader The handle to the Authentication header. eAuthAlgorithem The authentication algorithm to be set in the object.
Get and Set Functions RvSipAuthenticationHeaderGetQopOption() RvSipAuthenticationHeaderGetQopOption() DESCRIPTION Gets the Qop option from the Authentication header. SYNTAX RvSipAuthQopOption RvSipAuthenticationHeaderGetQopOption( IN RvSipAuthenticationHeaderHandle hHeader); PARAMETERS hHeader The handle to the Authentication header. RETURN VALUES The Qop option from the header.
Get and Set Functions RvSipAuthenticationHeaderSetQopOption() RvSipAuthenticationHeaderSetQopOption() DESCRIPTION Sets the Qop option enumeration in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetQopOption( IN RvSipAuthenticationHeaderHandle IN RvSipAuthQopOption eQop); PARAMETERS hSipAuthHeader The handle to the Authentication header. eQop The Qop option enumeration to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderGetHeaderType() RvSipAuthenticationHeaderGetHeaderType() DESCRIPTION Gets the header type enumeration from the Authentication header. SYNTAX RvSipAuthenticationHeaderType RvSipAuthenticationHeaderGetHeaderType( IN RvSipAuthenticationHeaderHandle hSipAuthHeader); PARAMETERS hSipAuthHeader The handle to the Authentication header. RETURN VALUES Returns the Authentication header type enumeration from the header.
Get and Set Functions RvSipAuthenticationHeaderSetHeaderType() RvSipAuthenticationHeaderSetHeaderType() DESCRIPTION Sets the header type in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetHeaderType( IN RvSipAuthenticationHeaderHandle hSipAuthHeader, IN RvSipAuthenticationHeaderType eHeaderType); PARAMETERS hSipAuthHeader The handle to the Authentication header. eHeaderType The header type to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderGetOtherParams() RvSipAuthenticationHeaderGetOtherParams() DESCRIPTION Copies the Authentication header other-params parameter of the Authentication header into a given buffer. Not all the Authentication header parameters have separated parameters in the Authentication header. Parameters with no specific parameters are referred to as other-parameters. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipAuthenticationHeaderGetOtherParams() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderSetOtherParams() RvSipAuthenticationHeaderSetOtherParams() DESCRIPTION Sets the other-params parameter in the Authentication header. Not all the Authentication header parameters have separated parameters in the Authentication header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...
Get and Set Functions RvSipAuthenticationHeaderGetRpoolString() RvSipAuthenticationHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Authentication header into a given page from a specified pool. The copied string is not consecutive.
Get and Set Functions RvSipAuthenticationHeaderSetRpoolString() RvSipAuthenticationHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Authentication header. The given string is located in an RPOOL memory and is not consecutive.
Get and Set Functions RvSipAuthenticationHeaderGetStrBadSyntax() RvSipAuthenticationHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipAuthenticationHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderSetStrBadSyntax() RvSipAuthenticationHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipAuthenticationHeaderGetAKAVersion() RvSipAuthenticationHeaderGetAKAVersion() DESCRIPTION Gets the AKA version from the Authentication header. SYNTAX RvInt32 RvSipAuthenticationHeaderGetAKAVersion( IN RvSipAuthenticationHeaderHandle hSipAuthenticationHeader); PARAMETERS hAuthenticationHeader The handle to the Authentication header. RETURN VALUES Returns the AKAVersion, or UNDEFINED if the AKAVersion does not exist.
Get and Set Functions RvSipAuthenticationHeaderSetAKAVersion() RvSipAuthenticationHeaderSetAKAVersion() DESCRIPTION Sets the AKA version number of the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetAKAVersion( IN RvSipAuthenticationHeaderHandle hSipAuthenticationHeader, IN RvInt32 AKAVersion); PARAMETERS hAuthenticationHeader The handle to the Authentication header. AKAVersion The AKA version number to be set in the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationHeaderGetStrIntegrityKey() RvSipAuthenticationHeaderGetStrIntegrityKey() DESCRIPTION Copies the IntegrityKey string value of the Authentication header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationHeaderSetStrIntegrityKey() RvSipAuthenticationHeaderSetStrIntegrityKey() DESCRIPTION Sets the IntegrityKey string in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetStrIntegrityKey( IN RvSipAuthenticationHeaderHandle hHeader, IN RvChar* pIntegrityKey); PARAMETERS hHeader The handle to the Authentication header. pIntegrityKey The IntegrityKey string to be set in the Authentication header.
Get and Set Functions RvSipAuthenticationHeaderGetStrCipherKey() RvSipAuthenticationHeaderGetStrCipherKey() DESCRIPTION Copies the CipherKey string value of the Authentication object into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationHeaderSetStrCipherKey() RvSipAuthenticationHeaderSetStrCipherKey() DESCRIPTION Sets the CipherKey string in the Authentication header. SYNTAX RvStatus RvSipAuthenticationHeaderSetStrCipherKey( IN RvSipAuthenticationHeaderHandle hHeader, IN RvChar* pCipherKey); PARAMETERS hHeader The handle to the Authentication header. pCipherKey The CipherKey string to be set in the Authentication header.
6 AUTHENTICATION-INFO HEADER FUNCTIONS Authentication-Info header functions enable you to construct, copy, encode, parse, access and change Authentication-Info header parameters. This chapter contains Authentication-Info header functions found in the RvSipAuthenticationInfoHeader.h header file.
Control Functions CONTROL FUNCTIONS 232 The Control functions are: RvSipAuthenticationInfoHeaderConstructInMsg() RvSipAuthenticationInfoHeaderConstruct() RvSipAuthenticationInfoHeaderCopy() RvSipAuthenticationInfoHeaderEncode() RvSipAuthenticationInfoHeaderParse() RvSipAuthenticationInfoHeaderParseValue() RvSipAuthenticationInfoHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipAuthenticationInfoHeaderConstructInMsg() RvSipAuthenticationInfoHeaderConstructInMsg() DESCRIPTION Constructs an Authentication-Info header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list.
Control Functions RvSipAuthenticationInfoHeaderConstruct() RvSipAuthenticationInfoHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Authentication-Info header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned.
Control Functions RvSipAuthenticationInfoHeaderCopy() RvSipAuthenticationInfoHeaderCopy() DESCRIPTION Copies the informative field from a source Authentication-Info header to a destination Authentication-Info header. The informative field is the field indicated by the RvSipAuthInfoType enumeration.You must construct the destination object before using this function.
Control Functions RvSipAuthenticationInfoHeaderEncode() RvSipAuthenticationInfoHeaderEncode() DESCRIPTION Encodes an Authentication-Info header to a textual Authentication-Info header. The textual header is placed on a page taken from a specified pool. In order to copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipAuthenticationInfoHeaderParse() RvSipAuthenticationInfoHeaderParse() DESCRIPTION Parses a SIP textual Authentication-Info header into an Authentication-Info header. All the textual fields are placed inside the object. Note Before performing the parse operation the stack resets all the header fields. Therefore, if the parse function fails, you will not be able to get the previous header field values.
Control Functions RvSipAuthenticationInfoHeaderParseValue() RvSipAuthenticationInfoHeaderParseValue() DESCRIPTION Parses a SIP textual Authentication-Info header value into an AuthenticationInfo header. A SIP header has the following grammar: “header-name:headervalue”. This function takes the header-value part as a parameter and parses it into the supplied object.All the textual fields are placed inside the object.
Control Functions RvSipAuthenticationInfoHeaderFix() RvSipAuthenticationInfoHeaderFix() DESCRIPTION Fixes an Authentication-Info header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header, which parses a given correct headervalue string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 240 The Get and Set functions are: RvSipAuthenticationInfoHeaderGetStringLength() RvSipAuthenticationInfoHeaderGetNextNonce() RvSipAuthenticationInfoHeaderSetNextNonce() RvSipAuthenticationInfoHeaderGetCNonce() RvSipAuthenticationInfoHeaderSetCNonce() RvSipAuthenticationInfoHeaderGetResponseAuth() RvSipAuthenticationInfoHeaderSetResponseAuth() RvSipAuthenticationInfoHeaderGetNonceCount() RvSipAuthenticationInfoHeaderSetNonceCou
Get and Set Functions RvSipAuthenticationInfoHeaderGetStringLength() RvSipAuthenticationInfoHeaderGetStringLength() DESCRIPTION Some of the Authentication-Info header fields are kept in a string format, for example, the Authentication-Info header next-nonce string. To get such a field from the Authentication-Info header, your application should supply an adequate buffer to where the string will be copied.
Get and Set Functions RvSipAuthenticationInfoHeaderGetNextNonce() RvSipAuthenticationInfoHeaderGetNextNonce() DESCRIPTION Copies the next-nonce string from the Authentication-Info header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationInfoHeaderSetNextNonce() RvSipAuthenticationInfoHeaderSetNextNonce() DESCRIPTION Sets the next-nonce string in the Authentication-Info header. SYNTAX RvStatus RvSipAuthenticationInfoHeaderSetNextNonce( IN RvSipAuthenticationInfoHeaderHandle hHeader, IN RvChar *pNextNonce); PARAMETERS hHeader The handle to the Authentication-Info header. pNextNonce The next-nonce string to be set in the Authentication-Info header.
Get and Set Functions RvSipAuthenticationInfoHeaderGetCNonce() RvSipAuthenticationInfoHeaderGetCNonce() DESCRIPTION Copies the cnonce string from the Authentication-Info header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationInfoHeaderSetCNonce() RvSipAuthenticationInfoHeaderSetCNonce() DESCRIPTION Sets the cnonce string in the Authentication-Info header. SYNTAX RvStatus RvSipAuthenticationInfoHeaderSetCNonce( IN RvSipAuthenticationInfoHeaderHandle hHeader, IN RvChar* pCNonce); PARAMETERS hHeader The handle to the Authentication-Info header. pCNonce The cnonce string to be set in the Authentication-Info header.
Get and Set Functions RvSipAuthenticationInfoHeaderGetResponseAuth() RvSipAuthenticationInfoHeaderGetResponseAuth() DESCRIPTION Copies the response-auth string from the Authentication-Info header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationInfoHeaderSetResponseAuth() RvSipAuthenticationInfoHeaderSetResponseAuth() DESCRIPTION Sets the response-auth string in the Authentication-Info header. SYNTAX RvStatus RvSipAuthenticationInfoHeaderSetResponseAuth( IN RvSipAuthenticationInfoHeaderHandle hHeader, IN RvChar* pResponseAuth); PARAMETERS hHeader The handle to the Authentication-Info header. pResponseAuth The response-auth string to be set in the Authentication-Info header.
Get and Set Functions RvSipAuthenticationInfoHeaderGetNonceCount() RvSipAuthenticationInfoHeaderGetNonceCount() DESCRIPTION Gets the nonce count value from the Authentication-Info header. SYNTAX RvInt32 RvSipAuthenticationInfoHeaderGetNonceCount( IN RvSipAuthenticationInfoHeaderHandle hSipAuthInfoHeader); PARAMETERS hSipAuthInfoHeader The handle to the Authentication-Info header. RETURN VALUES Returns the nonce count value.
Get and Set Functions RvSipAuthenticationInfoHeaderSetNonceCount() RvSipAuthenticationInfoHeaderSetNonceCount() DESCRIPTION Sets the nonce count value in the Authentication-Info header. SYNTAX RvStatus RvSipAuthenticationInfoHeaderSetNonceCount( IN RvSipAuthenticationInfoHeaderHandle hSipAuthInfoHeader, IN RvInt32 nonceCount); PARAMETERS hSipAuthInfoHeader The handle to the Authentication-Info header. nonceCount The nonce count value to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationInfoHeaderGetQopOption() RvSipAuthenticationInfoHeaderGetQopOption() DESCRIPTION Gets the Qop option enumeration from the Authentication-Info header. SYNTAX RvSipAuthQopOption RvSipAuthenticationInfoHeaderGetQopOption( IN RvSipAuthenticationInfoHeaderHandle PARAMETERS hHeader Returns the Qop option enumeration from the object. RETURN VALUES Returns the Qop type from the object.
Get and Set Functions RvSipAuthenticationInfoHeaderGetStrQop() RvSipAuthenticationInfoHeaderGetStrQop() DESCRIPTION Copies the Qop string value of the Authentication-Info object into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthenticationInfoHeaderSetQopOption() RvSipAuthenticationInfoHeaderSetQopOption() DESCRIPTION Sets the Qop string in the Authentication-Info header. SYNTAX RvStatus RvSipAuthenticationInfoHeaderSetQopOption( IN RvSipAuthenticationInfoHeaderHandle hHeader, IN RvSipAuthQopOption eQop, IN RvChar* strQop); PARAMETERS hHeader The handle to the Authentication-Info header. eQop The Qop option enumeration value to be set in the object.
Get and Set Functions RvSipAuthenticationInfoHeaderGetStrBadSyntax() RvSipAuthenticationInfoHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string.
Get and Set Functions RvSipAuthenticationInfoHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthenticationInfoHeaderSetStrBadSyntax() RvSipAuthenticationInfoHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with bad-syntax. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipAuthenticationInfoHeaderGetRpoolString() RvSipAuthenticationInfoHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Authentication-Info header into a given page from a specified pool. The copied string is not consecutive.
Get and Set Functions RvSipAuthenticationInfoHeaderSetRpoolString() RvSipAuthenticationInfoHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Authentication-Info header. The given string is located on an RPOOL memory and is not consecutive.
Get and Set Functions RvSipAuthenticationInfoHeaderSetRpoolString() 258 HP C SIP Stack Message Layer Reference Guide
7 AUTHORIZATION HEADER FUNCTIONS The Authorization header functions enable you to construct, copy, encode, parse, access and change Authorization header parameters. This section contains Authorization header functions found in the RvSipAuthorizationHeader.h header file.
Control Functions CONTROL FUNCTIONS 260 The Control functions are: RvSipAuthorizationHeaderConstructInMsg() RvSipAuthorizationHeaderConstruct() RvSipAuthorizationHeaderCopy() RvSipAuthorizationHeaderEncode() RvSipAuthorizationHeaderParse() RvSipAuthorizationHeaderParseValue() RvSipAuthorizationHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipAuthorizationHeaderConstructInMsg() RvSipAuthorizationHeaderConstructInMsg() DESCRIPTION Constructs an Authorization header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list.
Control Functions RvSipAuthorizationHeaderConstruct() RvSipAuthorizationHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Authorization header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipAuthorizationHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipAuthorizationHeaderHandle hPage, *hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipAuthorizationHeaderCopy() RvSipAuthorizationHeaderCopy() DESCRIPTION Copies all parameters from a source Authorization header to a destination Authorization header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipAuthorizationHeaderCopy( IN RvSipAuthorizationHeaderHandle hDestination, IN RvSipAuthorizationHeaderHandle hSource); PARAMETERS hDestination The handle to the destination Authorization header.
Control Functions RvSipAuthorizationHeaderEncode() RvSipAuthorizationHeaderEncode() DESCRIPTION Encodes an Authorization header to a textual Authorization header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipAuthorizationHeaderParse() RvSipAuthorizationHeaderParse() DESCRIPTION Parses a SIP textual Authorization header into an Authorization header. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipAuthorizationHeaderParseValue() RvSipAuthorizationHeaderParseValue() DESCRIPTION Parses a SIP textual Authorization header value into an Authorization header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipAuthorizationHeaderFix() RvSipAuthorizationHeaderFix() DESCRIPTION Fixes an Authorization header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 268 The Get and Set functions are: RvSipAuthorizationHeaderGetStringLength() RvSipAuthorizationHeaderGetCredentialIdentifier() RvSipAuthorizationHeaderGetAuthScheme() RvSipAuthorizationHeaderGetStrAuthScheme() RvSipAuthorizationHeaderSetAuthScheme() RvSipAuthorizationHeaderGetRealm() RvSipAuthorizationHeaderSetRealm() RvSipAuthorizationHeaderGetNonce() RvSipAuthorizationHeaderSetNonce() RvSipAuth
Get and Set Functions RvSipAuthorizationHeaderGetStrBadSyntax() RvSipAuthorizationHeaderSetStrBadSyntax() RvSipAuthorizationHeaderGetStrAuts() RvSipAuthorizationHeaderSetStrAuts() RvSipAuthorizationHeaderGetIntegrityProtected() RvSipAuthorizationHeaderSetIntegrityProtected() Authorization Header Functions 269
Get and Set Functions RvSipAuthorizationHeaderGetStringLength() RvSipAuthorizationHeaderGetStringLength() DESCRIPTION Some of the Authorization header parameters are kept in a string format, for example, the Authorization header user name string. In order to get such a parameter from the Authorization header, your application should supply an adequate buffer to where the string will be copied.
Get and Set Functions RvSipAuthorizationHeaderGetCredentialIdentifier() RvSipAuthorizationHeaderGetCredentialIdentifier() DESCRIPTION Gets the identifiers of the creditable Authentication header. This function will return the realm and username strings without quotation marks (""). If you want these parameters in quotation marks, use the specific Get functions, and not this function.
Get and Set Functions RvSipAuthorizationHeaderGetCredentialIdentifier() strUsernameBuff The buffer to fill with the username parameter. usernameBuffLen The length of the username given buffer. strNonceBuff The buffer to fill with the nonce parameter. nonceBuffLen The length of the nonce given buffer. realmActualLen The length of the realm parameter +1 to include a NULL value at the end. usernameActualLen The length of the username parameter +1 to include a NULL value at the end.
Get and Set Functions RvSipAuthorizationHeaderGetAuthScheme() RvSipAuthorizationHeaderGetAuthScheme() DESCRIPTION Gets the authentication scheme enumeration value from the Authorization header. SYNTAX RvSipAuthScheme RvSipAuthorizationHeaderGetAuthScheme( IN RvSipAuthorizationHeaderHandle hHeader); PARAMETERS hHeader The handle to the Authorization header. RETURN VALUES Returns the authentication scheme enumeration from the object.
Get and Set Functions RvSipAuthorizationHeaderGetStrAuthScheme() RvSipAuthorizationHeaderGetStrAuthScheme() DESCRIPTION Gets the authentication scheme string value from the Authorization header. Use this function if RvSipAuthorizationHeaderGetAuthScheme() returns RVSIP_AUTH_SCHEME_OTHER. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthorizationHeaderSetAuthScheme() RvSipAuthorizationHeaderSetAuthScheme() DESCRIPTION Sets the authentication scheme in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetAuthScheme( IN RvSipAuthorizationHeaderHandle hHeader, IN RvSipAuthScheme eAuthScheme, IN RvChar* strAuthScheme); PARAMETERS hHeader The handle to the Authorization header. eAuthScheme The Authentication scheme to be set in the object.
Get and Set Functions RvSipAuthorizationHeaderGetRealm() RvSipAuthorizationHeaderGetRealm() DESCRIPTION Copies the realm string from the Authorization header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthorizationHeaderSetRealm() RvSipAuthorizationHeaderSetRealm() DESCRIPTION Sets the realm string in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetRealm( IN RvSipAuthorizationHeaderHandle hHeader, IN RvChar* pRealm); PARAMETERS hHeader The handle to the Authorization header. pRealm The realm string to be set in the Authorization header. If NULL is supplied, the existing realm is removed from the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthorizationHeaderGetNonce() RvSipAuthorizationHeaderGetNonce() DESCRIPTION Copies the nonce string from the Authorization header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthorizationHeaderSetNonce() RvSipAuthorizationHeaderSetNonce() DESCRIPTION Sets the nonce string in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetNonce( IN RvSipAuthorizationHeaderHandle hHeader, IN RvChar* pNonce); PARAMETERS hHeader The handle to the Authorization header. pNonce The nonce string to be set in the Authorization header. If a NULL value is supplied, the existing nonce string in the header is removed. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthorizationHeaderGetOpaque() RvSipAuthorizationHeaderGetOpaque() DESCRIPTION Copies the opaque string from the Authorization header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthorizationHeaderSetOpaque() RvSipAuthorizationHeaderSetOpaque() DESCRIPTION Sets the opaque string in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetOpaque( IN RvSipAuthorizationHeaderHandle hHeader, IN RvChar* pOpaque); PARAMETERS hHeader The handle to the Authorization header. pOpaque The opaque string to be set in the Authorization header. If a NULL value is supplied, the existing opaque string in the header is removed.
Get and Set Functions RvSipAuthorizationHeaderGetUserName() RvSipAuthorizationHeaderGetUserName() DESCRIPTION Copies the user name string from the Authorization header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthorizationHeaderSetUserName() RvSipAuthorizationHeaderSetUserName() DESCRIPTION Sets the user name string in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetUserName( IN RvSipAuthorizationHeaderHandle hHeader, IN RvChar* pUserName); PARAMETERS hHeader The handle to the Authorization header. pUserName The user name string to be set in the Authorization header. If a NULL value is supplied, the existing user name string in the header is removed.
Get and Set Functions RvSipAuthorizationHeaderGetNonceCount() RvSipAuthorizationHeaderGetNonceCount() DESCRIPTION Gets the nonce count value from the Authorization header. SYNTAX RvInt32 RvSipAuthorizationHeaderGetNonceCount( IN RvSipAuthorizationHeaderHandle PARAMETERS hSipAuthHeader The handle to the Authorization header. RETURN VALUES Returns the nonce count value.
Get and Set Functions RvSipAuthorizationHeaderSetNonceCount() RvSipAuthorizationHeaderSetNonceCount() DESCRIPTION Sets the nonce count value in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetNonceCount( IN RvSipAuthorizationHeaderHandle hSipAuthHeader, IN RvInt32 nonceCount); PARAMETERS hSipAuthHeader The handle to the Authorization header. nonceCount The nonce count value to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthorizationHeaderGetAuthAlgorithm() RvSipAuthorizationHeaderGetAuthAlgorithm() DESCRIPTION Gets the authentication algorithm enumeration from the Authorization header. SYNTAX RvSipAuthAlgorithm RvSipAuthorizationHeaderGetAuthAlgorithm( IN RvSipAuthorizationHeaderHandle hHeader); PARAMETERS hHeader The handle to the Authorization header. RETURN VALUES Returns the Authentication algorithm enumeration from the header.
Get and Set Functions RvSipAuthorizationHeaderGetStrAuthAlgorithm() RvSipAuthorizationHeaderGetStrAuthAlgorithm() DESCRIPTION Copies the authentication algorithm string from the Authorization header into a given buffer. Use this function if RvSipAuthorizationHeaderGetAuthAlgorithm() returns RVSIP_AUTH_ALGORITHM_OTHER. If the bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipAuthorizationHeaderSetAuthAlgorithm() RvSipAuthorizationHeaderSetAuthAlgorithm() DESCRIPTION Sets the authentication algorithm in Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetAuthAlgorithm( IN RvSipAuthorizationHeaderHandle hHeader, IN RvSipAuthAlgorithm eAuthAlgorithm, IN RvChar *strAuthAlgorithm); PARAMETERS hHeader The handle to the Authorization header. eAuthAlgorithm The Authentication algorithm to be set in the object.
Get and Set Functions RvSipAuthorizationHeaderGetQopOption() RvSipAuthorizationHeaderGetQopOption() DESCRIPTION Gets the Qop option enumeration from the Authorization object. SYNTAX RvSipAuthQopOption RvSipAuthorizationHeaderGetQopOption( IN RvSipAuthorizationHeaderHandle hHeader); PARAMETERS hHeader The handle to the Authorization header. RETURN VALUES Returns the Qop option enumeration from the object.
Get and Set Functions RvSipAuthorizationHeaderSetQopOption() RvSipAuthorizationHeaderSetQopOption() DESCRIPTION Sets the Qop option enumeration in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetQopOption( IN RvSipAuthorizationHeaderHandle IN RvSipAuthQopOption eQop); PARAMETERS hSipAuthHeader The handle to the Authorization header. eQop The Qop option to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthorizationHeaderGetResponse() RvSipAuthorizationHeaderGetResponse() DESCRIPTION Copies the response string from the Authorization header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthorizationHeaderSetResponse() RvSipAuthorizationHeaderSetResponse() DESCRIPTION Sets the response string in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetResponse( IN RvSipAuthorizationHeaderHandle hHeader, IN RvChar* pResponse); PARAMETERS hHeader The handle to the Authorization header. pResponse The Response string to be set in the Authorization header. If a NULL value is supplied, the existing Response string in the header is removed.
Get and Set Functions RvSipAuthorizationHeaderGetCNonce() RvSipAuthorizationHeaderGetCNonce() DESCRIPTION Copies the cnonce string from the Authorization header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthorizationHeaderSetCNonce() RvSipAuthorizationHeaderSetCNonce() DESCRIPTION Sets the cnonce string in the authorization object. SYNTAX RvStatus RvSipAuthorizationHeaderSetCNonce( IN RvSipAuthorizationHeaderHandle hHeader, IN RvChar* pCNonce); PARAMETERS hHeader The handle to the Authorization header. pCNonce The CNonce string to be set in the Authorization header. If a NULL value is supplied, the existing CNonce string in the header is removed.
Get and Set Functions RvSipAuthorizationHeaderGetDigestUri() RvSipAuthorizationHeaderGetDigestUri() DESCRIPTION Gets the handle to the digest URI address from the Authorization header which holds the digest URI parameter. SYNTAX RvSipAddressHandle RvSipAuthorizationHeaderGetDigestUri( IN RvSipAuthorizationHeaderHandle hHeader); PARAMETERS hHeader The handle to the Authorization header RETURN VALUES Returns a handle to the address, or NULL if the address does not exist.
Get and Set Functions RvSipAuthorizationHeaderSetDigestUri() RvSipAuthorizationHeaderSetDigestUri() DESCRIPTION Sets the digest URI parameter in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetDigestUri( IN RvSipAuthorizationHeaderHandle hHeader, IN RvSipAddressHandle hDigestUri); PARAMETERS hHeader The handle to the Authorization header hdigestUri The handle to the address. If a NULL is supplied, the existing address in the Authorization header is removed.
Get and Set Functions RvSipAuthorizationHeaderGetHeaderType() RvSipAuthorizationHeaderGetHeaderType() DESCRIPTION Gets the header type enumeration from the Authorization header. SYNTAX RvSipAuthorizationHeaderType RvSipAuthorizationHeaderGetHeaderType( IN RvSipAuthorizationHeaderHandle hSipAuthHeader); PARAMETERS hSipAuthHeader The handle to the Authorization header. RETURN VALUES Returns the Authorization header type enumeration from the Authorization header.
Get and Set Functions RvSipAuthorizationHeaderSetHeaderType() RvSipAuthorizationHeaderSetHeaderType() DESCRIPTION Sets the header type in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetHeaderType( IN RvSipAuthorizationHeaderHandle hSipAuthHeader, IN RvSipAuthorizationHeaderType eHeaderType); PARAMETERS hSipAuthHeader The handle to the Authorization header. eHeaderType The header type to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthorizationHeaderGetOtherParams() RvSipAuthorizationHeaderGetOtherParams() DESCRIPTION Copies the Authorization header other-params parameter of the Authorization header into a given buffer. Not all the Authorization header parameters have separated parameters in the Authorization header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipAuthorizationHeaderGetOtherParams() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthorizationHeaderSetOtherParams() RvSipAuthorizationHeaderSetOtherParams() DESCRIPTION Sets the other-params parameter in the Authorization header. Not all the Authorization header parameters have separated parameters in the Authorization header. Parameters with no specific parameters are referred to as “otherparams”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipAuthorizationHeaderSetRpoolString() RvSipAuthorizationHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Authorization header. The given string is located in an RPOOL memory and is not consecutive.
Get and Set Functions RvSipAuthorizationHeaderGetRpoolString() RvSipAuthorizationHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Authorization header into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipAuthorizationHeaderGetRpoolString( IN RvSipAuthorizationHeaderHandle hSipAuthHeader, IN RvSipAuthorizationHeaderStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipAuthHeader The handle to the Authorization header.
Get and Set Functions RvSipAuthorizationHeaderGetStrBadSyntax() RvSipAuthorizationHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipAuthorizationHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthorizationHeaderSetStrBadSyntax() RvSipAuthorizationHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipAuthorizationHeaderGetStrAuts() RvSipAuthorizationHeaderGetStrAuts() DESCRIPTION Copies the Auts string from the Authorization header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipAuthorizationHeaderSetStrAuts() RvSipAuthorizationHeaderSetStrAuts() DESCRIPTION Sets the nonce string in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetStrAuts( IN RvSipAuthorizationHeaderHandle hHeader, IN RvChar* pAuts); PARAMETERS hHeader The handle to the Authorization header. pAuts The Auts string to be set in the Authorization header. If a NULL value is supplied, the existing Auts string in the header is removed. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipAuthorizationHeaderGetIntegrityProtected() RvSipAuthorizationHeaderGetIntegrityProtected() DESCRIPTION Gets the IntegrityProtected option enumeration from the Authorization header. SYNTAX RvSipAuthIntegrityProtected RvSipAuthorizationHeaderGetIntegrityProtected( IN RvSipAuthorizationHeaderHandle hHeader); PARAMETERS hHeader The header from which to get the IntegrityProtected enumeration. RETURN VALUES Returns the IntegrityProtected type from the object.
Get and Set Functions RvSipAuthorizationHeaderSetIntegrityProtected() RvSipAuthorizationHeaderSetIntegrityProtected() DESCRIPTION Sets the IntegrityProtected enumeration in the Authorization header. SYNTAX RvStatus RvSipAuthorizationHeaderSetIntegrityProtected( IN RvSipAuthorizationHeaderHandle hSipAuthHeader, IN RvSipAuthIntegrityProtected eIntegrityProtected); PARAMETERS hSipAuthHeader The handle to the Authorization header. eIntegrityProtected The IntegrityProtected value to be set in the header.
8 CONTACT HEADER FUNCTIONS The Contact header functions enable you to construct, copy, encode, parse, access and change Contact header parameters. This section contains Contact header functions found in the RvSipContactHeader.h header file.
Control Functions CONTROL FUNCTIONS 312 The Control functions are: RvSipContactHeaderConstructInMsg() RvSipContactHeaderConstruct() RvSipContactHeaderCopy() RvSipContactHeaderEncode() RvSipContactHeaderParse() RvSipContactHeaderParseValue() RvSipContactHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipContactHeaderConstructInMsg() RvSipContactHeaderConstructInMsg() DESCRIPTION Constructs a Contact header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipContactHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipContactHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipContactHeaderConstruct() RvSipContactHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Contact header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipContactHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipContactHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipContactHeaderCopy() RvSipContactHeaderCopy() DESCRIPTION Copies all parameters from a source Contact header to a destination Contact header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipContactHeaderCopy( INOUT RvSipContactHeaderHandle hDestination, IN hSource); RvSipContactHeaderHandle PARAMETERS hDestination The handle to the destination Contact header. hSource The handle to the source Contact header.
Control Functions RvSipContactHeaderEncode() RvSipContactHeaderEncode() DESCRIPTION Encodes a Contact header to a textual Contact header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipContactHeaderEncode( IN RvSipContactHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hHeader The handle to the Contact header.
Control Functions RvSipContactHeaderParse() RvSipContactHeaderParse() DESCRIPTION Parses a SIP textual Contact header into a Contact header. All the textual parameters are placed inside the object. For example, “Contact:sip:172.20.5.3:5060”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipContactHeaderParseValue() RvSipContactHeaderParseValue() DESCRIPTION Parses a SIP textual Contact header value into an Contact header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipContactHeaderFix() RvSipContactHeaderFix() DESCRIPTION Fixes a Contact header with bad-syntax information. A SIP header has the following grammar, “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 320 The Get and Set functions are: RvSipContactHeaderGetStringLength() RvSipContactHeaderGetDisplayName() RvSipContactHeaderSetDisplayName() RvSipContactHeaderGetAddrSpec() RvSipContactHeaderSetAddrSpec() RvSipContactHeaderGetExpires() RvSipContactHeaderSetExpires() RvSipContactHeaderGetQVal() RvSipContactHeaderSetQVal() RvSipContactHeaderGetAction() RvSipContactHeaderSetAction() RvSipContactHeaderSetStar() RvSipConta
Get and Set Functions RvSipContactHeaderGetStringLength() RvSipContactHeaderGetStringLength() DESCRIPTION Some of the Contact header parameters are kept in a string format, for example, the Contact header display name. In order to get such a parameter from the Contact header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipContactHeaderGetDisplayName() RvSipContactHeaderGetDisplayName() DESCRIPTION Copies the display name from the Contact header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipContactHeaderSetDisplayName() RvSipContactHeaderSetDisplayName() DESCRIPTION Sets the display name in the Contact header. SYNTAX RvStatus RvSipContactHeaderSetDisplayName( IN RvSipContactHeaderHandle hHeader, IN RvChar* strDisplayName); PARAMETERS hHeader The handle to the header. strDisplayName The display name to be set in the Contact header. If NULL is supplied, the existing display name is removed from the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContactHeaderGetAddrSpec() RvSipContactHeaderGetAddrSpec() DESCRIPTION The address-spec parameter is held in the Contact header as an address. This function returns the handle to the address. SYNTAX RvSipAddressHandle RvSipContactHeaderGetAddrSpec( IN RvSipContactHeaderHandle hHeader); PARAMETERS hHeader The handle to the Contact header. RETURN VALUES Returns a handle to the address-spec object, or NULL if the address-spec object does not exist.
Get and Set Functions RvSipContactHeaderSetAddrSpec() RvSipContactHeaderSetAddrSpec() DESCRIPTION Sets the “address-spec” parameter in the Contact header. SYNTAX RvStatus RvSipContactHeaderSetAddrSpec( IN RvSipContactHeaderHandle hHeader, IN RvSipAddressHandle hAddrSpec); PARAMETERS hHeader The handle to the Contact header. hAddrSpec The handle to the address-spec address. If NULL is supplied, the existing “address spec” is removed from the Contact header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContactHeaderGetExpires() RvSipContactHeaderGetExpires() DESCRIPTION The Contact header contains an Expires header. This function returns the handle to the expires header. SYNTAX RvSipExpiresHeaderHandle RvSipContactHeaderGetExpires( IN RvSipContactHeaderHandle hHeader); PARAMETERS hHeader The handle to the Contact header. RETURN VALUES Returns the handle to the expires header, or NULL if the expires header does not exist.
Get and Set Functions RvSipContactHeaderSetExpires() RvSipContactHeaderSetExpires() DESCRIPTION Sets the expires header in the Contact header. SYNTAX RvStatus RvSipContactHeaderSetExpires( IN RvSipContactHeaderHandle hHeader, IN RvSipExpiresHeaderHandle hExpires); PARAMETERS hHeader The handle to the Contact header. hExpires The handle to the expires header to be set in the Contact header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContactHeaderGetQVal() RvSipContactHeaderGetQVal() DESCRIPTION Copies the q parameter from the Contact header into a given buffer. If the value of bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipContactHeaderSetQVal() RvSipContactHeaderSetQVal() DESCRIPTION Sets the q parameter value in the Contact header. SYNTAX RvStatus RvSipContactHeaderSetQVal( IN RvSipContactHeaderHandle hHeader, IN RvChar *strQVal); PARAMETERS hHeader The handle to the Contact header. strQVal The value of the offset of the “q parameter to be set. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContactHeaderGetAction() RvSipContactHeaderGetAction() DESCRIPTION The Contact header contains the action type. This function returns this type. SYNTAX RvSipContactAction RvSipContactHeaderGetAction( IN RvSipContactHeaderHandle hHeader); PARAMETERS hHeader The handle to the Contact header. RETURN VALUES Returns the type of the action in the Contact header.
Get and Set Functions RvSipContactHeaderSetAction() RvSipContactHeaderSetAction() DESCRIPTION Sets the action type in the Contact header. SYNTAX RvStatus RvSipContactHeaderSetAction( IN RvSipContactHeaderHandle hHeader, IN RvSipContactAction action); PARAMETERS hHeader The handle to the Contact header. action The action type to be set. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContactHeaderSetStar() RvSipContactHeaderSetStar() DESCRIPTION A Contact header can be in the form of “Contact: *”. This function defines the Contact header as an asterisk (*) Contact header. SYNTAX RvStatus RvSipContactHeaderSetStar( IN RvSipContactHeaderHandle PARAMETERS hHeader The handle of the Contact header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContactHeaderIsStar() RvSipContactHeaderIsStar() DESCRIPTION Determines whether or not the Contact header contains an asterisk (*). This means that the header is of the form “Contact: *”. SYNTAX RvBool RvSipContactHeaderIsStar( IN RvSipContactHeaderHandle hHeader); PARAMETERS hHeader The handle of the Contact header. RETURN VALUES Returns RV_TRUE if the Contact header is of the form “Contact: *”. Otherwise returns RV_FALSE.
Get and Set Functions RvSipContactHeaderGetOtherParams() RvSipContactHeaderGetOtherParams() DESCRIPTION Copies the Contact header other-params parameter of the Contact header into a given buffer. Not all the Contact header parameters have separated parameters in the Contact header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipContactHeaderSetOtherParams() RvSipContactHeaderSetOtherParams() DESCRIPTION Sets the other-params parameter in the Contact header. Not all the Contact header parameters have separated parameters in the Contact header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipContactHeaderGetRpoolString() RvSipContactHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Contact header into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipContactHeaderGetRpoolString( IN RvSipContactHeaderHandle hSipContactHeader, IN RvSipContactHeaderStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipContactHeader The handle to the Contact header.
Get and Set Functions RvSipContactHeaderSetRpoolString() RvSipContactHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Contact header. The given string is located in an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipContactHeaderSetRpoolString( IN RvSipContactHeaderHandle hSipContactHeader, IN RvSipContactHeaderStringName eStringName, IN RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipContactHeader The handle to the Contact header.
Get and Set Functions RvSipContactHeaderGetStrBadSyntax() RvSipContactHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipContactHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContactHeaderSetStrBadSyntax() RvSipContactHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipContactHeaderSetCompactForm() RvSipContactHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipContactHeaderSetCompactForm( IN RvSipContactHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Contact header. bIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContactHeaderGetCompactForm() RvSipContactHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the header. SYNTAX RvStatus RvSipContactHeaderGetCompactForm ( IN RvSipContactHeaderHandle hHeader, IN RvBool *pbIsCompact); PARAMETERS hHeader The handle to the Contact header. pbIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
9 CONTENT-DISPOSITION HEADER FUNCTIONS Content-Disposition header functions enable you to construct, copy, encode, parse, access and change Content-Disposition header parameters. This section contains Content-Disposition header functions found in the RvSipContentDipositionHeader.h header file.
Control Functions CONTROL FUNCTIONS 344 The Control functions are: RvSipContentDispositionHeaderConstructInMsg() RvSipContentDispositionHeaderConstructInBodyPart() RvSipContentDispositionHeaderConstruct() RvSipContentDispositionHeaderCopy() RvSipContentDispositionHeaderEncode() RvSipContentDispositionHeaderParse() RvSipContentDispositionHeaderParseValue() RvSipContentDispositionHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipContentDispositionHeaderConstructInMsg() RvSipContentDispositionHeaderConstructInMsg() DESCRIPTION Constructs a Content-Disposition header inside a given message. SYNTAX RvStatus RvSipContentDispositionHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipContentDispositionHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipContentDispositionHeaderConstructInBodyPart() RvSipContentDispositionHeaderConstructInBodyPart() DESCRIPTION Constructs a Content-Disposition header inside a given message body part object. SYNTAX RvStatus RvSipContentDispositionHeaderConstructInBodyPart( IN RvSipBodyPartHandle OUT RvSipContentDispositionHeaderHandle* hBodyPart, hHeader); PARAMETERS hBodyPart The handle to the message body part object. hHeader The handle to the newly constructed Content-Disposition header.
Control Functions RvSipContentDispositionHeaderConstruct() RvSipContentDispositionHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Content-Disposition header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned.
Control Functions RvSipContentDispositionHeaderCopy() RvSipContentDispositionHeaderCopy() DESCRIPTION Copies all parameters from a source Content-Disposition header to a destination Content-Disposition header. You must construct the destination object before using this function.
Control Functions RvSipContentDispositionHeaderEncode() RvSipContentDispositionHeaderEncode() DESCRIPTION Encodes a Content-Disposition header to a textual Content-Deposition header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipContentDispositionHeaderParse() RvSipContentDispositionHeaderParse() DESCRIPTION Parses a SIP textual Content-Disposition header into a Content-Disposition header. For example, “Content-Disposition: signal; handling=optional”. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipContentDispositionHeaderParseValue() RvSipContentDispositionHeaderParseValue() DESCRIPTION Parses a SIP textual Content-Deposition header value into an ContentDisposition header. A SIP header has the following grammar: “headername:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object.
Control Functions RvSipContentDispositionHeaderFix() RvSipContentDispositionHeaderFix() DESCRIPTION Fixes a Content-Disposition header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS The Get and Set functions: RvSipContentDispositionHeaderGetStringLength() RvSipContentDispositionHeaderGetType() RvSipContentDispositionHeaderGetStrType() RvSipContentDispositionHeaderSetType() RvSipContentDispositionHeaderGetHandling() RvSipContentDispositionHeaderGetStrHandling() RvSipContentDispositionHeaderSetHandling() RvSipContentDispositionHeaderGetOtherParams() RvSipContentDispositionHeaderSetOtherParams() RvSipContentDispositionH
Get and Set Functions RvSipContentDispositionHeaderGetStringLength() RvSipContentDispositionHeaderGetStringLength() DESCRIPTION Some of the Content-Type header parameters are kept in a string format, for example, the handling string. To get such a parameter from the content-type header, your application should supply an adequate buffer to where the string will be copied.
Get and Set Functions RvSipContentDispositionHeaderGetType() RvSipContentDispositionHeaderGetType() DESCRIPTION Gets the disposition type enumeration value. If RVSIP_DISPOSITIONTYPE_OTHER is returned, you can receive the disposition type string using RvSipContentDispositionHeaderGetStrType(). SYNTAX RvSipDispositionType RvSipContentDispositionHeaderGetType( IN RvSipContentDispositionHeaderHandle hHeader); PARAMETERS hHeader The handle to the header.
Get and Set Functions RvSipContentDispositionHeaderGetStrType() RvSipContentDispositionHeaderGetStrType() DESCRIPTION Copies the disposition type string from the Content-Disposition header into a given buffer. Use this function when the disposition type enumeration returned by RvSipContentDispositionHeaderGetType() is RVSIP_DISPOSITIONTYPE_OTHER. If the value for bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipContentDispositionHeaderSetType() RvSipContentDispositionHeaderSetType() DESCRIPTION Sets the disposition type parameter in the Content-Disposition header. If the enumeration given by eDispType is RVSIP_DISPOSITIONTYPE_OTHER, this function sets the disposition type string given by strDispType in the ContentType header.
Get and Set Functions RvSipContentDispositionHeaderGetHandling() RvSipContentDispositionHeaderGetHandling() DESCRIPTION Gets the handling enumeration value. If RVSIP_DISPOSITIONHANDLING_OTHER is returned, you can receive the handling string using RvSipContentDispositionHeaderGetStrHandling(). SYNTAX RvSipDispositionHandling RvSipContentDispositionHeaderGetHandling( IN RvSipContentDispositionHeaderHandle PARAMETERS hHeader The handle to the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContentDispositionHeaderGetStrHandling() RvSipContentDispositionHeaderGetStrHandling() DESCRIPTION Copies the handling string from the Content-Disposition header into a given buffer. Use this function when the handling enumeration returned by RvSipContentDispositionHeaderGetHandling() is RVSIP_DISPOSITIONHANDLING_OTHER. If the values for bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipContentDispositionHeaderSetHandling() RvSipContentDispositionHeaderSetHandling() DESCRIPTION Sets the handling parameter in the content-disposition header. If the enumeration given by eHandling is RVSIP_DISPOSITIONHANDLING_OTHER, this function sets the handling string given by strHandling in the Content-Type header.
Get and Set Functions RvSipContentDispositionHeaderGetOtherParams() RvSipContentDispositionHeaderGetOtherParams() DESCRIPTION Not all the Content-Disposition header parameters have separated parameters in the content-disposition header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipContentDispositionHeaderGetOtherParams() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContentDispositionHeaderSetOtherParams() RvSipContentDispositionHeaderSetOtherParams() DESCRIPTION Not all the Content-Disposition header parameters have separated parameters in the content-disposition header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”. This function sets the other-params” parameter in the content-disposition header.
Get and Set Functions RvSipContentDispositionHeaderGetStrBadSyntax() RvSipContentDispositionHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string.
Get and Set Functions RvSipContentDispositionHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContentDispositionHeaderSetStrBadSyntax() RvSipContentDispositionHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
10 CONTENT-TYPE HEADER FUNCTIONS Content-Type header functions enable you to construct, copy, encode, parse, access and change Content-Type header parameters. This section contains Content-Type header functions found in the RvSipContentTypeHeader.h header file.
Control Functions CONTROL FUNCTIONS 368 The Control functions are: RvSipContentTypeHeaderConstructInBody() RvSipContentTypeHeaderConstruct() RvSipContentTypeHeaderCopy() RvSipContentTypeHeaderEncode() RvSipContentTypeHeaderParse() RvSipContentTypeHeaderParseValue() RvSipContentTypeHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipContentTypeHeaderConstructInBody() RvSipContentTypeHeaderConstructInBody() DESCRIPTION Constructs a Content-Type header inside a given body object. SYNTAX RvStatus RvSipContentTypeHeaderConstructInBody( IN RvSipBodyHandle hBody, OUT RvSipContentTypeHeaderHandle *phHeader); PARAMETERS hBody The handle to the body object. phHeader The handle to the newly constructed Content-Type header. RETURN VALUES Returns RvStatus.
Control Functions RvSipContentTypeHeaderConstruct() RvSipContentTypeHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Content-Type header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipContentTypeHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipContentTypeHeaderHandle hPage, *phHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipContentTypeHeaderCopy() RvSipContentTypeHeaderCopy() DESCRIPTION Copies all parameters from a source Content-Type header to a destination Content-Type header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipContentTypeHeaderCopy( INOUT RvSipContentTypeHeaderHandle hDestination, IN hSource); RvSipContentTypeHeaderHandle PARAMETERS hDestination The handle to the destination Content-Type header.
Control Functions RvSipContentTypeHeaderEncode() RvSipContentTypeHeaderEncode() DESCRIPTION Encodes a Content-Type header to a textual Content-Type header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipContentTypeHeaderParse() RvSipContentTypeHeaderParse() DESCRIPTION Parses a SIP textual Content-Type header into a Content-Type header. For example, “Content-Type: multipart/mixed; boundart=unique”. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipContentTypeHeaderParseValue() RvSipContentTypeHeaderParseValue() DESCRIPTION Parses a SIP textual Content-Type header value into a Content-Type header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipContentTypeHeaderFix() RvSipContentTypeHeaderFix() DESCRIPTION Fixes a Content-Type header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 376 The Get and Set functions are: RvSipContentTypeHeaderGetStringLength() RvSipContentTypeHeaderGetMediaType() RvSipContentTypeHeaderGetStrMediaType() RvSipContentTypeHeaderSetMediaType() RvSipContentTypeHeaderGetMediaSubType() RvSipContentTypeHeaderGetStrMediaSubType() RvSipContentTypeHeaderSetMediaSubType() RvSipContentTypeHeaderGetBoundary() RvSipContentTypeHeaderSetBoundary() RvSipContentTypeHeaderGetVersion() RvSipC
Get and Set Functions RvSipContentTypeHeaderGetStringLength() RvSipContentTypeHeaderGetStringLength() DESCRIPTION Some of the Content-Type header parameters are kept in a string format, such as the Content-Type header parameter boundary. In order to get such a parameter from the Content-Type header, your application should supply an adequate buffer to where the string will be copied.
Get and Set Functions RvSipContentTypeHeaderGetMediaType() RvSipContentTypeHeaderGetMediaType() DESCRIPTION Gets the media type enumeration value. If RVSIP_MEDIATYPE_OTHER is returned, you can receive the media type string using RvSipContentTypeHeaderGetStrMediaType(). SYNTAX RvSipMediaType RvSipContentTypeHeaderGetMediaType( IN RvSipContentTypeHeaderHandle hHeader); PARAMETERS hHeader The handle to the header. RETURN VALUES Returns the enumeration value of the SIP media type.
Get and Set Functions RvSipContentTypeHeaderGetStrMediaType() RvSipContentTypeHeaderGetStrMediaType() DESCRIPTION Copies the media-type string from the Content-Type header into a given buffer. Use this function when the media type enumeration returned by RvSipContentTypeHeaderGetMediaType() is RVSIP_MEDIATYPE_OTHER. If the value for bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipContentTypeHeaderSetMediaType() RvSipContentTypeHeaderSetMediaType() DESCRIPTION Sets the media-type parameter in the Content-Type header. If the enumeration given by eMediaType is RVSIP_MEDIATYPE_OTHER, sets the media type string given by strMediaType in the Content-Type header. Use RVSIP_MEDIATYPE_OTHER when the media type you wish to set to the Content-Type header does not have a matching enumeration value in the RvSipMediaType enumeration.
Get and Set Functions RvSipContentTypeHeaderGetMediaSubType() RvSipContentTypeHeaderGetMediaSubType() DESCRIPTION Gets the media-sub-type enumeration value. If RVSIP_MEDIASUBTYPE_OTHER is returned, you can receive the mediasub-type string using RvSipContentTypeHeaderGetStrMediaSubType(). SYNTAX RvSipMediaSubType RvSipContentTypeHeaderGetMediaSubType( IN RvSipContentTypeHeaderHandle hHeader); PARAMETERS hHeader The handle to the header.
Get and Set Functions RvSipContentTypeHeaderGetStrMediaSubType() RvSipContentTypeHeaderGetStrMediaSubType() DESCRIPTION Copies the media-sub-type string from the Content-Type header into a given buffer. Use this function when the media-sub-type enumeration returned by RvSipContentTypeHeaderGetMediaSubType() is RVSIP_MEDIASUBTYPE_OTHER. If the value for bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipContentTypeHeaderSetMediaSubType() RvSipContentTypeHeaderSetMediaSubType() DESCRIPTION Sets the media-sub-type parameter in the Content-Type header. If the enumeration given by eMediaSubType is RVSIP_MEDIASUBTYPE_OTHER, sets the media-sub-type string given by strMediaSubType in the Content-Type header. Use RVSIP_MEDIASUBTYPE_OTHER when the media type you wish to set to the Content-Type header does not have a matching enumeration value in the RvSipMediaSubType enumeration.
Get and Set Functions RvSipContentTypeHeaderGetBoundary() RvSipContentTypeHeaderGetBoundary() DESCRIPTION Copies the boundary string from the Content-Type header into a given buffer. If the value for bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipContentTypeHeaderSetBoundary() RvSipContentTypeHeaderSetBoundary() DESCRIPTION Sets the boundary string in the Content-Type header. The given string is copied to the Content-Type header. Note The given boundary may be quoted as defined in IETF RFC 2046. SYNTAX RvStatus RvSipContentTypeHeaderSetBoundary( IN RvSipContentTypeHeaderHandle hHeader, IN RvChar *boundary); PARAMETERS hHeader The handle to the header. boundary The boundary string to be set in the Content-Type header.
Get and Set Functions RvSipContentTypeHeaderGetVersion() RvSipContentTypeHeaderGetVersion() DESCRIPTION Copies the version string from the Content-Type header into a given buffer. If the value for bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipContentTypeHeaderSetVersion() RvSipContentTypeHeaderSetVersion() DESCRIPTION Sets the version string in the Content-Type header. The given string is copied to the Content-Type header. SYNTAX RvStatus RvSipContentTypeHeaderSetVersion( IN RvSipContentTypeHeaderHandle hHeader, IN RvChar *version); PARAMETERS hHeader The handle to the header. version The version string to be set in the Content-Type header. If NULL is supplied, the existing version is removed from the header.
Get and Set Functions RvSipContentTypeHeaderGetBase() RvSipContentTypeHeaderGetBase() DESCRIPTION Copies the base string from the Content-Type header into a given buffer. If the values for bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipContentTypeHeaderSetBase() RvSipContentTypeHeaderSetBase() DESCRIPTION Sets the base string in the Content-Type header. The given string is copied to the Content-Type header. SYNTAX RvStatus RvSipContentTypeHeaderSetBase( IN RvSipContentTypeHeaderHandle hHeader, IN RvChar *base); PARAMETERS hHeader The handle to the header. base The base string to be set in the Content-Type header. If NULL is supplied, the existing base is removed from the header.
Get and Set Functions RvSipContentTypeHeaderGetOtherParams() RvSipContentTypeHeaderGetOtherParams() DESCRIPTION Not all the Content-Type header parameters have separated parameters in the content-type header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”. This function copies the Content-Type header “other-params” parameter of the content-type header into a given buffer.
Get and Set Functions RvSipContentTypeHeaderGetOtherParams() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContentTypeHeaderSetOtherParams() RvSipContentTypeHeaderSetOtherParams() DESCRIPTION Not all the Content-Type header parameters have separated parameters in the content-type header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”. This function sets the “otherparams” parameter in the content-type header.
Get and Set Functions RvSipContentTypeHeaderGetStrBadSyntax() RvSipContentTypeHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipContentTypeHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContentTypeHeaderSetStrBadSyntax() RvSipContentTypeHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipContentTypeHeaderSetCompactForm() RvSipContentTypeHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipContentTypeHeaderSetCompactForm( IN RvSipContentTypeHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Content-Type header. bIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipContentTypeHeaderGetCompactForm() RvSipContentTypeHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the Content Type header. This flag tells the Stack whether or not to use the compact form Content-Type header during the header encoding. SYNTAX RvStatus RvSipPartyHeaderGetCompactForm( IN RvSipPartyHeaderHandle hHeader, IN RvBool *pbIsCompact); PARAMETERS hHeader The handle to the Party header. pbIsCompact Specifies whether or not to use compact form.
Get and Set Functions RvSipContentTypeHeaderGetCompactForm() 398 HP C SIP Stack Message Layer Reference Guide
11 CSEQ HEADER FUNCTIONS CSeq header functions enable you to construct, copy, encode, parse, access and change CSeq header parameters. This section contains CSeq header functions found in the RvSipCSeqHeader.h header file. CSEQ WORKING MODES The two working modes with the CSeq header utility functions are as follows: Signed numeric CSeq value, which means that the maximum numeric value of the CSeq is 2^31-1. Consequently, an uninitialized numeric CSeq value is represented by the (-1) value.
400 Get and Set Functions HP C SIP Stack Message Layer Reference Guide
Control Functions CONTROL FUNCTIONS The Control functions are: RvSipCSeqHeaderConstructInMsg() RvSipCSeqHeaderConstruct() RvSipCSeqHeaderConstructInRAckHeader() RvSipCSeqHeaderCopy() RvSipCSeqHeaderEncode() RvSipCSeqHeaderParse() RvSipCSeqHeaderParseValue() RvSipCSeqHeaderFix() CSeq Header Functions 401
Control Functions RvSipCSeqHeaderConstructInMsg() RvSipCSeqHeaderConstructInMsg() DESCRIPTION Constructs a CSeq header inside a given message. SYNTAX RvStatus RvSipCSeqHeaderConstructInMsg( IN RvSipMsgHandle OUT RvSipCSeqHeaderHandle hSipMsg, *hHeader); PARAMETERS hSipMsg The handle to the message related to the new header. hHeader The handle to the CSeq header. RETURN VALUES Returns RvStatus.
Control Functions RvSipCSeqHeaderConstruct() RvSipCSeqHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone CSeq header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipCSeqHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipCSeqHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipCSeqHeaderConstructInRAckHeader() RvSipCSeqHeaderConstructInRAckHeader() DESCRIPTION Constructs a CSeq header in a given RAck header. The header handle is returned. SYNTAX RvStatus RvSipCSeqHeaderConstructInRAckHeader( IN RvSipRAckHeaderHandle hHeader, OUT RvSipCSeqHeaderHandle *phCSeq) PARAMETERS hHeader The handle to the RAck header. phCSeq The handle to the newly constructed CSeq object. RETURN VALUES Returns RvStatus.
Control Functions RvSipCSeqHeaderCopy() RvSipCSeqHeaderCopy() DESCRIPTION Copies all parameters from a source CSeq header to a destination CSeq header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipCSeqHeaderCopy( INOUT RvSipCSeqHeaderHandle hDestination, IN hSource); RvSipCSeqHeaderHandle PARAMETERS hDestination The handle to the destination CSeq header. hSource The handle to the source CSeq header. RETURN VALUES Returns RvStatus.
Control Functions RvSipCSeqHeaderEncode() RvSipCSeqHeaderEncode() DESCRIPTION Encodes a CSeq header to a textual CSeq header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipCSeqHeaderEncode( IN RvSipCSeqHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hHeader The handle to the CSeq header.
Control Functions RvSipCSeqHeaderParse() RvSipCSeqHeaderParse() DESCRIPTION Parses a SIP textual CSeq header into a CSeq header. All the textual parameters are placed inside the object. For example, “CSeq: 1 INVITE”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipCSeqHeaderParseValue() RvSipCSeqHeaderParseValue() DESCRIPTION Parses a SIP textual CSeq header value into an CSeq header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipCSeqHeaderFix() RvSipCSeqHeaderFix() DESCRIPTION Fixes a CSeq header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Get and Set Functions GET AND SET FUNCTIONS 410 The Get and Set functions are: RvSipCSeqHeaderGetStringLength() RvSipCSeqHeaderGetStep() RvSipCSeqHeaderSetStep() RvSipCSeqHeaderGetMethodType() RvSipCSeqHeaderGetStrMethodType() RvSipCSeqHeaderSetMethodType() RvSipCSeqHeaderGetStrBadSyntax() RvSipCSeqHeaderSetStrBadSyntax() HP C SIP Stack Message Layer Reference Guide
Get and Set Functions RvSipCSeqHeaderGetStringLength() RvSipCSeqHeaderGetStringLength() DESCRIPTION Some of the CSeq header parameters are kept in a string format, for example, the CSeq header method. In order to get such a parameter from the CSeq header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipCSeqHeaderGetStep() RvSipCSeqHeaderGetStep() DESCRIPTION Gets the step value from the CSeq header. This function has two prototype definitions, according to the working mode that you choose. For more information, see CSeq Working Modes. SIGNED CSEQ MODE SYNTAX RvInt32 RvSipCSeqHeaderGetStep( IN RvSipCSeqHeaderHandle hHeader); PARAMETERS hHeader The handle to the CSeq header. RETURN VALUES Returns the step number value, or UNDEFINED if the step is not set.
Get and Set Functions RvSipCSeqHeaderSetStep() RvSipCSeqHeaderSetStep() DESCRIPTION Sets the CSeq step value in the CSeq header. SYNTAX RvStatus RvSipCSeqHeaderSetStep( IN RvSipCSeqHeaderHandle hHeader, IN RvInt32 step); PARAMETERS hHeader The handle to the CSeq header. step CSeq value to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipCSeqHeaderGetMethodType() RvSipCSeqHeaderGetMethodType() DESCRIPTION Gets the method type enumeration from the CSeq header. SYNTAX RvSipMethodType RvSipCSeqHeaderGetMethodType( IN RvSipCSeqHeaderHandle hHeader); PARAMETERS hHeader The handle to the CSeq header. RETURN VALUES Returns the method type enumeration from the CSeq header. REMARKS If this function returns RVSIP_METHOD_OTHER, call RvSipCSeqHeaderGetStrMethodType() to get the actual method in a string format.
Get and Set Functions RvSipCSeqHeaderGetStrMethodType() RvSipCSeqHeaderGetStrMethodType() DESCRIPTION Copies the method type string from the CSeq header into a given buffer. Use this function if RvSipCSeqHeaderGetMethodType() returns RVSIP_METHOD_OTHER. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipCSeqHeaderSetMethodType() RvSipCSeqHeaderSetMethodType() DESCRIPTION Sets the method type in the CSeq object. SYNTAX RvStatus RvSipCSeqHeaderSetMethodType( IN RvSipCSeqHeaderHandle hHeader, IN RvSipMethodType eMethodType, IN RvChar* strMethodType); PARAMETERS hHeader The handle to the CSeq header. eMethodType The method type to be set in the object. strMethodType You can use this parameter only if the eMethodType parameter is set to RVSIP_METHOD_OTHER.
Get and Set Functions RvSipCSeqHeaderGetStrBadSyntax() RvSipCSeqHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipCSeqHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipCSeqHeaderSetStrBadSyntax() RvSipCSeqHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipCSeqHeaderSetStrBadSyntax() 420 HP C SIP Stack Message Layer Reference Guide
12 DATE HEADER FUNCTIONS The Date header functions enable you to construct, destruct, copy, encode, parse, access and change Date header parameters. This section contains Date header functions found in the RvSipDateHeader.h header file.
Control Functions CONTROL FUNCTIONS 422 The Control functions are: RvSipDateHeaderConstructInMsg() RvSipDateConstructInExpiresHeader() RvSipDateConstructInRetryAfterHeader() RvSipDateHeaderConstruct() RvSipDateHeaderCopy() RvSipDateHeaderEncode() RvSipDateHeaderParse() RvSipDateHeaderParseValue() RvSipDateHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipDateHeaderConstructInMsg() RvSipDateHeaderConstructInMsg() DESCRIPTION Constructs a Date header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipDateHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipDateHeaderHandle* phHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipDateConstructInExpiresHeader() RvSipDateConstructInExpiresHeader() DESCRIPTION Constructs a Date header in a given Expires header. The header handle is returned. SYNTAX RvStatus RvSipDateConstructInExpiresHeader( IN RvSipExpiresHeaderHandle OUT RvSipDateHeaderHandle hHeader, *phDate); PARAMETERS hHeader The handle to the Expires header that relates to this date. phDate The handle to the newly constructed date object. RETURN VALUES Returns RvStatus.
Control Functions RvSipDateConstructInRetryAfterHeader() RvSipDateConstructInRetryAfterHeader() DESCRIPTION Constructs a Date header in a given Retry-After header. The header handle is returned. SYNTAX RvStatus RvSipDateConstructInRetryAfterHeader( IN RvSipRetryAfterHeaderHandle OUT RvSipDateHeaderHandle hHeader, *phDate); PARAMETERS hHeader The handle to the Retry-After header that relates to this date. phDate The handle to the newly constructed date object.
Control Functions RvSipDateHeaderConstruct() RvSipDateHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Date header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipDateHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipDateHeaderHandle* hPage, phHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipDateHeaderCopy() RvSipDateHeaderCopy() DESCRIPTION Copies all parameters from a source Date header to a destination Date header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipDateHeaderCopy( INOUT RvSipDateHeaderHandle hDestination, IN hSource); RvSipDateHeaderHandle PARAMETERS hDestination The handle to the destination Date header. hSource The handle to the source Date header. RETURN VALUES Returns RvStatus.
Control Functions RvSipDateHeaderEncode() RvSipDateHeaderEncode() DESCRIPTION Encodes a Date header to a textual Date header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipDateHeaderEncode( IN RvSipDateHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* phPage, OUT RvUint32* pLength); PARAMETERS hHeader The handle to the Date header.
Control Functions RvSipDateHeaderParse() RvSipDateHeaderParse() DESCRIPTION Parses a SIP textual Date header into a Date header. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipDateHeaderParseValue() RvSipDateHeaderParseValue() DESCRIPTION Parses a SIP textual Date header value into an Date header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipDateHeaderFix() RvSipDateHeaderFix() DESCRIPTION Fixes a Date header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Get and Set Functions GET AND SET FUNCTIONS 432 The Get and Set functions are: RvSipDateHeaderGetWeekDay() RvSipDateHeaderSetWeekDay() RvSipDateHeaderGetDay() RvSipDateHeaderSetDay() RvSipDateHeaderGetMonth() RvSipDateHeaderSetMonth() RvSipDateHeaderGetYear() RvSipDateHeaderSetYear() RvSipDateHeaderGetHour() RvSipDateHeaderSetHour() RvSipDateHeaderGetMinute() RvSipDateHeaderSetMinute() RvSipDateHeaderGetSecond() RvSipDateHeaderSetSecond() RvSipDateHeaderGetStringLength
Get and Set Functions RvSipDateHeaderGetWeekDay() RvSipDateHeaderGetWeekDay() DESCRIPTION Gets the week-day enumeration. RVSIP_WEEKDAY_UNDEFINED is returned if the weekday is not set. SYNTAX RvSipDateWeekDay RvSipDateHeaderGetWeekDay( IN RvSipDateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Date header. RETURN VALUES The enumeration of the week day.
Get and Set Functions RvSipDateHeaderSetWeekDay() RvSipDateHeaderSetWeekDay() DESCRIPTION Sets the week-day parameter in the Date header. SYNTAX RvStatus RvSipDateHeaderSetWeekDay( IN RvSipDateHeaderHandle hHeader, IN RvSipDateWeekDay eWeekDay); PARAMETERS hHeader The handle to the Date header. eWeekDay The week-day enumeration. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipDateHeaderGetDay() RvSipDateHeaderGetDay() DESCRIPTION Gets the number for the day of the month in the given Date header. SYNTAX RvInt8 RvSipDateHeaderGetDay( IN RvSipDateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Date header. RETURN VALUES Returns the day number. If the integer number for the day of the month is not set, UNDEFINED is returned.
Get and Set Functions RvSipDateHeaderSetDay() RvSipDateHeaderSetDay() DESCRIPTION Sets the number for the day of the month parameter of the Date header. SYNTAX RvStatus RvSipDateHeaderSetDay( IN RvSipDateHeaderHandle hHeader, IN RvInt8 day); PARAMETERS hHeader The handle to the Date header. day The day number. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipDateHeaderGetMonth() RvSipDateHeaderGetMonth() DESCRIPTION Gets the month enumeration of the given Date header. RVSIP_MONTH_UNDEFINED is returned if the month parameter is not set. SYNTAX RvSipDateMonth RvSipDateHeaderGetMonth( IN RvSipDateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Date header. RETURN VALUES Returns the month enumeration.
Get and Set Functions RvSipDateHeaderSetMonth() RvSipDateHeaderSetMonth() DESCRIPTION Sets the month parameter of the Date header. SYNTAX RvStatus RvSipDateHeaderSetMonth( IN RvSipDateHeaderHandle hHeader, IN RvSipDateMonth eMonth); PARAMETERS hHeader The handle to the Date header. eMonth The month enumeration. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipDateHeaderGetYear() RvSipDateHeaderGetYear() DESCRIPTION Gets the year of the given Date header. SYNTAX RvInt16 RvSipDateHeaderGetYear( IN RvSipDateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Date header. RETURN VALUES Returns the year number. If the year parameter is not set, UNDEFINED is returned.
Get and Set Functions RvSipDateHeaderSetYear() RvSipDateHeaderSetYear() DESCRIPTION Sets the year number parameter of the Date header. SYNTAX RvStatus RvSipDateHeaderSetYear( IN RvSipDateHeaderHandle hHeader, IN RvInt16 year); PARAMETERS hHeader The handle to the Date header. year The year number. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipDateHeaderGetHour() RvSipDateHeaderGetHour() DESCRIPTION Gets the hour of the given Date header. SYNTAX RvInt8 RvSipDateHeaderGetHour( IN RvSipDateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Date header. RETURN VALUES Returns the hour number. If the hour parameter is not set, UNDEFINED is returned.
Get and Set Functions RvSipDateHeaderSetHour() RvSipDateHeaderSetHour() DESCRIPTION Sets the hour number parameter of the Date header. SYNTAX RvStatus RvSipDateHeaderSetHour( IN RvSipDateHeaderHandle hHeader, IN RvInt8 hour); PARAMETERS hHeader The handle to the Date header. hour The hour number. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipDateHeaderGetMinute() RvSipDateHeaderGetMinute() DESCRIPTION Gets the minute of the given Date header. SYNTAX RvInt8 RvSipDateHeaderGetMinute( IN RvSipDateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Date header. RETURN VALUES Returns the minute number. If the minute parameter is not set, UNDEFINED is returned.
Get and Set Functions RvSipDateHeaderSetMinute() RvSipDateHeaderSetMinute() DESCRIPTION Sets the minute number parameter of the Date header. SYNTAX RvStatus RvSipDateHeaderSetMinute( IN RvSipDateHeaderHandle hHeader, IN RvInt8 minute); PARAMETERS hHeader The handle to the Date header. minute The minute number. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipDateHeaderGetSecond() RvSipDateHeaderGetSecond() DESCRIPTION Gets the second number of the given Date header. SYNTAX RvInt8 RvSipDateHeaderGetSecond( IN RvSipDateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Date header. RETURN VALUES Returns the second number. If the second parameter is not set, UNDEFINED is returned.
Get and Set Functions RvSipDateHeaderSetSecond() RvSipDateHeaderSetSecond() DESCRIPTION Sets the second number parameter of the Date header. SYNTAX RvStatus RvSipDateHeaderSetSecond( IN RvSipDateHeaderHandle hHeader, IN RvInt8 second); PARAMETERS hHeader The handle to the Date header. second The second number. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipDateHeaderGetStringLength() RvSipDateHeaderGetStringLength() DESCRIPTION Some of the Date header parameters are kept in a string format. In order to get such a parameter from the Date header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipDateHeaderGetStrBadSyntax() RvSipDateHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name: header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipDateHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipDateHeaderSetStrBadSyntax() RvSipDateHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
13 EVENT HEADER FUNCTIONS The Event header functions enable you to construct, copy, encode, parse, access and change Event header parameters. This section contains Event header functions found in the RvSipEventHeader.h header file.
Control Functions CONTROL FUNCTIONS 452 The Control functions are: RvSipEventHeaderConstructInMsg() RvSipEventHeaderConstruct() RvSipEventHeaderCopy() RvSipEventHeaderEncode() RvSipEventHeaderParse() RvSipEventHeaderParseValue() RvSipEventHeaderFix() RvSipEventHeaderIsEqual() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipEventHeaderConstructInMsg() RvSipEventHeaderConstructInMsg() DESCRIPTION Constructs an Event header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipEventHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipEventHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipEventHeaderConstruct() RvSipEventHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Event header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipEventHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipEventHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipEventHeaderCopy() RvSipEventHeaderCopy() DESCRIPTION Copies all parameters from a source Event header to a destination Event header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipEventHeaderCopy( INOUT RvSipEventHeaderHandle hDestination, IN hSource); RvSipEventHeaderHandle PARAMETERS hDestination The handle to the destination Event header. hSource The handle to the source Event header. RETURN VALUES Returns RvStatus.
Control Functions RvSipEventHeaderEncode() RvSipEventHeaderEncode() DESCRIPTION Encodes an Event header to a textual Event header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatusRvSipEventHeaderEncode( IN RvSipEventHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hHeader The handle to the Event header.
Control Functions RvSipEventHeaderParse() RvSipEventHeaderParse() DESCRIPTION Parses a SIP textual Event header into an Event header. An example of a SIP textual Event header is: “Event: event-package.event-template;id=5;event-param=param-val”. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipEventHeaderParseValue() RvSipEventHeaderParseValue() DESCRIPTION Parses a SIP textual Event header value into an Event header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipEventHeaderFix() RvSipEventHeaderFix() DESCRIPTION Fixes an Event header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Control Functions RvSipEventHeaderIsEqual() RvSipEventHeaderIsEqual() DESCRIPTION Compares two Event headers. Event headers are considered equal if the eventtype and event ID parameter are equal. The event-type portion of the Event header is compared byte-by-byte, and the ID parameter token (if present) is compared byte-by-byte. An Event header containing an ID parameter never matches an Event header without an ID parameter. No other-parameters are considered when performing a comparison.
Get and Set Functions GET AND SET FUNCTIONS The Get and Set functions are: RvSipEventHeaderGetStringLength() RvSipEventHeaderGetRpoolString() RvSipEventHeaderSetRpoolString() RvSipEventHeaderGetEventPackage() RvSipEventHeaderSetEventPackage() RvSipEventHeaderGetEventTemplate() RvSipEventHeaderSetEventTemplate() RvSipEventHeaderGetEventParam() RvSipEventHeaderSetEventParam() RvSipEventHeaderGetEventId() RvSipEventHeaderSetEventId() RvSipEventHeaderGetStrBadSyntax() RvSipEven
Get and Set Functions RvSipEventHeaderGetStringLength() RvSipEventHeaderGetStringLength() DESCRIPTION Some of the Event header parameters are kept in a string format, for example, the Event header “other-params”. In order to get such a parameter from the Event header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipEventHeaderGetRpoolString() RvSipEventHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Event header into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipEventHeaderGetRpoolString( IN RvSipEventHeaderHandle hSipEventHeader, IN RvSipEventHeaderStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipEventHeader The handle to the Event header. eStringName The string the user wishes to get.
Get and Set Functions RvSipEventHeaderSetRpoolString() RvSipEventHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Event header. The given string is located in an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipEventHeaderSetRpoolString( IN RvSipEventHeaderHandle hSipEventHeader, IN RvSipEventHeaderStringName eStringName, IN RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipEventHeader The handle to the Event header. eStringName The string the user wishes to set.
Get and Set Functions RvSipEventHeaderGetEventPackage() RvSipEventHeaderGetEventPackage() DESCRIPTION Copies the event-package string from the Event header into a given buffer. If bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipEventHeaderSetEventPackage() RvSipEventHeaderSetEventPackage() DESCRIPTION Sets the event-package parameter in the Event header. SYNTAX RvStatus RvSipEventHeaderSetEventPackage( IN RvSipEventHeaderHandle hHeader, IN RvChar *strPackage); PARAMETERS hHeader The handle to the Event header. strPackage The event-package string to be set in the Event header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipEventHeaderGetEventTemplate() RvSipEventHeaderGetEventTemplate() DESCRIPTION Copies the event-template string from the Event header into a given buffer. If bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipEventHeaderSetEventTemplate() RvSipEventHeaderSetEventTemplate() DESCRIPTION Sets the event-template parameter in the Event header. SYNTAX RvStatus RvSipEventHeaderSetEventTemplate( IN RvSipEventHeaderHandle hHeader, IN RvChar *strTemplate); PARAMETERS hHeader The handle to the Event header. strPackage The event-template string to be set in the Event header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipEventHeaderGetEventParam() RvSipEventHeaderGetEventParam() DESCRIPTION Copies the event-param string from the Event header into a given buffer. If bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipEventHeaderSetEventParam() RvSipEventHeaderSetEventParam() DESCRIPTION Sets the event-param parameter in the Event header. SYNTAX RvStatus RvSipEventHeaderSetEventParam( IN RvSipEventHeaderHandle hHeader, IN RvChar strEventParam); PARAMETERS hHeader The handle to the Event header. strEventParam The event-param string to be set in the Event header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipEventHeaderGetEventId() RvSipEventHeaderGetEventId() DESCRIPTION Copies the event-id string from the Event header into a given buffer. If bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipEventHeaderSetEventId() RvSipEventHeaderSetEventId() DESCRIPTION Sets the event-id parameter in the Event header. SYNTAX RvStatus RvSipEventHeaderSetEventId( IN RvSipEventHeaderHandle hHeader, IN RvChar *strId); PARAMETERS hHeader The handle to the Event header. strId The event-id string to be set in the Event header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipEventHeaderGetStrBadSyntax() RvSipEventHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipEventHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipEventHeaderSetStrBadSyntax() RvSipEventHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipEventHeaderSetCompactForm() RvSipEventHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipEventHeaderSetCompactForm( IN RvSipEventHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Event header. bIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipEventHeaderGetCompactForm() RvSipEventHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the Event header. SYNTAX RvStatus RvSipEventHeaderGetCompactForm ( IN RvSipEventHeaderHandle hHeader, IN RvBool *pbIsCompact); PARAMETERS hHeader The handle to the Event header. pbIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipEventHeaderGetCompactForm() 478 HP C SIP Stack Message Layer Reference Guide
14 EXPIRES HEADER FUNCTIONS The Expires header functions enable you to construct, copy, encode, parse, access and change Expires header parameters. This section contains Expires header functions found in the RvSipExpiresHeader.h header file.
Control Functions CONTROL FUNCTIONS 480 The Control functions are: RvSipExpiresHeaderConstructInMsg() RvSipExpiresConstructInContactHeader() RvSipExpiresHeaderConstruct() RvSipExpiresHeaderCopy() RvSipExpiresHeaderEncode() RvSipExpiresHeaderParse() RvSipExpiresHeaderParseValue() RvSipExpiresHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipExpiresHeaderConstructInMsg() RvSipExpiresHeaderConstructInMsg() DESCRIPTION Constructs a Expires header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipExpiresHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipExpiresHeaderHandle* phHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipExpiresConstructInContactHeader() RvSipExpiresConstructInContactHeader() DESCRIPTION Constructs an expires object inside a given Contact header. The header handle is returned. SYNTAX RvStatus RvSipExpiresConstructInContactHeader( IN RvSipContactHeaderHandle OUT RvSipExpiresHeaderHandle hHeader, *phExpires); PARAMETERS hHeader The handle to the Contact header that relates to this expires object. phExpires The handle to the newly constructed expires object.
Control Functions RvSipExpiresHeaderConstruct() RvSipExpiresHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Expires header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipExpiresHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipExpiresHeaderHandle* hPage, phHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipExpiresHeaderCopy() RvSipExpiresHeaderCopy() DESCRIPTION Copies all parameters from a source Expires header to a destination Expires header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipExpiresHeaderCopy( INOUT RvSipExpiresHeaderHandle hDestination, IN hSource); RvSipExpiresHeaderHandle PARAMETERS hDestination The handle to the destination Expires header. hSource The handle to the source Expires header.
Control Functions RvSipExpiresHeaderEncode() RvSipExpiresHeaderEncode() DESCRIPTION Encodes a Expires header to a textual Expires header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipExpiresHeaderEncode( IN RvSipExpiresHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* phPage, OUT RvUint32* pLength); PARAMETERS hHeader The handle to the Expires header.
Control Functions RvSipExpiresHeaderParse() RvSipExpiresHeaderParse() DESCRIPTION Parses a SIP textual Expires header into a Expires header. All the textual parameters are placed inside the object. For example, “Expires: Thu, 01 Dec 2040 16:00:00 GMT”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipExpiresHeaderParseValue() RvSipExpiresHeaderParseValue() DESCRIPTION Parses a SIP textual Expires header value into an Expires header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipExpiresHeaderFix() RvSipExpiresHeaderFix() DESCRIPTION Fixes an Expires header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS The Get and Set functions are: RvSipExpiresHeaderGetFormat() RvSipExpiresHeaderGetDeltaSeconds() RvSipExpiresHeaderSetDeltaSeconds() RvSipExpiresHeaderGetDateHandle() RvSipExpiresHeaderSetDateHandle() RvSipExpiresHeaderGetStringLength() RvSipExpiresHeaderGetStrBadSyntax() RvSipExpiresHeaderSetStrBadSyntax() Expires Header Functions 489
Get and Set Functions RvSipExpiresHeaderGetFormat() RvSipExpiresHeaderGetFormat() DESCRIPTION Gets the format of the Expires header: Undefined, Date or Delta-seconds. SYNTAX RvSipExpiresFormat RvSipExpiresHeaderGetFormat( IN RvSipExpiresHeaderHandle PARAMETERS hHeader The handle to the Expires header. RETURN VALUES The format enumeration.
Get and Set Functions RvSipExpiresHeaderGetDeltaSeconds() RvSipExpiresHeaderGetDeltaSeconds() DESCRIPTION Gets the delta-seconds integer of the Expires header. If the delta-seconds integer is not set, UNDEFINED is returned. SYNTAX RvStatus RvSipExpiresHeaderGetDeltaSeconds( IN RvSipExpiresHeaderHandle OUT RvUint32 hHeader, *pDeltaSeconds); PARAMETERS hHeader The handle to the Expires header. pDeltaSeconds The delta-seconds integer. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipExpiresHeaderSetDeltaSeconds() RvSipExpiresHeaderSetDeltaSeconds() DESCRIPTION Sets the delta seconds integer of the Expires header. Changes the Expires format to delta-seconds. If the given delta-seconds is UNDEFINED, the delta-seconds of the Expires header is removed and the format is changed to UNDEFINED. SYNTAX RvStatus RvSipExpiresHeaderSetDeltaSeconds( IN RvSipExpiresHeaderHandle hHeader, IN RvUint32 deltaSeconds); PARAMETERS hHeader The handle to the Expires header.
Get and Set Functions RvSipExpiresHeaderGetDateHandle() RvSipExpiresHeaderGetDateHandle() DESCRIPTION Gets the date handle to the Expires header. SYNTAX RvSipDateHeaderHandle RvSipExpiresHeaderGetDateHandle( IN RvSipExpiresHeaderHandle hHeader); PARAMETERS hHeader The handle to the Expires header. RETURN VALUES Returns the handle to the Date header, or NULL if the Date header does not exist.
Get and Set Functions RvSipExpiresHeaderSetDateHandle() RvSipExpiresHeaderSetDateHandle() DESCRIPTION Sets a new Date header in the Expires header and changes the Expires format to date. SYNTAX RvStatus RvSipExpiresHeaderSetDateHandle( IN RvSipExpiresHeaderHandle hHeader, IN RvSipDateHeaderHandle hDate); PARAMETERS hHeader The handle to the Expires header. hDate The date handle to be set to the Expires header. If the date handle is NULL, the existing Date header is removed from the Expires header.
Get and Set Functions RvSipExpiresHeaderGetStringLength() RvSipExpiresHeaderGetStringLength() DESCRIPTION Some of the Expires header parameters are kept in a string format. In order to get such a parameter from the Expires header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to let you allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipExpiresHeaderGetStrBadSyntax() RvSipExpiresHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipExpiresHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipExpiresHeaderSetStrBadSyntax() RvSipExpiresHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
15 MIN-SE HEADER FUNCTIONS The Min-SE header functions enable you to construct, copy, encode, parse, access and change Min-SE header parameters. This section contains Min-SE header functions found in the RvSipMin-SEHeader.h header file.
Control Functions CONTROL FUNCTIONS 500 The Control functions are: RvSipMinSEHeaderConstructInMsg() RvSipMinSEHeaderConstruct() RvSipMinSEHeaderCopy() RvSipMinSEHeaderEncode() RvSipMinSEHeaderParse() RvSipMinSEHeaderParseValue() RvSipMinSEHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipMinSEHeaderConstructInMsg() RvSipMinSEHeaderConstructInMsg() DESCRIPTION Constructs a Min-SE header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipMinSEHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipMinSEHeaderHandle* phHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipMinSEHeaderConstruct() RvSipMinSEHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Min-SE header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipMinSEHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipMinSEHeaderHandle* hPage, phHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipMinSEHeaderCopy() RvSipMinSEHeaderCopy() DESCRIPTION Copies all parameters from a source Min-SE header to a destination Min-SE header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipMinSEHeaderCopy( INOUT RvSipMinSEHeaderHandle IN RvSipMinSEHeaderHandle hDestination, hSource); PARAMETERS pDestination The handle to the destination Min-SE header. pSource The handle to the source Min-SE header. RETURN VALUES Returns RvStatus.
Control Functions RvSipMinSEHeaderEncode() RvSipMinSEHeaderEncode() DESCRIPTION Encodes a Min-SE header to a textual Min-SE header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). The application must free the allocated page, using RPOOL_FreePage(). The allocated page must be freed only if this function returns RV_OK.
Control Functions RvSipMinSEHeaderParse() RvSipMinSEHeaderParse() DESCRIPTION Parses a SIP textual Min-SE header into a Min-SE header. An example of a SIP textual Min-SE header is “Min-SE: 3600”. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipMinSEHeaderParseValue() RvSipMinSEHeaderParseValue() DESCRIPTION Parses a SIP textual Min-SE header value into an Min-SE header. A SIP header has the following grammer: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipMinSEHeaderFix() RvSipMinSEHeaderFix() DESCRIPTION Fixes a Min-SE header with bad-syntax information. A SIP header has the following grammer: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Get and Set Functions GET AND SET FUNCTIONS 508 The Get and Set functions are: RvSipMinSEHeaderGetDeltaSeconds() RvSipMinSEHeaderSetDeltaSeconds() RvSipMinSEHeaderGetOtherParams() RvSipMinSEHeaderSetOtherParams() RvSipMinSEHeaderGetStringLength() RvSipMinSEHeaderGetStrBadSyntax() RvSipMinSEHeaderSetStrBadSyntax() HP C SIP Stack Message Layer Reference Guide
Get and Set Functions RvSipMinSEHeaderGetDeltaSeconds() RvSipMinSEHeaderGetDeltaSeconds() DESCRIPTION Gets the delta-seconds integer of the Min-SE header. If the delta-seconds integer is not set, UNDEFINED is returned. SYNTAX RvStatus RvSipMinSEHeaderGetDeltaSeconds( IN RvSipMinSEHeaderHandle OUT RvInt32 hHeader, *pDeltaSeconds); PARAMETERS hHeader The handle to the Min-SE header. pDeltaSeconds The delta-seconds integer. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMinSEHeaderSetDeltaSeconds() RvSipMinSEHeaderSetDeltaSeconds() DESCRIPTION Sets the delta seconds integer of the Min-SE header. If the given delta-seconds is UNDEFINED, the delta-seconds of the Min-SE header is removed SYNTAX RvStatus RvSipMinSEHeaderSetDeltaSeconds( IN RvSipMinSEHeaderHandle hHeader, IN RvInt32 deltaSeconds); PARAMETERS hHeader The handle to the Min-SE header. deltaSeconds The delta-seconds to be set to the Min-SE header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMinSEHeaderGetOtherParams() RvSipMinSEHeaderGetOtherParams() DESCRIPTION Copies the other-params string from the Min-SE header into a given buffer. Not all the Content-Type header parameters have separated parameters in the Content-Type header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipMinSEHeaderSetOtherParams() RvSipMinSEHeaderSetOtherParams() DESCRIPTION Sets the other-params string in the Min-SE header. The given string is copied to the Min-SE header. Not all the Min-SE header parameters have separated parameters in the Min-SE header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipMinSEHeaderGetStringLength() RvSipMinSEHeaderGetStringLength() DESCRIPTION The other-parameters of Min-SE header parameters are kept in a string format. In order to get such a parameter from the Min-SE header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enables you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipMinSEHeaderGetStrBadSyntax() RvSipMinSEHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammer: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipMinSEHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipMinSEHeaderSetStrBadSyntax() RvSipMinSEHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammer: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
16 OTHER HEADER FUNCTIONS Other header functions enable you to construct, copy, encode, parse, access and change Other header parameters. Other headers should be used for every header that has no specific object in the message API. for example, a supported header can be held in an Other header. This section contains the Other header functions included in the RvSipOtherHeader.h header file.
Control Functions CONTROL FUNCTIONS 518 The Control functions are: RvSipOtherHeaderConstructInMsg() RvSipOtherHeaderConstructInBodyPart() RvSipOtherHeaderConstruct() RvSipOtherHeaderCopy() RvSipOtherHeaderEncode() RvSipOtherHeaderParse() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipOtherHeaderConstructInMsg() RvSipOtherHeaderConstructInMsg() DESCRIPTION Constructs an Other header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipOtherHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipOtherHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipOtherHeaderConstructInBodyPart() RvSipOtherHeaderConstructInBodyPart() DESCRIPTION Constructs an Other header inside a given message body part object. The header is kept in the Other headers list of the message body part object. You can choose to insert the header either at the head or tail of the list.
Control Functions RvSipOtherHeaderConstruct() RvSipOtherHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Other header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipOtherHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipOtherHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipOtherHeaderCopy() RvSipOtherHeaderCopy() DESCRIPTION Copies all parameters from a source Other header to a destination Other header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipOtherHeaderCopy( INOUT RvSipOtherHeaderHandle hDestination, IN hSource); RvSipOtherHeaderHandle PARAMETERS hDestination The handle to the destination Other header. hSource The handle to the source Other header. RETURN VALUES Returns RvStatus.
Control Functions RvSipOtherHeaderEncode() RvSipOtherHeaderEncode() DESCRIPTION Encodes a Contact header to a textual Other header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipOtherHeaderEncode( IN RvSipOtherHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hHeader The handle to the Other header.
Control Functions RvSipOtherHeaderParse() RvSipOtherHeaderParse() DESCRIPTION Parses a SIP textual Other header into a Other header. All the textual parameters are placed inside the object. For example, “Content–Disposition: session”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Get and Set Functions GET AND SET FUNCTIONS The Get and Set functions are: RvSipOtherHeaderGetStringLength() RvSipOtherHeaderGetName() RvSipOtherHeaderSetName() RvSipOtherHeaderGetValue() RvSipOtherHeaderSetValue() RvSipOtherHeaderGetRpoolString() RvSipOtherHeaderSetRpoolString() RvSipOtherHeaderGetStrBadSyntax() RvSipOtherHeaderSetStrBadSyntax() Other Header Functions 525
Get and Set Functions RvSipOtherHeaderGetStringLength() RvSipOtherHeaderGetStringLength() DESCRIPTION Some of the Other header parameters are kept in a string format, for example, the Other header display name. In order to get such a parameter from the Other header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipOtherHeaderGetName() RvSipOtherHeaderGetName() DESCRIPTION Copies the name of the Other header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipOtherHeaderSetName() RvSipOtherHeaderSetName() DESCRIPTION Sets the name of the header. SYNTAX RvStatus RvSipOtherHeaderSetName( IN RvSipOtherHeaderhandle hHeader, IN RvChar* strName); PARAMETERS hHeader The handle of the Other header. strName The name of the header to be set in the Other header. If NULL is supplied, the existing header name is removed. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipOtherHeaderGetValue() RvSipOtherHeaderGetValue() DESCRIPTION Copies the value of the Other header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipOtherHeaderSetValue() RvSipOtherHeaderSetValue() DESCRIPTION Sets the value of the header. SYNTAX RvStatus RvSipOtherHeaderSetValue( IN RvSipOtherHeaderHandle hHeader, IN RvChar* strValue); PARAMETERS hHeader The handle of the Other header. strValue The header value to be set in the Other header. If NULL is supplied, the existing header value is removed. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipOtherHeaderGetRpoolString() RvSipOtherHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Other header into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipOtherHeaderGetRpoolString( IN RvSipOtherHeaderHandle hSipOtherHeader, IN RvSipOtherHeaderStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipOtherHeader The handle to the Other header. eStringName The string the user wishes to get.
Get and Set Functions RvSipOtherHeaderSetRpoolString() RvSipOtherHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Other header. The given string is located on an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipOtherHeaderSetRpoolString( IN RvSipOtherHeaderHandle hSipOtherHeader, IN RvSipOtherHeaderStringName eStringName, IN RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipOtherHeader The handle to the Other header. eStringName The string the user wishes to set.
Get and Set Functions RvSipOtherHeaderGetStrBadSyntax() RvSipOtherHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipOtherHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipOtherHeaderSetStrBadSyntax() RvSipOtherHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipOtherHeaderSetStrBadSyntax() 536 HP C SIP Stack Message Layer Reference Guide
17 PARTY HEADER FUNCTIONS The Party header functions enable you to construct, copy, encode, parse and access Party header parameters. This section contains Party header functions, for To/From headers, found in the RvSipPartyHeader.h header file.
Control Functions CONTROL FUNCTIONS 538 The Control functions are: RvSipToHeaderConstructInMsg() RvSipFromHeaderConstructInMsg() RvSipPartyHeaderConstruct() RvSipPartyHeaderCopy() RvSipPartyHeaderEncode() RvSipPartyHeaderParse() RvSipPartyHeaderParseValue() RvSipPartyHeaderFix() RvSipPartyIsEqual() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipToHeaderConstructInMsg() RvSipToHeaderConstructInMsg() DESCRIPTION Constructs a To Party header inside a given message. SYNTAX RvStatus RvSipToHeaderConstructInMsg( IN RvSipMsgHandle OUT RvSipPartyHeaderHandle* hSipMsg, hHeader); PARAMETERS hSipMsg The handle to the message. hHeader The handle to the newly constructed To Party header. RETURN VALUES Returns RvStatus.
Control Functions RvSipFromHeaderConstructInMsg() RvSipFromHeaderConstructInMsg() DESCRIPTION Constructs a From Party header inside a given message. SYNTAX RvStatus RvSipFromHeaderConstructInMsg( IN RvSipMsgHandle OUT RvSipPartyHeaderHandle* hSipMsg, hHeader); PARAMETERS hSipMsg The handle to the message. hHeader The handle to the newly constructed From Party header. RETURN VALUES Returns RvStatus.
Control Functions RvSipPartyHeaderConstruct() RvSipPartyHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Party header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipPartyHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipPartyHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipPartyHeaderCopy() RvSipPartyHeaderCopy() DESCRIPTION Copies all parameters from a source Party header to a destination Party header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipPartyHeaderCopy( INOUT RvSipPartyHeaderHandle hDestination, IN hSource); RvSipPartyHeaderHandle PARAMETERS hDestination The handle to the destination Party header. hSource The handle to the source Party header. RETURN VALUES Returns RvStatus.
Control Functions RvSipPartyHeaderEncode() RvSipPartyHeaderEncode() DESCRIPTION Encodes a Party header to a textual Party header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipPartyHeaderEncode( IN RvSipPartyHeaderHandle hHeader, IN HRPOOL hPool, IN RvBool bIsTo, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hHeader The handle to the Contact header.
Control Functions RvSipPartyHeaderEncode() REMARKS The application must free the allocated page, using RPOOL_FreePage(). The allocated page must be freed only if this function returns RV_OK.
Control Functions RvSipPartyHeaderParse() RvSipPartyHeaderParse() DESCRIPTION Parses a SIP textual Party header into a Party header. All the textual parameters are placed inside the object. For example, “From: ;tag=5”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipPartyHeaderParseValue() RvSipPartyHeaderParseValue() DESCRIPTION Parses a SIP textual Party header value into an Party header. A SIP header has the following grammar “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipPartyHeaderParseValue() RETURN VALUES Returns RvStatus.
Control Functions RvSipPartyHeaderFix() RvSipPartyHeaderFix() DESCRIPTION Fixes a Party header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Control Functions RvSipPartyIsEqual() RvSipPartyIsEqual() DESCRIPTION Compares two Party headers. Party header parameters are considered equal if their URIs match and their header parameters match in name and value. Parameters names and token parameter values are compared ignoring case while quoted-string parameter values are case-sensitive. The tag comparison is performed if both header parameters have a tag value.
Get and Set Functions GET AND SET FUNCTIONS 550 The Get and Set functions are: RvSipPartyHeaderGetStringLength() RvSipPartyHeaderGetTag() RvSipPartyHeaderSetTag() RvSipPartyHeaderGetDisplayName() RvSipPartyHeaderSetDisplayName() RvSipPartyHeaderGetAddrSpec() RvSipPartyHeaderSetAddrSpec() RvSipPartyHeaderGetOtherParams() RvSipPartyHeaderSetOtherParams() RvSipPartyHeaderGetType() RvSipPartyHeaderSetType() RvSipPartyHeaderGetRpoolString() RvSipPartyHeaderSetRpoolString()
Get and Set Functions RvSipPartyHeaderGetStringLength() RvSipPartyHeaderGetStringLength() DESCRIPTION Some of the Party header parameters are kept in a string format, for example, the Party header display name. In order to get such a parameter from the Party header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipPartyHeaderGetTag() RvSipPartyHeaderGetTag() DESCRIPTION Copies the tag parameter of the Party header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipPartyHeaderSetTag() RvSipPartyHeaderSetTag() DESCRIPTION Sets the tag parameter in the Party header. SYNTAX RvStatus RvSipPartyHeaderSetTag( IN RvSipPartyHeaderHandle hHeader, IN RvChar* strTag); PARAMETERS hHeader The handle to the Party header strTag The Tag parameter to be set in the Party header. If NULL is supplied, the existing display name is removed from the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipPartyHeaderGetDisplayName() RvSipPartyHeaderGetDisplayName() DESCRIPTION Copies the display name from the Party header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipPartyHeaderSetDisplayName() RvSipPartyHeaderSetDisplayName() DESCRIPTION Sets the display name in the Party header. SYNTAX RvStatus RvSipPartyHeaderSetDisplayName( IN RvSipPartyHeaderHandle hHeader, IN RvChar* strDisplayName); PARAMETERS hHeader The handle to the header. strDisplayName The display name to be set in the Party header. If NULL is supplied, the existing display name is removed from the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipPartyHeaderGetAddrSpec() RvSipPartyHeaderGetAddrSpec() DESCRIPTION The address-spec parameter is held in the Party header as an address. This function returns the handle to the address. SYNTAX RvSipAddressHandle RvSipPartyHeaderGetAddrSpec( IN RvSipPartyHeaderHandle hHeader); PARAMETERS hHeader The handle to the Party header. RETURN VALUES Returns a handle to the address-spec object, or NULL if the address-spec object does not exist.
Get and Set Functions RvSipPartyHeaderSetAddrSpec() RvSipPartyHeaderSetAddrSpec() DESCRIPTION Sets the address-spec address in the Contact header. SYNTAX RvStatus RvSipPartyHeaderSetAddrSpec IN RvSipPartyHeaderHandle hHeader, IN RvSipAddressHandle hAddrSpec); PARAMETERS hHeader The handle to the Contact header. hAddrSpec The handle to the address-spec address to be set in the Party header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipPartyHeaderGetOtherParams() RvSipPartyHeaderGetOtherParams() DESCRIPTION Copies the Party header other-params parameter of the Party header into a given buffer. Not all the Party header parameters have separated parameters in the Party header. Parameters with no specific parameters are referred to as “otherparams”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipPartyHeaderSetOtherParams() RvSipPartyHeaderSetOtherParams() DESCRIPTION Sets the other-params parameter in the Party header. Not all the Party header parameters have separated parameters in the Party header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipPartyHeaderGetType() RvSipPartyHeaderGetType() DESCRIPTION Returns the type of a Party header, RVSIP_HEADERTYPE_TO or RVSIP_HEADERTYPE_FROM. SYNTAX RvStatus RvSipPartyHeaderGetType( IN RvSipPartyHeaderHandle hHeader, OUT RvSipHeaderType* peType); PARAMETERS hHeader The handle to the Party header. peType The type of the header (To or From). RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipPartyHeaderSetType() RvSipPartyHeaderSetType() DESCRIPTION Sets the type of a Party header, RVSIP_HEADERTYPE_TO or RVSIP_HEADERTYPE_FROM. SYNTAX RvStatus RvSipPartyHeaderSetType( IN RvSipPartyHeaderHandle hHeader, IN RvSipHeaderType eType); PARAMETERS HHEADER The handle to the Party header. ETYPE The type of the header (To or From). RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipPartyHeaderGetRpoolString() RvSipPartyHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Party header into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipPartyHeaderGetRpoolString( IN RvSipPartyHeaderHandle hSipPartyHeader, IN RvSipPartyHeaderStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipPartyHeader The handle to the Party header. eStringName The string the user wishes to get.
Get and Set Functions RvSipPartyHeaderSetRpoolString() RvSipPartyHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Party header. The given string is located in an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipPartyHeaderSetRpoolString( IN RvSipPartyHeaderHandle hSipPartyHeader, IN RvSipPartyHeaderStringName eStringName, IN RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipPartyHeader The handle to the Party header. eStringName The string the user wishes to set.
Get and Set Functions RvSipPartyHeaderGetStrBadSyntax() RvSipPartyHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipPartyHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipPartyHeaderSetStrBadSyntax() RvSipPartyHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipPartyHeaderSetCompactForm() RvSipPartyHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipPartyHeaderSetCompactForm( IN RvSipPartyHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Party header. bIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipPartyHeaderGetCompactForm() RvSipPartyHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the Party header. This flag tells the Stack whether or not to use the compact form Party header during the header encoding. SYNTAX RvStatus RvSipPartyHeaderGetCompactForm( IN RvSipPartyHeaderHandle hHeader, IN RvBool *pbIsCompact); PARAMETERS hHeader The handle to the Party header. pbIsCompact Specifies whether or not to use compact form. RETURN VALUES Returns RvStatus.
18 RACK HEADER FUNCTIONS RAck header functions enable you to construct, copy, encode, parse, access and change RAck header parameters. This section contains RAck header functions found in the RvSipRAckHeader.h header file.
Control Functions CONTROL FUNCTIONS 570 The Control functions are: RvSipRAckHeaderConstructInMsg() RvSipRAckHeaderConstruct() RvSipRAckHeaderCopy() RvSipRAckHeaderEncode() RvSipRAckHeaderParse() RvSipRAckHeaderParseValue() RvSipRAckHeaderFix() RvSipRAckHeaderIsResponseNumInitialized() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipRAckHeaderConstructInMsg() RvSipRAckHeaderConstructInMsg() DESCRIPTION Constructs a RAck header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the header list. SYNTAX RvStatus RvSipRAckHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipRAckHeaderHandle *hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipRAckHeaderConstruct() RvSipRAckHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone RAck header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipRAckHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipRAckHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipRAckHeaderCopy() RvSipRAckHeaderCopy() DESCRIPTION Copies all parameters from a source RAck header to a destination RAck header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipRAckHeaderCopy( INOUT RvSipRAckHeaderHandle hDestination, IN hSource); RvSipRAckHeaderHandle PARAMETERS hDestination The handle to the destination RAck header. hSource The handle to the source RAck header. RETURN VALUES Returns RvStatus.
Control Functions RvSipRAckHeaderEncode() RvSipRAckHeaderEncode() DESCRIPTION Encodes a RAck header to a textual RAck header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). The application must free the allocated page, using RPOOL_FreePage(). The allocated page should be freed only if this function returns RV_OK.
Control Functions RvSipRAckHeaderParse() RvSipRAckHeaderParse() DESCRIPTION Parses a SIP textual RAck header, such as “RAck:787 1 INVITE”, into a RAck header. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipRAckHeaderParseValue() RvSipRAckHeaderParseValue() DESCRIPTION Parses a SIP textual RAck header value into an RAck header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipRAckHeaderFix() RvSipRAckHeaderFix() DESCRIPTION Fixes a RAck header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Control Functions RvSipRAckHeaderIsResponseNumInitialized() RvSipRAckHeaderIsResponseNumInitialized() DESCRIPTION Checks if the response number value in the RAck header is defined. SYNTAX RvStatus RvSipRAckHeaderIsResponseNumInitialized( IN RvSipRAckHeaderHandle OUT RvBool hHeader, *pbInit); PARAMETERS hHeader The handle to the RAck header. pbInit An indication of the response number definition. RETURN VALUES Returns RvStatus.
Get and Set Functions GET AND SET FUNCTIONS The Get and Set functions are: RvSipRAckHeaderGetResponseNum() RvSipRAckHeaderSetResponseNum() RvSipRAckHeaderGetCSeqHandle() RvSipRAckHeaderSetCSeqHandle() RvSipRAckHeaderGetStringLength() RvSipRAckHeaderGetStrBadSyntax() RvSipRAckHeaderSetStrBadSyntax() RAck Header Functions 579
Get and Set Functions RvSipRAckHeaderGetResponseNum() RvSipRAckHeaderGetResponseNum() DESCRIPTION Gets the response number value from the RAck header. SYNTAX RvInt32 RvSipRAckHeaderGetResponseNum( IN RvSipRAckHeaderHandle PARAMETERS hHeader The handle to the RAck header. RETURN VALUES Returns the response number value.
Get and Set Functions RvSipRAckHeaderSetResponseNum() RvSipRAckHeaderSetResponseNum() DESCRIPTION Sets the response number value in the RAck header. SYNTAX RvStatus RvSipRAckHeaderSetResponseNum( IN RvSipRAckHeaderHandle hHeader, IN RvInt32 responseNum); PARAMETERS hHeader The handle to the RAck header. responseNum Response number value to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRAckHeaderGetCSeqHandle() RvSipRAckHeaderGetCSeqHandle() DESCRIPTION Gets the Cseq handle from the RAck header. SYNTAX RvSipCSeqHeaderHandle RvSipRAckHeaderGetCSeqHandle( IN RvSipRAckHeaderHandle hHeader); PARAMETERS hHeader The handle to the RAck header. RETURN VALUES Returns the handle to the CSeq header, or NULL if the CSeq header does not exist.
Get and Set Functions RvSipRAckHeaderSetCSeqHandle() RvSipRAckHeaderSetCSeqHandle() DESCRIPTION Sets a new CSeq header in the RAck header. SYNTAX RvStatus RvSipRAckHeaderSetCSeqHandle( IN RvSipRAckHeaderHandle hHeader, IN RvSipCSeqHeaderHandle hCSeq); PARAMETERS hHeader The handle to the RAck header. hDate The CSeq handle to be set in the RAck header. If the CSeq handle is NULL, the existing CSeq header is removed from the RAck header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRAckHeaderGetStringLength() RvSipRAckHeaderGetStringLength() DESCRIPTION Some of the RAck header parameters are kept in a string format. In order to get such a parameter from the RAck header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipRAckHeaderGetStrBadSyntax() RvSipRAckHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipRAckHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRAckHeaderSetStrBadSyntax() RvSipRAckHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipRAckHeaderSetStrBadSyntax() 588 HP C SIP Stack Message Layer Reference Guide
19 REFER-TO HEADER FUNCTIONS The Refer-To header functions enable you to construct, copy, encode, parse, access and change Refer-To header parameters. This section contains Refer-To header functions found in the RvSipReferToHeader.h header file.
Control Functions CONTROL FUNCTIONS 590 The Control functions are: RvSipReferToHeaderConstructInMsg() RvSipReferToHeaderConstruct() RvSipReferToHeaderCopy() RvSipReferToHeaderEncode() RvSipReferToHeaderParse() RvSipReferToHeaderParseValue() RvSipReferToHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipReferToHeaderConstructInMsg() RvSipReferToHeaderConstructInMsg() DESCRIPTION Constructs a Refer-To header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipReferToHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipReferToHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipReferToHeaderConstruct() RvSipReferToHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Refer-To header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipReferToHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipReferToHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipReferToHeaderCopy() RvSipReferToHeaderCopy() DESCRIPTION Copies all parameters from a source Refer-To header to a destination Refer-To header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipReferToHeaderCopy( INOUT RvSipReferToHeaderHandle hDestination, IN hSource); RvSipReferToHeaderHandle PARAMETERS hDestination The handle to the destination Refer-To header. hSource The handle to the source Refer-To header.
Control Functions RvSipReferToHeaderEncode() RvSipReferToHeaderEncode() DESCRIPTION Encodes a Refer-To header to a textual Refer-To header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipReferToHeaderEncode( IN RvSipReferToHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hHeader The handle to the Refer-To header.
Control Functions RvSipReferToHeaderParse() RvSipReferToHeaderParse() DESCRIPTION Parses a SIP textual Refer-To header into a Refer-To header. All the textual parameters are placed inside the object. For example, “ReferTo:”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipReferToHeaderParseValue() RvSipReferToHeaderParseValue() DESCRIPTION Parses a SIP textual Refer-To header value into an Refer-To header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipReferToHeaderFix() RvSipReferToHeaderFix() DESCRIPTION Fixes a Refer-To header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 598 The Get and Set functions are: RvSipReferToHeaderGetStringLength() RvSipReferToHeaderGetAddrSpec() RvSipReferToHeaderSetAddrSpec() RvSipReferToHeaderGetDisplayName() RvSipReferToHeaderSetDisplayName() RvSipReferToHeaderGetReplacesHeader() RvSipReferToHeaderSetReplacesHeader() RvSipReferToHeaderGetOtherParams() RvSipReferToHeaderSetOtherParams() RvSipReferToHeaderGetStrBadSyntax() RvSipReferToHeaderSetStrBadSyntax() RvSipReferToHe
Get and Set Functions RvSipReferToHeaderGetStringLength() RvSipReferToHeaderGetStringLength() DESCRIPTION Some of the Refer-To header parameters are kept in a string format, for example, the Refer-To header display name. In order to get such a parameter from the Refer-To header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipReferToHeaderGetAddrSpec() RvSipReferToHeaderGetAddrSpec() DESCRIPTION Returns the handle to the address. The address-spec parameter is held in the Refer-To header as an address. SYNTAX RvSipAddressHandle RvSipReferToHeaderGetAddrSpec( IN RvSipReferToHeaderHandle hHeader); PARAMETERS hHeader The handle to the Refer-To header. RETURN VALUES Returns a handle to the address-spec object, or NULL if the address-spec object does not exist.
Get and Set Functions RvSipReferToHeaderSetAddrSpec() RvSipReferToHeaderSetAddrSpec() DESCRIPTION Sets the address-spec address in the Refer-To header. SYNTAX RvStatus RvSipReferToHeaderSetAddrSpec( IN RvSipReferToHeaderHandle hHeader, IN RvSipAddressHandle hAddrSpec); PARAMETERS hHeader The handle to the Refer-To header. hAddrSpec The handle to the address-spec address to be set in the Refer-To header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferToHeaderGetDisplayName() RvSipReferToHeaderGetDisplayName() DESCRIPTION Copies the display name from the Refer-To header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipReferToHeaderSetDisplayName() RvSipReferToHeaderSetDisplayName() DESCRIPTION Sets the display name in the Refer-To header. SYNTAX RvStatus RvSipReferToHeaderSetDisplayName( IN RvSipReferToHeaderHandle hHeader, IN RvChar* strDisplayName); PARAMETERS hHeader The handle to the header. strDisplayName The display name to be set in the Refer-To header. If NULL is supplied, the existing display name is removed from the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferToHeaderGetReplacesHeader() RvSipReferToHeaderGetReplacesHeader() DESCRIPTION Gets the Replaces header from the Refer-To header. SYNTAX RvStatus RvSipReferToHeaderGetReplacesHeader( IN RvSipReferToHeaderHandle OUT RvSipReplacesHeaderHandle hHeader, *hReplacesHeader); PARAMETERS hHeader The handle to the Refer-To header. hReplacesHeader A pointer to the handle of the returned Replaces header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferToHeaderSetReplacesHeader() RvSipReferToHeaderSetReplacesHeader() DESCRIPTION Sets the Replaces header in the Refer-To header. SYNTAX RvStatus RvSipReferToHeaderSetReplacesHeader( IN RvSipReferToHeaderHandle hHeader, IN RvSipReplacesHeader hReplacesHeader); PARAMETERS hHeader The handle to the Refer-To header. hReplacesHeader The handle to the Replaces header to be set in the Refer-To header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferToHeaderGetOtherParams() RvSipReferToHeaderGetOtherParams() DESCRIPTION Copies the other-params parameter of the Refer-To header into a given buffer. The generic parameters of the Refer-To header are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”. If bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipReferToHeaderSetOtherParams() RvSipReferToHeaderSetOtherParams() DESCRIPTION Sets the other-params parameter in the Refer-To header. The generic parameters of the Refer-To header are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipReferToHeaderGetStrBadSyntax() RvSipReferToHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipReferToHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferToHeaderSetStrBadSyntax() RvSipReferToHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipReferToHeaderSetCompactForm() RvSipReferToHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipReferToHeaderSetCompactForm( IN RvSipReferToHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Refer-To header. bIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferToHeaderGetCompactForm() RvSipReferToHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the Refer-To header. SYNTAX RvStatus RvSipReferToHeaderGetCompactForm( IN RvSipReferToHeaderHandle hHeader, IN RvBool *pbIsCompact); PARAMETERS hHeader The handle to the Refer-To header. pbIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
20 REFERRED-BY HEADER FUNCTIONS The Referred-By header functions enable you to construct, copy, encode, parse, access and change Referred-By header parameters. This section contains Referred-By header functions found in the RvSipReferredByHeader.h header file.
Control Functions CONTROL FUNCTIONS 614 The Control functions are: RvSipReferredByHeaderConstructInMsg() RvSipReferredByheaderConstruct() RvSipReferredByHeaderCopy() RvSipReferredByHeaderEncode() RvSipReferredByHeaderParse() RvSipReferredByHeaderParseValue() RvSipReferredByHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipReferredByHeaderConstructInMsg() RvSipReferredByHeaderConstructInMsg() DESCRIPTION Constructs a Referred-By header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipReferredByHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipReferredByHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipReferredByheaderConstruct() RvSipReferredByheaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Referred-By header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipReferredByHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipReferredByHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipReferredByHeaderCopy() RvSipReferredByHeaderCopy() DESCRIPTION Copies all parameters from a source Referred-By header to a destination Referred-By header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipReferredByHeaderCopy( INOUT RvSipReferredByHeaderHandle hDestination, IN hSource); RvSipReferredByHeaderHandle PARAMETERS hDestination The handle to the destination Referred-By header.
Control Functions RvSipReferredByHeaderEncode() RvSipReferredByHeaderEncode() DESCRIPTION Encodes a Referred-By header to a textual Referred-By header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipReferredByHeaderParse() RvSipReferredByHeaderParse() DESCRIPTION Parses a SIP textual Referred-By header into a Referred-By header. All the textual parameters are placed inside the object. For example, “Referred-by: ;ref=”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipReferredByHeaderParseValue() RvSipReferredByHeaderParseValue() DESCRIPTION Parses a SIP textual Referred-By header value into an Referred-By header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipReferredByHeaderFix() RvSipReferredByHeaderFix() DESCRIPTION Fixes a Referred-By header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 622 The Get and Set functions are: RvSipReferredByHeaderGetStringLength() RvSipReferredByHeaderGetDispName() RvSipReferredByHeaderSetDispName() RvSipReferredByHeaderGetAddrSpec() RvSipReferredByHeaderSetAddrSpec() RvSipReferredByHeaderGetCidParam() RvSipReferredByHeaderSetCidParam() RvSipReferredByHeaderGetOtherParams() RvSipReferredByHeaderSetOtherParams() RvSipReferredByHeaderGetStrBadSyntax() RvSipReferredByHeaderSetStrBadSyntax()
Get and Set Functions RvSipReferredByHeaderGetStringLength() RvSipReferredByHeaderGetStringLength() DESCRIPTION Provides the length of the string to enable allocating an appropriate buffer size before calling the Get function. Some of the Referred-By header parameters are kept in a string format, for example, the referrer display name. In order to get such a parameter from the Referred-By header, your application should supply an adequate buffer to where the string will be copied.
Get and Set Functions RvSipReferredByHeaderGetDispName() RvSipReferredByHeaderGetDispName() DESCRIPTION Copies the referrer display name parameter of the Referred-By header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipReferredByHeaderSetDispName() RvSipReferredByHeaderSetDispName() DESCRIPTION Sets the referred display name parameter in the Referred-By header. SYNTAX RvStatus RvSipReferredByHeaderSetDispName( IN RvSipReferredByHeaderHandle hHeader, IN RvChar* strDispName); PARAMETERS hHeader The handle to the Referred-By header. strDispName The display name parameter to be set in the Referred-By header. If NULL is supplied, the existing display name is removed from the header.
Get and Set Functions RvSipReferredByHeaderGetAddrSpec() RvSipReferredByHeaderGetAddrSpec() DESCRIPTION Returns the referrer-URL address-spec. SYNTAX RvSipAddressHandle RvSipReferredByHeaderGetAddrSpec( IN RvSipReferredByHeaderHandle hHeader); PARAMETERS hHeader The handle to the Referred-By header. RETURN VALUES Returns a handle to the address-spec object or NULL if this address-spec object does not exist.
Get and Set Functions RvSipReferredByHeaderSetAddrSpec() RvSipReferredByHeaderSetAddrSpec() DESCRIPTION Sets the referrer-URL address-spec in the Referred-By header. SYNTAX RvStatus RvSipReferredByHeaderSetAddrSpec( IN RvSipReferredByHeaderHandle hHeader, IN RvSipAddressHandle hAddrSpec, IN RvSipReferredByUrl eUrlEntity); PARAMETERS hHeader The handle to the Referred-By header. hAddrSpec The handle to the address-spec address to be set in the Referred-By header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferredByHeaderGetCidParam() RvSipReferredByHeaderGetCidParam() DESCRIPTION Copies the referrer cid parameter of the Referred-By header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipReferredByHeaderSetCidParam() RvSipReferredByHeaderSetCidParam() DESCRIPTION Sets the cid parameter in the Referred-By header. SYNTAX RvStatus RvSipReferredByHeaderSetCidParam( IN RvSipReferredByHeaderHandle hHeader, IN RvChar* strCidParam); PARAMETERS hHeader The handle to the Referred-By header. strCidParam The cid parameter to be set in the Referred-By header. If NULL is supplied, the existing cid param is removed from the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferredByHeaderGetOtherParams() RvSipReferredByHeaderGetOtherParams() DESCRIPTION Copies the Referred-By header other-params parameter of the Referred-By header into a given buffer. Not all the Referred-By header parameters have separated parameters in the Referred-By header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipReferredByHeaderGetOtherParams() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferredByHeaderSetOtherParams() RvSipReferredByHeaderSetOtherParams() DESCRIPTION Sets the other-params parameter in the Referred-By header. Not all the ReferredBy header parameters have separated parameters in the Referred-By header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”. This list also includes the signature parameters.
Get and Set Functions RvSipReferredByHeaderGetStrBadSyntax() RvSipReferredByHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipReferredByHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferredByHeaderSetStrBadSyntax() RvSipReferredByHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipReferredByHeaderSetCompactForm() RvSipReferredByHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipReferredByHeaderSetCompactForm( IN RvSipReferredByHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Referred-By header. bIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferredByHeaderGetCompactForm() RvSipReferredByHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the header. SYNTAX RvStatus RvSipReferredByHeaderGetCompactForm ( IN RvSipReferredByHeaderHandle hHeader, IN RvBool *pbIsCompact); PARAMETERS hHeader The handle to the Referred-By header. pbIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipReferredByHeaderGetCompactForm() 638 HP C SIP Stack Message Layer Reference Guide
21 RETRY-AFTER HEADER FUNCTIONS Retry-After header functions enable you to construct, copy, encode, parse, access and change Retry-After header parameters. This section contains RetryAfter header functions found in the RvSipRetryAfterHeader.h header file.
Control Functions CONTROL FUNCTIONS 640 The Control functions are: RvSipRetryAfterHeaderConstructInMsg() RvSipRetryAfterHeaderConstruct() RvSipRetryAfterHeaderCopy() RvSipRetryAfterHeaderEncode() RvSipRetryAfterHeaderParse() RvSipRetryAfterHeaderParseValue() RvSipRetryAfterHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipRetryAfterHeaderConstructInMsg() RvSipRetryAfterHeaderConstructInMsg() DESCRIPTION Constructs a Retry-After header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipRetryAfterHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipRetryAfterHeaderHandle* phHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipRetryAfterHeaderConstruct() RvSipRetryAfterHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Retry-After header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipRetryAfterHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipRetryAfterHeaderHandle* hPage, phHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipRetryAfterHeaderCopy() RvSipRetryAfterHeaderCopy() DESCRIPTION Copies all parameters from a source Retry-After header to a destination RetryAfter header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipRetryAfterHeaderCopy( INOUT RvSipRetryAfterHeaderHandle hDestination, IN hSource); RvSipRetryAfterHeaderHandle PARAMETERS pDestination The handle to the destination Retry-After header. pSource The handle to the source Retry-After header.
Control Functions RvSipRetryAfterHeaderEncode() RvSipRetryAfterHeaderEncode() DESCRIPTION Encodes a Retry-After header to a textual Retry-After header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). The application must free the allocated page, using RPOOL_FreePage(). The application must free the allocated page only if this function returns RV_OK.
Control Functions RvSipRetryAfterHeaderParse() RvSipRetryAfterHeaderParse() DESCRIPTION Parses a SIP textual Expires header into a Retry-After header. All the textual parameters are placed inside the object. For example, “RetryAfter: Thu, 01 Dec 2040 16:00:00 GMT”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipRetryAfterHeaderParseValue() RvSipRetryAfterHeaderParseValue() DESCRIPTION Parses a SIP textual Retry-After header value into an Retry-After header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipRetryAfterHeaderFix() RvSipRetryAfterHeaderFix() Fixes a Retry-After header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 648 The Get and Set functions are: RvSipRetryAfterHeaderGetStringLength() RvSipRetryAfterHeaderGetFormat() RvSipRetryAfterHeaderGetDeltaSeconds() RvSipRetryAfterHeaderSetDeltaSeconds() RvSipRetryAfterHeaderGetDateHandle() RvSipRetryAfterHeaderSetDate() RvSipRetryAfterHeaderGetDuration() RvSipRetryAfterHeaderSetDuration() RvSipRetryAfterHeaderGetStrComment() RvSipRetryAfterHeaderSetStrComment() RvSipRetryAfterHeaderGetRetryAfterPara
Get and Set Functions RvSipRetryAfterHeaderGetStringLength() RvSipRetryAfterHeaderGetStringLength() DESCRIPTION Some of the Retry-After header parameters are kept in string format, such as the comment. In order to get such a parameter from the Retry-After header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipRetryAfterHeaderGetFormat() RvSipRetryAfterHeaderGetFormat() DESCRIPTION Gets the format of the Retry-After header: Undefined, Date or Delta-seconds. SYNTAX RvSipExpiresFormat RvSipRetryAfterHeaderGetFormat( IN RvSipRetryAfterHeaderHandle PARAMETERS hHeader The handle to the Retry-After header. RETURN VALUES Returns the format enumeration.
Get and Set Functions RvSipRetryAfterHeaderGetDeltaSeconds() RvSipRetryAfterHeaderGetDeltaSeconds() DESCRIPTION Gets the delta-seconds integer of the Retry-After header. If the delta-seconds integer is not set, UNDEFINED is returned. SYNTAX RvStatus RvSipRetryAfterHeaderGetDeltaSeconds( IN RvSipRetryAfterHeaderHandle OUT RvUint32 hHeader, *pDeltaSeconds); PARAMETERS hHeader The handle to the Retry-After header. pDeltaSeconds The delta-seconds integer. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRetryAfterHeaderSetDeltaSeconds() RvSipRetryAfterHeaderSetDeltaSeconds() DESCRIPTION Sets the delta seconds integer of the Retry-After header. Changes the RetryAfter format to delta-seconds. If the given delta-seconds is UNDEFINED, the delta-seconds of the Retry-After header is removed and the format is changed to UNDEFINED.
Get and Set Functions RvSipRetryAfterHeaderGetDateHandle() RvSipRetryAfterHeaderGetDateHandle() DESCRIPTION Gets the date handle to the Retry-After header. SYNTAX RvSipDateHeaderHandle RvSipRetryAfterHeaderGetDateHandle( IN RvSipRetryAfterHeaderHandle hHeader); PARAMETERS hHeader The handle to the Retry-After header. RETURN VALUES Returns the handle to the Date header, or NULL if the Date header does not exist.
Get and Set Functions RvSipRetryAfterHeaderSetDate() RvSipRetryAfterHeaderSetDate() DESCRIPTION Sets a new Date header in the Retry-After header and changes the Retry-After format to date. (The function allocates a Date header, and copies the given hDate object to it). SYNTAX RvStatus RvSipRetryAfterHeaderSetDate( IN RvSipRetryAfterHeaderHandle hHeader, IN RvSipDateHeaderHandle hDate); PARAMETERS hHeader The handle to the Retry-After header. hDate The date handle to be set to the Retry-After header.
Get and Set Functions RvSipRetryAfterHeaderGetDuration() RvSipRetryAfterHeaderGetDuration() DESCRIPTION Gets the duration integer of the Retry-After header. If the duration integer is not set, UNDEFINED is returned. SYNTAX RvStatus RvSipRetryAfterHeaderGetDuration( IN RvSipRetryAfterHeaderHandle OUT RvInt32 hHeader, *pDuration); PARAMETERS hHeader The handle to the Retry-After header. pDuration The duration integer. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRetryAfterHeaderSetDuration() RvSipRetryAfterHeaderSetDuration() DESCRIPTION Sets the duration integer of the Retry-After header. If the given duration is UNDEFINED, the duration of the Retry-After header is removed. SYNTAX RvStatus RvSipRetryAfterHeaderSetDuration( IN RvSipRetryAfterHeaderHandlev hHeader, IN RvInt32 duration); PARAMETERS hHeader The handle to the Retry-After header. duration The duration to be set to the Retry-After header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRetryAfterHeaderGetStrComment() RvSipRetryAfterHeaderGetStrComment() DESCRIPTION Copies the str-comment parameter of the Retry-After header into a given buffer. If the value of bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipRetryAfterHeaderSetStrComment() RvSipRetryAfterHeaderSetStrComment() DESCRIPTION Sets the str-comment parameter in the Retry-After header. SYNTAX RvStatus RvSipRetryAfterHeaderSetStrComment( IN RvSipRetryAfterHeaderHandle hHeader, IN RvChar* strComment); PARAMETERS hHeader The handle to the Retry-After header. strComment The strComment string to be set in the Retry-After header. If NULL is supplied, the existing strComment parameter is removed from the header.
Get and Set Functions RvSipRetryAfterHeaderGetRetryAfterParams() RvSipRetryAfterHeaderGetRetryAfterParams() DESCRIPTION Copies the retry-after-params parameter of the Retry-After header into a given buffer. Not all the Retry-After header parameters have separated parameters in the Retry-After header. Parameters with no specific parameters are referred to as RetryAfterParams. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipRetryAfterHeaderGetRetryAfterParams() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRetryAfterHeaderSetRetryAfterParams() RvSipRetryAfterHeaderSetRetryAfterParams() DESCRIPTION Sets the retry-after-params parameter in the Retry-After header. Not all the Retry-After header parameters have separated parameters in the Retry-After header. Parameters with no specific parameters are referred to as “retry-afterparams”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipRetryAfterHeaderGetStrBadSyntax() RvSipRetryAfterHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipRetryAfterHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRetryAfterHeaderSetStrBadSyntax() RvSipRetryAfterHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
22 ROUTE-HOP HEADER FUNCTIONS The Route-Hop header represents both Route and Record-Route SIP headers. The Route-Hop header functions enable you to construct, copy, encode, parse, access and change Route-Hop header parameters. This section contains RouteHop header functions found in the RvSipRouteHopHeader.h header file.
Control Functions CONTROL FUNCTIONS 666 The Control functions are: RvSipRouteHopHeaderConstructInMsg() RvSipRouteHopHeaderConstruct() RvSipRouteHopHeaderCopy() RvSipRouteHopHeaderEncode() RvSipRouteHopHeaderParse() RvSipRouteHopHeaderParseValue() RvSipRouteHopHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipRouteHopHeaderConstructInMsg() RvSipRouteHopHeaderConstructInMsg() DESCRIPTION Constructs a Route-Hop header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. Use RvSipRouteHopHeaderSetHeaderType() to determine whether the object represents a Route, Record-Route, Path or Service-Route header.
Control Functions RvSipRouteHopHeaderConstruct() RvSipRouteHopHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Route-Hop header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. Use RvSipRouteHopHeaderSetHeaderType() to determine whether the object represents a Route, Record-Route, Path or Service-Route header.
Control Functions RvSipRouteHopHeaderCopy() RvSipRouteHopHeaderCopy() DESCRIPTION Copies all parameters from a source Route-Hop header to a destination RouteHop header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipRouteHopHeaderCopy( INOUT RvSipRouteHopHeaderHandle hDestination, IN hSource); RvSipRouteHopHeaderHandle PARAMETERS hDestination The handle to the destination Route-Hop header. hSource The handle to the source Route-Hop header.
Control Functions RvSipRouteHopHeaderEncode() RvSipRouteHopHeaderEncode() DESCRIPTION Encodes a Route-Hop header to a textual Route or Record-Route header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipRouteHopHeaderParse() RvSipRouteHopHeaderParse() DESCRIPTION Parses a SIP textual Route, Record-Route, Path or Service-Route header. All the textual parameters are placed inside the object. For example, “Record-Route: ”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipRouteHopHeaderParseValue() RvSipRouteHopHeaderParseValue() DESCRIPTION Parses a SIP textual Route-Hop header value into a Route-Hop header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipRouteHopHeaderFix() RvSipRouteHopHeaderFix() DESCRIPTION Fixes a Route-Hop header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 674 The Get and Set functions are: RvSipRouteHopHeaderGetStringLength() RvSipRouteHopHeaderGetDisplayName() RvSipRouteHopHeaderSetDisplayName() RvSipRouteHopHeaderGetAddrSpec() RvSipRouteHopHeaderSetAddrSpec() RvSipRouteHopHeaderGetOtherParams() RvSipRouteHopHeaderSetOtherParams() RvSipRouteHopHeaderGetHeaderType() RvSipRouteHopHeaderSetHeaderType() RvSipRouteHopHeaderGetRpoolString() RvSipRouteHopHeaderSetRpoolString() RvSipRouteHop
Get and Set Functions RvSipRouteHopHeaderGetStringLength() RvSipRouteHopHeaderGetStringLength() DESCRIPTION Provides the length of string parameters to enable allocating an appropriate buffer size before calling the Get function. Some of the Route-Hop header parameters are kept in a string format, for example, the Route header display name. In order to get such a parameter from the Route header, your application should supply an adequate buffer to where the string will be copied.
Get and Set Functions RvSipRouteHopHeaderGetDisplayName() RvSipRouteHopHeaderGetDisplayName() DESCRIPTION Copies the display name from the Route-Hop header into a given buffer. If the bufferLen is adequate, the function copies the requested parameter into strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required buffer length.
Get and Set Functions RvSipRouteHopHeaderSetDisplayName() RvSipRouteHopHeaderSetDisplayName() DESCRIPTION Sets the display name in the Route-Hop header. SYNTAX RvStatus RvSipRouteHopHeaderSetDisplayName( IN RvSipRouteHopHeaderHandle hHeader, IN RvChar* strDisplayName); PARAMETERS hHeader The handle to the header. strDisplayName The display name to be set in the Route-Hop header. If NULL is supplied, the existing display name is removed from the header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRouteHopHeaderGetAddrSpec() RvSipRouteHopHeaderGetAddrSpec() DESCRIPTION The address-spec parameter is held in the Route-Hop header as an address. This function returns the handle to the address. SYNTAX RvSipAddressHandle RvSipRouteHopHeaderGetAddrSpec( IN RvSipRouteHopHeaderHandle hHeader); PARAMETERS hHeader The handle to the Route-Hop header. RETURN VALUES Returns a handle to the address-spec object, or NULL if the address-spec object does not exist.
Get and Set Functions RvSipRouteHopHeaderSetAddrSpec() RvSipRouteHopHeaderSetAddrSpec() DESCRIPTION Sets the address-spec address in the Route-Hop header. SYNTAX RvStatus RvSipRouteHopHeaderSetAddrSpec( IN RvSipRouteHopHeaderHandle hHeader, IN RvSipAddressHandle hAddrSpec); PARAMETERS hHeader The handle to the Route-Hop header. hAddrSpec The handle to the address-spec address to be set in the Route-Hop header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRouteHopHeaderGetOtherParams() RvSipRouteHopHeaderGetOtherParams() DESCRIPTION Not all the Route-Hop header parameters have separated parameters in the Route-Hop header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”. This function copies the RouteHop header other-params parameter of the Route-Hop header into a given buffer.
Get and Set Functions RvSipRouteHopHeaderGetOtherParams() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRouteHopHeaderSetOtherParams() RvSipRouteHopHeaderSetOtherParams() DESCRIPTION Not all the Route-Hop header parameters have separated parameters in the Route-Hop header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”. This function sets the otherparams parameter in the Route-Hop header.
Get and Set Functions RvSipRouteHopHeaderGetHeaderType() RvSipRouteHopHeaderGetHeaderType() DESCRIPTION Gets the header type enumeration from the Route-Hop header. The Route-Hop header can represent a Route or Record-Route header. SYNTAX RvSipRouteHopHeaderType RvSipRouteHopHeaderGetHeaderType( IN RvSipRouteHopHeaderHandle hHeader); PARAMETERS hHeader The handle to the Route-Hop header. RETURN VALUES Returns the Route-Hop header type enumeration from the Route-Hop header.
Get and Set Functions RvSipRouteHopHeaderSetHeaderType() RvSipRouteHopHeaderSetHeaderType() DESCRIPTION Sets the header type in the Route-Hop header. The Route-Hop header can represent a Route or Record-Route header. SYNTAX RvStatus RvSipRouteHopHeaderSetHeaderType( IN RvSipRouteHopHeaderHandle hHeader, IN RvSipRouteHopHeaderType eHeaderType); PARAMETERS hHeader The handle to the Route-Hop header. eHeaderType The header type to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRouteHopHeaderGetRpoolString() RvSipRouteHopHeaderGetRpoolString() DESCRIPTION Copy a string parameter from the Route-Hop header into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipRouteHopHeaderGetRpoolString( IN RvSipRouteHopHeaderHandle hSipRouteHopHeader, IN RvSipRouteHopHeaderStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipRouteHopHeader The handle to the Route-Hop header.
Get and Set Functions RvSipRouteHopHeaderSetRpoolString() RvSipRouteHopHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Route-Hop header. The given string is located in an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipRouteHopHeaderSetRpoolString( IN RvSipRouteHopHeaderHandle hSipRouteHopHeader, IN RvSipRouteHopHeaderStringName eStringName, IN RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipRouteHopHeader The handle to the Route-Hop header.
Get and Set Functions RvSipRouteHopHeaderGetStrBadSyntax() RvSipRouteHopHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipRouteHopHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRouteHopHeaderSetStrBadSyntax() RvSipRouteHopHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipRouteHopHeaderSetStrBadSyntax() 690 HP C SIP Stack Message Layer Reference Guide
23 RSEQ HEADER FUNCTIONS RSeq header functions enable you to construct, copy, encode, parse, access and change RSeq header parameters. This section contains RSeq header functions found in the RvSipRSeqHeader.h header file.
Control Functions CONTROL FUNCTIONS 692 The Control functions are: RvSipRSeqHeaderConstructInMsg() RvSipRSeqHeaderConstruct() RvSipRSeqHeaderCopy() RvSipRSeqHeaderEncode() RvSipRSeqHeaderParse() RvSipRSeqHeaderParseValue() RvSipRSeqHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipRSeqHeaderConstructInMsg() RvSipRSeqHeaderConstructInMsg() DESCRIPTION Constructs an RSeq header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the header list. SYNTAX RvStatus RvSipRSeqHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipRSeqHeaderHandle *hHeader); PARAMETERS hSipMsg The handle to the message related to the new header.
Control Functions RvSipRSeqHeaderConstruct() RvSipRSeqHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone RSeq header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipRSeqHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipRSeqHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipRSeqHeaderCopy() RvSipRSeqHeaderCopy() DESCRIPTION Copies all parameters from a source RSeq header to a destination RSeq header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipRSeqHeaderCopy( INOUT RvSipRSeqHeaderHandle hDestination, IN hSource); RvSipRSeqHeaderHandle PARAMETERS hDestination The handle to the destination RSeq header. hSource The handle to the source RSeq header. RETURN VALUES Returns RvStatus.
Control Functions RvSipRSeqHeaderEncode() RvSipRSeqHeaderEncode() DESCRIPTION Encodes an RSeq header to a textual RSeq header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). The application must free the allocated page using RPOOL_FreePage(). The allocated page should be freed only if this function returns RV_OK.
Control Functions RvSipRSeqHeaderParse() RvSipRSeqHeaderParse() DESCRIPTION Parses a SIP textual RSeq header, such as “RSeq:43”, into an RSeq header. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipRSeqHeaderParseValue() RvSipRSeqHeaderParseValue() DESCRIPTION Parses a SIP textual RSeq header value into an RSeq header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipRSeqHeaderFix() RvSipRSeqHeaderFix() DESCRIPTION Fixes a RSeq header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string.You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Get and Set Functions GET AND SET FUNCTIONS 700 The Get and Set functions are: RvSipRSeqHeaderGetResponseNum() RvSipRSeqHeaderSetResponseNum() RvSipRSeqHeaderGetStringLength() RvSipRSeqHeaderGetStrBadSyntax() RvSipRSeqHeaderSetStrBadSyntax() RvSipRSeqHeaderIsResponseNumInitialized() HP C SIP Stack Message Layer Reference Guide
Get and Set Functions RvSipRSeqHeaderGetResponseNum() RvSipRSeqHeaderGetResponseNum() DESCRIPTION Gets the response number value from the RSeq header. SYNTAX RvInt32 RvSipRSeqHeaderGetResponseNum( IN RvSipRSeqHeaderHandle hHeader); PARAMETERS hHeader The handle to the RSeq header. RETURN VALUES Returns the response number value, or UNDEFINED if the number is not set.
Get and Set Functions RvSipRSeqHeaderSetResponseNum() RvSipRSeqHeaderSetResponseNum() DESCRIPTION Sets the response num value in the RSeq header. SYNTAX RvStatus RvSipRSeqHeaderSetResponseNum( IN RvSipRSeqHeaderHandle hHeader, IN RvInt32 responseNum); PARAMETERS hHeader The handle to the RSeq header. responseNum Response number value to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRSeqHeaderGetStringLength() RvSipRSeqHeaderGetStringLength() DESCRIPTION Some of the RSeq header parameters are kept in a string format. In order to get such a parameter from the RSeq header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipRSeqHeaderGetStrBadSyntax() RvSipRSeqHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipRSeqHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRSeqHeaderSetStrBadSyntax() RvSipRSeqHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipRSeqHeaderIsResponseNumInitialized() RvSipRSeqHeaderIsResponseNumInitialized() DESCRIPTION Gets the flag that indicates if the response number was initialized. SYNTAX RvStatus RvSipRSeqHeaderIsResponseNumInitialized( IN RvSipRSeqHeaderHandle OUT RvBool hHeader, *pbInit); PARAMETERS hHeader The handle to the Allow-Events header. pbInit Specifies whether or not the response number was initialized. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipRSeqHeaderIsResponseNumInitialized() 708 HP C SIP Stack Message Layer Reference Guide
24 SESSION-EXPIRES HEADER FUNCTIONS The Session-Expires header functions enable you to construct, copy, encode, parse, access and change Session-Expires header parameters. This section contains Session-Expires header functions found in the RvSipSessionExpiresHeader.h header file.
Control Functions CONTROL FUNCTIONS 710 The Control functions are: RvSipSessionExpiresHeaderConstructInMsg() RvSipSessionExpiresHeaderConstruct() RvSipSessionExpiresHeaderCopy() RvSipSessionExpiresHeaderEncode() RvSipSessionExpiresHeaderParse() RvSipSessionExpiresHeaderParseValue() RvSipSessionExpiresHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipSessionExpiresHeaderConstructInMsg() RvSipSessionExpiresHeaderConstructInMsg() DESCRIPTION Constructs a Session-Expires header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list.
Control Functions RvSipSessionExpiresHeaderConstruct() RvSipSessionExpiresHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Session-Expires header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipSessionExpiresHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipSessionExpiresHeaderHandle* hPage, phHeader); PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipSessionExpiresHeaderCopy() RvSipSessionExpiresHeaderCopy() DESCRIPTION Copies all parameters from a source Session-Expires header to a destination Session-Expires header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipSessionExpiresHeaderCopy( INOUT RvSipSessionExpiresHeaderHandle hDestination, IN hSource); RvSipSessionExpiresHeaderHandle PARAMETERS pDestination The handle to the destination Session-Expires header.
Control Functions RvSipSessionExpiresHeaderEncode() RvSipSessionExpiresHeaderEncode() DESCRIPTION Encodes a Session-Expires header to a textual Session-Expires header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). The application must free the allocated page, using RPOOL_FreePage(). The allocated page must be freed only if this function returns RV_OK.
Control Functions RvSipSessionExpiresHeaderParse() RvSipSessionExpiresHeaderParse() DESCRIPTION Parses a SIP textual Session-Expires header into a Session-Expires header. All the textual parameters are placed inside the object. For example, “Session Expires: 3600;refresher=uac”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipSessionExpiresHeaderParseValue() RvSipSessionExpiresHeaderParseValue() DESCRIPTION Parses a SIP textual Session-Expires header value into a Session-Expires header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipSessionExpiresHeaderFix() RvSipSessionExpiresHeaderFix() DESCRIPTION Fixes a Session-Expires header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 718 The Get and Set functions are: RvSipSessionExpiresHeaderGetStringLength() RvSipSessionExpiresHeaderGetDeltaSeconds() RvSipSessionExpiresHeaderSetDeltaSeconds() RvSipSessionExpiresHeaderGetRefresherType() RvSipSessionExpiresHeaderSetRefresherType() RvSipSessionExpiresHeaderGetOtherParams() RvSipSessionExpiresHeaderSetOtherParams() RvSipSessionExpiresHeaderGetStrBadSyntax() RvSipSessionExpiresHeaderSetStrBadSyntax() RvSipSessionExpires
Get and Set Functions RvSipSessionExpiresHeaderGetStringLength() RvSipSessionExpiresHeaderGetStringLength() DESCRIPTION The other-params of Session-Expires header parameters are kept in a string format. In order to get such a parameter from the Session-Expires header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipSessionExpiresHeaderGetDeltaSeconds() RvSipSessionExpiresHeaderGetDeltaSeconds() DESCRIPTION Gets the delta-seconds integer of the Session-Expires header. If the deltaseconds integer is not set, UNDEFINED is returned. SYNTAX RvStatus RvSipSessionExpiresHeaderGetDeltaSeconds( IN RvSipSessionExpiresHeaderHandle OUT RvInt32 PARAMETERS hHeader The handle to the Session-Expires header. pDeltaSeconds The delta-seconds integer. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipSessionExpiresHeaderSetDeltaSeconds() RvSipSessionExpiresHeaderSetDeltaSeconds() DESCRIPTION Sets the delta seconds integer of the Session-Expires header. If the given deltaseconds is UNDEFINED, the delta-seconds of the Session-Expires header is removed. SYNTAX RvStatus RvSipSessionExpiresHeaderSetDeltaSeconds( IN RvSipSessionExpiresHeaderHandle hHeader, IN RvInt32 deltaSeconds); PARAMETERS hHeader The handle to the Session-Expires header.
Get and Set Functions RvSipSessionExpiresHeaderGetRefresherType() RvSipSessionExpiresHeaderGetRefresherType() DESCRIPTION Gets the refresher type of the Session-Expires header. If the refresher type is not set, RVSIP_SESSION_EXPIRES_REFRESHER_NONE is returned. SYNTAX RvStatus RvSipSessionExpiresHeaderGetRefresherType( IN RvSipSessionExpiresHeaderHandle OUT RvSipSessionExpiresRefresherType PARAMETERS hHeader The handle to the Session-Expires header. peRefresherType The refresher type.
Get and Set Functions RvSipSessionExpiresHeaderSetRefresherType() RvSipSessionExpiresHeaderSetRefresherType() DESCRIPTION Sets the refresher type of the Session-Expires header. SYNTAX RvStatus RvSipSessionExpiresHeaderSetRefresherType( IN RvSipSessionExpiresHeaderHandle hHeader, IN RvSipSessionExpiresRefresherType eRefresherType); PARAMETERS hHeader The handle to the Session-Expires header. deltaSeconds The refresher type to be set to the Session-Expires header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipSessionExpiresHeaderGetOtherParams() RvSipSessionExpiresHeaderGetOtherParams() DESCRIPTION Copies the other-params string from the Session-Expires header into a given buffer. Not all the Session-Expires header parameters have separated parameters in the Session-Expires header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipSessionExpiresHeaderSetOtherParams() RvSipSessionExpiresHeaderSetOtherParams() DESCRIPTION Sets the other-params string in the Session-Expires header. The given string is copied to the Session-Expires header. Not all the Session-Expires header parameters have separated parameters in the Session-Expires header. Parameters with no specific parameters are referred to as “other-params”.
Get and Set Functions RvSipSessionExpiresHeaderGetStrBadSyntax() RvSipSessionExpiresHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipSessionExpiresHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipSessionExpiresHeaderSetStrBadSyntax() RvSipSessionExpiresHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipSessionExpiresHeaderSetCompactForm() RvSipSessionExpiresHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipSessionExpiresHeaderSetCompactForm( IN RvSipSessionExpiresHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Session-Expires header. bIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipSessionExpiresHeaderGetCompactForm() RvSipSessionExpiresHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the header. SYNTAX RvStatus RvSipSessionExpiresHeaderGetCompactForm ( IN RvSipSessionExpiresHeaderHandle hHeader, IN RvBool pbIsCompact); PARAMETERS hHeader The handle to the Session-Expires header. pbIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
25 SUBSCRIPTION-STATE HEADER FUNCTIONS The Subscription-State header functions enable you to construct, copy, encode, parse, access and change Subscription-State header parameters. This section contains Subscription-State header API functions found in the RvSipSubscriptionStateHeader.h header file.
Control Functions CONTROL FUNCTIONS 732 The Control functions are: RvSipSubscriptionStateHeaderConstructInMsg() RvSipSubscriptionStateHeaderConstruct() RvSipSubscriptionStateHeaderCopy() RvSipSubscriptionStateHeaderEncode() RvSipSubscriptionStateHeaderParse() RvSipSubscriptionStateHeaderParseValue() RvSipSubscriptionStateHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipSubscriptionStateHeaderConstructInMsg() RvSipSubscriptionStateHeaderConstructInMsg() DESCRIPTION Constructs a Subscription-State header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list.
Control Functions RvSipSubscriptionStateHeaderConstruct() RvSipSubscriptionStateHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Subscription-State header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipSubscriptionStateHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipSubscriptionStateHeaderHandle* PARAMETERS hMsgMgr The handle to the MessageMgr.
Control Functions RvSipSubscriptionStateHeaderCopy() RvSipSubscriptionStateHeaderCopy() DESCRIPTION Copies all parameters from a source Subscription-State header to a destination Subscription-State header. You must construct the destination object before using this function.
Control Functions RvSipSubscriptionStateHeaderEncode() RvSipSubscriptionStateHeaderEncode() DESCRIPTION Encodes a Subscription-State header to a textual Subscription-State header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal().
Control Functions RvSipSubscriptionStateHeaderParse() RvSipSubscriptionStateHeaderParse() DESCRIPTION Parses a SIP textual Subscription-State header into a Subscription-State header. An example of a SIP textual Subscription-State header is “Subscription-State: “active”;expires=100”. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipSubscriptionStateHeaderParseValue() RvSipSubscriptionStateHeaderParseValue() DESCRIPTION Parses a SIP textual Subscription-State header value into a Subscription-State header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object.
Control Functions RvSipSubscriptionStateHeaderFix() RvSipSubscriptionStateHeaderFix() DESCRIPTION Fixes a Subscription-State header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header.
Get and Set Functions GET AND SET FUNCTIONS 740 The Get and Set functions are: RvSipSubscriptionStateHeaderGetStringLength() RvSipSubscriptionStateHeaderGetSubstate() RvSipSubscriptionStateHeaderGetStrSubstate() RvSipSubscriptionStateHeaderSetSubstate() RvSipSubscriptionStateHeaderGetReason() RvSipSubscriptionStateHeaderGetStrReason() RvSipSubscriptionStateHeaderSetReason() RvSipSubscriptionStateHeaderGetOtherParams() RvSipSubscriptionStateHeaderSetOtherParams() RvSipSubsc
Get and Set Functions RvSipSubscriptionStateHeaderGetStringLength() RvSipSubscriptionStateHeaderGetStringLength() DESCRIPTION Some of the Subscription-State header parameters are kept in a string format, for example, the Subscription-State header “other-params”. In order to get such a parameter from the Subscription-State header, your application should supply an adequate buffer to where the string will be copied.
Get and Set Functions RvSipSubscriptionStateHeaderGetSubstate() RvSipSubscriptionStateHeaderGetSubstate() DESCRIPTION Gets the substate enumeration value of the subscription-state object. If RVSIP_SUBSCRIPTION_SUBSTATE_OTHER is returned, you can receive the substate string using RvSipSubscriptionStateHeaderGetSubstate(). SYNTAX RvSipSubscriptionSubstate RvSipSubscriptionStateHeaderGetSubstate( IN RvSipSubscriptionStateHeaderHandle PARAMETERS hHeader The handle to the Subscription-State header.
Get and Set Functions RvSipSubscriptionStateHeaderGetStrSubstate() RvSipSubscriptionStateHeaderGetStrSubstate() DESCRIPTION Copies the substate string from the Subscription-State header into a given buffer. Use this function when the substate enumeration returned by RvSipSubscriptionStateHeaderGetSubstate() is RVSIP_SUBSCRIPTION_SUBSTATE_OTHER. If bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipSubscriptionStateHeaderSetSubstate() RvSipSubscriptionStateHeaderSetSubstate() DESCRIPTION Sets the substate parameter in the Subscription-State header. If the enumeration given by eSubstate is RVSIP_SUBSCRIPTION_SUBSTATE_OTHER, sets the substate string given by strSubstate in the Subscription-State header.
Get and Set Functions RvSipSubscriptionStateHeaderGetReason() RvSipSubscriptionStateHeaderGetReason() DESCRIPTION Gets the reason enumeration value of the subscription-state object. If RVSIP_SUBSCRIPTION_REASON_OTHER is returned, you can receive the reason string using RvSipSubscriptionStateHeaderGetStrReason(). SYNTAX RvSipSubscriptionReason RvSipSubscriptionStateHeaderGetReason( IN RvSipSubscriptionStateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Subscription-State header.
Get and Set Functions RvSipSubscriptionStateHeaderGetStrReason() RvSipSubscriptionStateHeaderGetStrReason() DESCRIPTION Copies the reason string from the Subscription-State header into a given buffer. Use this function when the reason enumeration returned by RvSipSubscriptionStateHeaderGetReason() is RVSIP_SUBSCRIPTION_REASON_OTHER. If bufferLen is adequate, the function copies the requested parameter into strBuffer.
Get and Set Functions RvSipSubscriptionStateHeaderSetReason() RvSipSubscriptionStateHeaderSetReason() DESCRIPTION Sets the reason parameter in the Subscription-State header. If the enumeration given by eReason is RVSIP_SUBSCRIPTION_REASON_OTHER, sets the reason string given by strReason in the Subscription-State header. Use RVSIP_SUBSCRIPTION_REASON_OTHER when the substate you wish to set to the Subscription-State header does not have a matching enumeration value in the RvSipSubscriptionReason enumeration.
Get and Set Functions RvSipSubscriptionStateHeaderGetOtherParams() RvSipSubscriptionStateHeaderGetOtherParams() DESCRIPTION Copies the Subscription-State header other-params parameter of the Subscription-State header into a given buffer. Not all the Subscription-State header parameters have separated parameters in the Subscription-State header. Parameters with no specific parameters are referred to as “other-params”.
Get and Set Functions RvSipSubscriptionStateHeaderGetOtherParams() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipSubscriptionStateHeaderSetOtherParams() RvSipSubscriptionStateHeaderSetOtherParams() DESCRIPTION Sets the other-params parameter in the Subscription-State header. Not all the Subscription-State header parameters have separated parameters in the Subscription-State header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipSubscriptionStateHeaderGetExpiresParam() RvSipSubscriptionStateHeaderGetExpiresParam() DESCRIPTION The Subscription-State header may contain an expires parameter. This function returns the expires parameter value. SYNTAX RvInt32 RvSipSubscriptionStateHeaderGetExpiresParam( IN RvSipSubscriptionStateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Subscription-State header. RETURN VALUES Returns the expires parameter value, UNDEFINED if not exists.
Get and Set Functions RvSipSubscriptionStateHeaderSetExpiresParam() RvSipSubscriptionStateHeaderSetExpiresParam() DESCRIPTION Sets an expires parameter in the Subscription-State header. SYNTAX RvStatus RvSipSubscriptionStateHeaderSetExpiresParam( IN RvSipSubscriptionStateHeaderHandle hHeader, IN RvInt32 expiresVal); PARAMETERS hHeader The handle to the Subscription-State header. hExpires The expires value to be set in the Subscription-State header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipSubscriptionStateHeaderGetRetryAfter() RvSipSubscriptionStateHeaderGetRetryAfter() DESCRIPTION The Subscription-State header may contain a retry-after parameter. This function returns this parameter value. SYNTAX RvInt32 RvSipSubscriptionStateHeaderGetRetryAfter( IN RvSipSubscriptionStateHeaderHandle hHeader); PARAMETERS hHeader The handle to the Subscription-State header. RETURN VALUES Returns the retry-after parameter value, UNDEFINED if not exists.
Get and Set Functions RvSipSubscriptionStateHeaderSetRetryAfter() RvSipSubscriptionStateHeaderSetRetryAfter() DESCRIPTION Sets a retry-after parameter in the Subscription-State header. SYNTAX RvStatus RvSipSubscriptionStateHeaderSetRetryAfter( IN RvSipSubscriptionStateHeaderHandle hHeader, IN RvInt32 retryAfterVal); PARAMETERS hHeader The handle to the Subscription-State header. hExpires The retry-after value to be set in the Subscription-State header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipSubscriptionStateHeaderGetStrBadSyntax() RvSipSubscriptionStateHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string.
Get and Set Functions RvSipSubscriptionStateHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipSubscriptionStateHeaderSetStrBadSyntax() RvSipSubscriptionStateHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions 758 HP C SIP Stack Message Layer Reference Guide
26 VIA HEADER FUNCTIONS The Via header functions enable you to construct, copy, encode and parse Via headers and access Via header parameters. This section contains Via header functions found in the RvSipViaHeader.h header file.
Control Functions CONTROL FUNCTIONS 760 The Control functions are: RvSipViaHeaderConstructInMsg() RvSipViaHeaderConstruct() RvSipViaHeaderCopy() RvSipViaHeaderEncode() RvSipViaHeaderParse() RvSipViaHeaderParseValue() RvSipViaHeaderFix() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipViaHeaderConstructInMsg() RvSipViaHeaderConstructInMsg() DESCRIPTION Constructs a Via header inside a given message. The header is kept in the header list of the message. You can choose to insert the header either at the head or tail of the list. SYNTAX RvStatus RvSipViaHeaderConstructInMsg( IN RvSipMsgHandle hSipMsg, IN RvBool pushHeaderAtHead, OUT RvSipViaHeaderHandle* hHeader); PARAMETERS hSipMsg The handle to the message.
Control Functions RvSipViaHeaderConstruct() RvSipViaHeaderConstruct() DESCRIPTION Constructs and initializes a stand-alone Via header. The header is constructed on a given page taken from a specified pool. The handle to the new header is returned. SYNTAX RvStatus RvSipViaHeaderConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipViaHeaderHandle* hPage, hHeader); PARAMETERS hMsgMgr The handle to the MessageMgr. hPool The handle to the memory pool that the object will use.
Control Functions RvSipViaHeaderCopy() RvSipViaHeaderCopy() DESCRIPTION Copies all parameters from a source Via header to a destination Via header. You must construct the destination object before using this function. SYNTAX RvStatus RvSipViaHeaderCopy( INOUT RvSipViaHeaderHandle hDestination, IN hSource); RvSipViaHeaderHandle PARAMETERS hDestination The handle to the destination Via header. hSource The handle to the source Via header. RETURN VALUES Returns RvStatus.
Control Functions RvSipViaHeaderEncode() RvSipViaHeaderEncode() DESCRIPTION Encodes a Via header to a textual Via header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipViaHeaderEncode( IN RvSipViaHeaderHandle hHeader, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS hHeader The handle to the Via header.
Control Functions RvSipViaHeaderParse() RvSipViaHeaderParse() DESCRIPTION Parses a SIP textual Via header into a Via header. All the textual parameters are placed inside the object. For example: “Via: SIP/2.0/UDP h.caller.com”. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipViaHeaderParseValue() RvSipViaHeaderParseValue() DESCRIPTION Parses a SIP textual Via header value into a Via header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipViaHeaderFix() RvSipViaHeaderFix() DESCRIPTION Fixes a Via header with bad-syntax information. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to fix the header by parsing a given correct header-value string to the supplied header. If parsing succeeds, this function places all parameters inside the object and removes the bad-syntax string.
Get and Set Functions GET AND SET FUNCTIONS 768 The Get and Set functions are: RvSipViaHeaderGetStringLength() RvSipViaHeaderGetTransport() RvSipViaHeaderGetStrTransport() RvSipViaHeaderSetTransport() RvSipViaHeaderGetHost() RvSipViaHeaderSetHost() RvSipViaHeaderGetPortNum() RvSipViaHeaderSetPortNum() RvSipViaHeaderGetTtlNum() RvSipViaHeaderSetTtlNum() RvSipViaHeaderGetMaddrParam() RvSipViaHeaderSetMaddrParam() RvSipViaHeaderGetReceivedParam()
Get and Set Functions RvSipViaHeaderGetStringLength() RvSipViaHeaderGetStringLength() DESCRIPTION Some of the Via header parameters are kept in a string format, for example, the host parameter. In order to get such a parameter from the Via header, your application should supply an adequate buffer to where the string will be copied. This function provides you with the length of the string to enable you to allocate an appropriate buffer size before calling the Get function.
Get and Set Functions RvSipViaHeaderGetTransport() RvSipViaHeaderGetTransport() DESCRIPTION Gets the transport protocol enumeration from the Via header. SYNTAX RvSipTransport RvSipViaHeaderGetTransport( IN RvSipViaHeaderHandle hViaHeader); PARAMETERS hViaHeader The handle to the Via header. RETURN VALUES Returns the transport protocol enumeration of the Via header.
Get and Set Functions RvSipViaHeaderGetStrTransport() RvSipViaHeaderGetStrTransport() DESCRIPTION Copies the transport protocol string from the Via header into a given buffer. Use this function if RvSipViaHeaderGetTransport() returns RVSIP_TRANSPORT_OTHER. If the bufferLen size is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipViaHeaderSetTransport() RvSipViaHeaderSetTransport() DESCRIPTION Sets the transport type the Via header. SYNTAX RvStatus RvSipViaHeaderSetTransport( IN RvSipViaHeaderHandle hSipViaHeader, IN RvSipTransport eTransport, IN RvChar* strTransport); PARAMETERS hSipViaHeader The handle to the Via header. eTransport The enumeration transport protocol to set in the object. strTransport You can use this parameter only if the eTransport parameter is set to RVSIP_TRANSPORT_OTHER.
Get and Set Functions RvSipViaHeaderGetHost() RvSipViaHeaderGetHost() DESCRIPTION Copies the host name, send-by parameter, from the Via header into a given buffer. If the bufferLen size is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipViaHeaderSetHost() RvSipViaHeaderSetHost() DESCRIPTION Sets the host parameter in the Via header. SYNTAX RvStatus RvSipViaHeaderSetHost( IN RvSipViaHeaderHandle hViaHeader, IN RvChar* strHost); PARAMETERS hViaHeader The handle to the Via header. strHost The host to be set in the object. If Null is supplied, the existing host string is removed from the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetPortNum() RvSipViaHeaderGetPortNum() DESCRIPTION Gets the host port from the Via header. SYNTAX RvInt32 RvSipViaHeaderGetPortNum( IN RvSipViaHeaderHandle hViaHeader); PARAMETERS hViaHeader The handle to the Via header. RETURN VALUES Returns the port number, or UNDEFINED if the port number does not exist.
Get and Set Functions RvSipViaHeaderSetPortNum() RvSipViaHeaderSetPortNum() DESCRIPTION Sets the host port number of the Via header. SYNTAX RvStatus RvSipViaHeaderSetPortNum( IN RvSipViaHeaderHandle hViaHeader, IN RvInt32 portNum); PARAMETERS hViaHeader The handle to the Via header. portNum The port number value to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetTtlNum() RvSipViaHeaderGetTtlNum() DESCRIPTION Gets the ttl from the Via header. SYNTAX RvInt16 RvSipViaHeaderGetTtlNum( IN RvSipViaHeaderHandle hViaHeader); PARAMETERS hViaHeader The handle to the Via header. RETURN VALUES Returns the ttl number, or UNDEFINED if the ttl does not exist.
Get and Set Functions RvSipViaHeaderSetTtlNum() RvSipViaHeaderSetTtlNum() DESCRIPTION Sets the ttl parameter in the Via header. SYNTAX RvStatus RvSipViaHeaderSetTtlNum( IN RvSipViaHeaderHandle hViaHeader, IN RvInt16 ttlNum); PARAMETERS hViaHeader The handle to the Via header. ttlNum The ttl value to be set in the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetMaddrParam() RvSipViaHeaderGetMaddrParam() DESCRIPTION Copies the maddr parameter of the Via header into a given buffer. If the bufferLen size is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipViaHeaderSetMaddrParam() RvSipViaHeaderSetMaddrParam() DESCRIPTION Sets the maddr string parameter in the Via header. SYNTAX RvStatus RvSipViaHeaderSetMaddrParam( IN RvSipViaHeaderHandle hViaHeader, IN RvChar *strMaddrParam); PARAMETERS hViaHeader The handle to the Via header. strMaddrParam The maddr parameter to be set in the object. If NULL is supplied, the existing maddr parameter string is removed from the object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetReceivedParam() RvSipViaHeaderGetReceivedParam() DESCRIPTION Copies the received parameter of the Via header into a given buffer. If the bufferLen size is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipViaHeaderSetReceivedParam() RvSipViaHeaderSetReceivedParam() DESCRIPTION Sets the value of the received string parameter in the Via header. SYNTAX RvStatus RvSipViaHeaderSetReceivedParam( IN RvSipViaHeaderHandle hViaHeader, IN RvChar* strReceivedParam); PARAMETERS hViaHeader The handle to the Via header. strReceivedParam The received parameter to be set in the object. If NULL is supplied, the existing received parameter string is removed from the object.
Get and Set Functions RvSipViaHeaderGetRportParam() RvSipViaHeaderGetRportParam() DESCRIPTION Gets the rport parameter from the Via header. SYNTAX RvStatus RvSipViaHeaderGetRportParam( IN RvSipViaHeaderHandle hSipViaHeader, OUT RvInt32* rportParam, OUT RvBool* bUseRport); PARAMETERS hSipViaHeader The handle to the Via header. rportParam The rport value (number), or UNDEFINED if the rport parameter is empty. bUseRport Indicates whether or not the rport parameter exists in the header.
Get and Set Functions RvSipViaHeaderSetRportParam() RvSipViaHeaderSetRportParam() DESCRIPTION Sets the rport parameter value in the Via header. SYNTAX RvStatus RvSipViaHeaderSetRportParam( IN RvSipViaHeaderHandle hSipViaHeader, IN RvInt32 rportParam, IN RvBool useRport); PARAMETERS hSipViaHeader The handle to the Via header. rportParam The rport number to be set in the Via header (UNDEFINED is possible for an empty rport parameter).
Get and Set Functions RvSipViaHeaderGetBranchParam() RvSipViaHeaderGetBranchParam() DESCRIPTION Copies the branch parameter from the Via header into a given buffer. If the bufferLen size is adequate, the function copies the parameter into the strBuffer. Otherwise, the function returns RV_ERROR_INSUFFICIENT_BUFFER and the actualLen parameter contains the required buffer length.
Get and Set Functions RvSipViaHeaderSetBranchParam() RvSipViaHeaderSetBranchParam() DESCRIPTION Sets the branch parameter in the Via header. SYNTAX RvStatus RvSipViaHeaderSetBranchParam( IN RvSipViaHeaderHandle hViaHeader, IN RvChar* strBranchParam); PARAMETERS hViaHeader The handle to the Via header. strBranchParam The branch parameter to be set in the object. If NULL is supplied, the existing branch string is removed from the Via header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetHiddenParam() RvSipViaHeaderGetHiddenParam() DESCRIPTION Gets the hidden parameter from the Via header. SYNTAX RvBool RvSipViaHeaderGetHiddenParam( IN RvSipViaHeaderHandle hSipViaHeader); PARAMETERS hSipViaHeader The handle of the Via header. RETURN VALUES Returns the hidden parameter value. If the hidden parameter exists in the Via header, RV_TRUE will be returned. Otherwise returns RV_FALSE.
Get and Set Functions RvSipViaHeaderSetHiddenParam() RvSipViaHeaderSetHiddenParam() DESCRIPTION Sets the hidden parameter in the Via header. If the hidden parameter exists in the Via header, RV_TRUE will be set, Otherwise, RV_FALSE will be set. SYNTAX RvStatus RvSipViaHeaderSetHiddenParam( IN RvSipViaHeaderHandle hSipViaHeader, IN RvBool hiddenValue); PARAMETERS hSipViaHeader The handle of the Via header. hiddenValue The hidden parameter value to set. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetOtherParams() RvSipViaHeaderGetOtherParams() DESCRIPTION Copies the Via header other-params parameter of the Via header into a given buffer. Not all the Via header parameters have separated parameters in the Via header. Parameters with no specific parameters are referred to as “otherparams”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipViaHeaderSetOtherParams() RvSipViaHeaderSetOtherParams() DESCRIPTION Sets the other-params parameter in the Via header. Not all the Via header parameters have separated parameters in the Via header. Parameters with no specific parameters are referred to as “other-params”. They are kept in the object in one concatenated string in the following form: “name=value;name=value...”.
Get and Set Functions RvSipViaHeaderGetRpoolString() RvSipViaHeaderGetRpoolString() DESCRIPTION Copies a string parameter from the Via header into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipViaHeaderGetRpoolString( IN RvSipViaHeaderHandle hSipViaHeader, IN RvSipViaHeaderStringName eStringName, INOUT RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipViaHeader The handle to the Via header. eStringName The string the user wishes to get.
Get and Set Functions RvSipViaHeaderSetRpoolString() RvSipViaHeaderSetRpoolString() DESCRIPTION Sets a string into a specified parameter in the Via header. The given string is located on an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipViaHeaderSetRpoolString( IN RvSipViaHeaderHandle hSipViaHeader, IN RvSipViaHeaderStringName eStringName, IN RPOOL_Ptr *pRpoolPtr); PARAMETERS hSipViaHeader The handle to the Via header. eStringName The string the user wishes to set.
Get and Set Functions RvSipViaHeaderGetStrBadSyntax() RvSipViaHeaderGetStrBadSyntax() DESCRIPTION Copies the bad-syntax string from the header into a given buffer. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. You use this function to retrieve the bad-syntax string. If the value of bufferLen is adequate, this function copies the requested parameter into strBuffer.
Get and Set Functions RvSipViaHeaderGetStrBadSyntax() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderSetStrBadSyntax() RvSipViaHeaderSetStrBadSyntax() DESCRIPTION Sets a bad-syntax string in the object. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the headervalue is kept as a separate bad-syntax string. By using this function you can create a header with a bad-syntax string. Setting a bad-syntax string to the header will mark the header as an invalid syntax header.
Get and Set Functions RvSipViaHeaderSetAliasParam() RvSipViaHeaderSetAliasParam() DESCRIPTION Sets the alias parameter in a Via header. SYNTAX RvStatus RvSipViaHeaderSetAliasParam( IN RvSipViaHeaderHandle hSipViaHeader, IN RvBool bAlias); PARAMETERS hSipViaHeader The handle to the Via header. bAlias Indicates whether or not the alias should be added to the Via header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetAliasParam() RvSipViaHeaderGetAliasParam() DESCRIPTION Gets the alias parameter from the Via header. SYNTAX RvBool RvSipViaHeaderGetAliasParam( IN RvSipViaHeaderHandle hSipViaHeader); PARAMETERS hSipViaHeader The handle to the Via header. RETURN VALUES Returns RV_TRUE if the alias parameter exists. Otherwise returns RV_FALSE.
Get and Set Functions RvSipViaHeaderSetCompactForm() RvSipViaHeaderSetCompactForm() DESCRIPTION Instructs the header to use the compact header name when the header is encoded. SYNTAX RvStatus RvSipViaHeaderSetCompactForm( IN RvSipViaHeaderHandle hHeader, IN RvBool bIsCompact); PARAMETERS hHeader The handle to the Via header. bIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetCompactForm() RvSipViaHeaderGetCompactForm() DESCRIPTION Gets the compact form flag of the header. SYNTAX RvStatus RvSipViaHeaderGetCompactForm( IN RvSipViaHeaderHandle hHeader, IN RvBool *pbIsCompact); PARAMETERS hHeader The handle to the Via header. pbIsCompact Specifies whether or not the header is a compact form header. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipViaHeaderGetCompactForm() 800 HP C SIP Stack Message Layer Reference Guide
27 BODY FUNCTIONS Body object functions enable you to construct, copy, encode, parse, access, add and change body parts and Content-Type. This section contains Body functions found in the RvSipBody.h header file.
Control Functions CONTROL FUNCTIONS 802 The Control functions are: RvSipBodyConstructInMsg() RvSipBodyConstructInBodyPart() RvSipBodyConstruct() RvSipBodyCopy() RvSipBodyEncode() RvSipBodyMultipartParse() HP C SIP Stack Message Layer Reference Guide
Control Functions RvSipBodyConstructInMsg() RvSipBodyConstructInMsg() DESCRIPTION Constructs a body object inside a given message. SYNTAX RvStatus RvSipBodyConstructInMsg( IN RvSipMsgHandle OUT RvSipBodyHandle hSipMsg, *hBody); PARAMETERS hSipMsg The handle to the message related to the new body object. hBody The handle to the newly constructed body object. RETURN VALUES Returns RvStatus.
Control Functions RvSipBodyConstructInBodyPart() RvSipBodyConstructInBodyPart() DESCRIPTION Constructs a body object inside a given body part object. SYNTAX RvStatus RvSipBodyConstructInBodyPart( IN RvSipBodyPartHandle OUT RvSipBodyHandle hBodyPart, *hBody); PARAMETERS hBodyPart The handle to the body part related to the new body object. hBody The handle to the newly constructed body object. RETURN VALUES Returns RvStatus.
Control Functions RvSipBodyConstruct() RvSipBodyConstruct() DESCRIPTION Constructs and initializes a stand-alone body object. The body object is constructed on a given page taken from a specified pool. The handle to the new body object is returned. SYNTAX RvStatus RvSipBodyConstruct( IN RvSipMsgMgrHandle hMsgMgr, IN HRPOOL hPool, IN HPAGE OUT RvSipBodyHandle hPage, *hBody); PARAMETERS hMsgMgr The handle to the MessageMgr. hPool The handle to the memory pool that the object will use.
Control Functions RvSipBodyCopy() RvSipBodyCopy() DESCRIPTION Copies all parameters from a source body object to a destination body object. You must construct the destination object before using this function. SYNTAX RvStatus RvSipBodyCopy( INOUT RvSipBodyHandle hDestination, IN hSource); RvSipBodyHandle PARAMETERS hDestination The handle to the destination body object. hSource The handle to the source body object. RETURN VALUES Returns RvStatus.
Control Functions RvSipBodyEncode() RvSipBodyEncode() DESCRIPTION Encodes a body object to a textual body. The encoded body is placed on a page taken from a specified pool. To copy the encoded body from the page to a consecutive buffer, use RPOOL_CopyToExternal(). If this function returns RV_OK, the application must free the allocated page by using RPOOL_FreePage().
Control Functions RvSipBodyEncode() REMARKS The manner in which the body is encoded depends on the body part type, as follows: Multipart body type Each body part is encoded. The body parts are separated by a boundary delimiter line. The boundary delimiter line is created using the boundary parameter found in the Content-Type of the body object. If no boundary is defined for this body object, a unique boundary is generated and the boundary delimiter line is created accordingly.
Control Functions RvSipBodyMultipartParse() RvSipBodyMultipartParse() DESCRIPTION Parses a SIP textual body of type multipart into a body object. The given body object must have a valid Content-Type header on its list of headers. The Content-Type header must contain the boundary that was used to create the boundary delimiter lines that separated the different parts of the body. The parsing will be done according to this boundary. See the Example below.
Control Functions unique-boundary-1 Content-Type: application; charset=ISO-10646 v=0 o=audet 2890844526 2890842807 5 IN IP4 134.177.64.4 c=IN IP4 MG141.nortelnetworks.com t= 2873397496 2873404696 m=audio 9092 AVP 0 3 4 unique-boundary-1 Content-type:application/QSIG; version=iso 08 02 55 55 05 04 02 90 90 18 03 a1 83 01 70 0a 89 31 34 30 38 34 39 35 35 30 37 32 unique-boundary-1 The body parts are separated into a list of body parts within the body object.
Get and Set Functions GET AND SET FUNCTIONS The Get and Set functions are: RvSipBodyGetContentType() RvSipBodySetContentType() RvSipBodyGetBodyStrLength() RvSipBodyGetBodyStr() RvSipBodySetBodyStr() RvSipBodyGetBodyPart() RvSipBodyPushBodyPart() RvSipBodyRemoveBodyPart() RvSipBodyGetRpoolString() RvSipBodySetRpoolString() Body Functions 811
Get and Set Functions RvSipBodyGetContentType() RvSipBodyGetContentType() DESCRIPTION Gets the Content-Type header from the body object. SYNTAX RvSipContentTypeHeaderHandle RvSipBodyGetContentType( IN RvSipBodyHandle hBody); PARAMETERS hBody The handle to the body object. RETURN VALUES Returns the Content-Type header handle, or NULL if there is no Content-Type for this body object.
Get and Set Functions RvSipBodySetContentType() RvSipBodySetContentType() DESCRIPTION Sets the Content-Type header in the body object. SYNTAX RvStatus RvSipBodySetContentType( IN RvSipBodyHandle hBody, IN RvSipContentTypeHeaderHandle hContentType); PARAMETERS hBody The handle to the body object. hContentType Content-Type header to be set in the body object. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipBodyGetBodyStrLength() RvSipBodyGetBodyStrLength() DESCRIPTION Gets the length of the body string. SYNTAX RvUint32 RvSipBodyGetBodyStrLength( IN RvSipBodyHandle hBody); PARAMETERS hBody The handle to the body object. RETURN VALUES The length of the body string. REMARKS If the body is of type multipart, it might contain a list of body parts.
Get and Set Functions RvSipBodyGetBodyStr() RvSipBodyGetBodyStr() DESCRIPTION Gets the string of the body. SYNTAX RvStatus RvSipBodyGetBodyStr( IN RvSipBodyHandle hBody, IN RvChar *strBuffer, IN RvUint bufferLen OUT RvUint* actualLen); PARAMETERS hBody The handle to the body object. strBuffer The buffer with which to fill the body string. The body string does not necessarily end with '\0'. The body string might contain '\0' as part of the body string. bufferLen The length of the buffer.
Get and Set Functions RvSipBodyGetBodyStr() only use this function when the body does not contain a list of body parts. If you would like to get the body string of a body object in the format of body parts list, use RvSipBodyEncode() and then the RPOOL_CopyToExternal() function. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipBodySetBodyStr() RvSipBodySetBodyStr() DESCRIPTION Sets a textual body to the body object. The textual body is copied and saved in the body object. SYNTAX RvStatus RvSipBodySetBodyStr( IN RvSipBodyHandle hBody, IN RvChar *rawBuffer, IN RvUint32 length); PARAMETERS hBody The handle to the body object. rawBuffer The buffer to set to the body object. length The length of the buffer. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipBodyGetBodyPart() RvSipBodyGetBodyPart() DESCRIPTION Gets a body part from the body parts list. The body object holds the body part objects in a sequential list. SYNTAX RvStatus RvSipBodyGetBodyPart( IN RvSipBodyHandle hBody, IN RvSipListLocation location, IN RvSipBodyPartHandle hRelative, OUT RvSipBodyPartHandle *hBodyPart); PARAMETERS hBody Handle of the body object. location The location in the list: next, previous, first or last.
Get and Set Functions RvSipBodyGetBodyPart() REMARKS Use the location parameter to specify the location of the body part you wish to get. When using the next or prev locatopns, you must supply a relative body part. For example, in order to get the second body part from the list, you must first get the first body part. You should then ask for the next body part when the first body part serves as a relative header.
Get and Set Functions RvSipBodyPushBodyPart() RvSipBodyPushBodyPart() DESCRIPTION Inserts a given body part into the body parts list based on a given location, which can be first, last, before or after a given relative element. The body part you supply is copied before it is inserted into the list. The function returns the handle to the body part object that was actually inserted into the list. This body part can be used in a following call to this function as the relative body part.
Get and Set Functions RvSipBodyPushBodyPart() RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipBodyRemoveBodyPart() RvSipBodyRemoveBodyPart() DESCRIPTION Removes a body part from the body parts list. You should supply to this function the handle to the body part you wish to remove. SYNTAX RvStatus RvSipBodyRemoveBodyPart( IN RvSipBodyHandle hBody, IN RvSipBodyPartHandle hBodyPart); PARAMETERS hBody The handle to the body object. hBodyPart The handle to the body part to be removed. RETURN VALUES Returns RvStatus.
Get and Set Functions RvSipBodyGetRpoolString() RvSipBodyGetRpoolString() DESCRIPTION Copies the body string from the body object into a given page from a specified pool. The copied string is not consecutive. SYNTAX RvStatus RvSipBodyGetRpoolString( IN RvSipBodyHandle INOUT RPOOL_Ptr hBody, *pRpoolPtr); PARAMETERS hBody The handle to the body object. pRpoolPtr A pointer to a location inside a RPOOL memory object. You need to supply only the pool and page.
Get and Set Functions RvSipBodySetRpoolString() RvSipBodySetRpoolString() DESCRIPTION Sets a body string into a body object. The given string is located on an RPOOL memory and is not consecutive. SYNTAX RvStatus RvSipBodySetRpoolString( IN RvSipBodyHandle hBody, IN RPOOL_Ptr *pRpoolPtr, IN RvUint32 length); PARAMETERS hBody The handle to the body object. pRpoolPtr A pointer to a location inside an RPOOL where the new string is located. length The body length +1 for the terminating “\0” character.
28 FUNCTIONS FOR ALL HEADERS These functions allow you to encode, parse and parseValue every header (without using the header-specific functions). The functions receive the header type as a parameter and, according to this parameter, call the header specificfunction. This section contains functions that can be used for all headers, and are found in the RvSipHeader.h header file.
Control Functions RvSipHeaderEncode() CONTROL FUNCTIONS RvSipHeaderEncode() DESCRIPTION Encodes a header of any type to a textual header. The textual header is placed on a page taken from a specified pool. To copy the textual header from the page to a consecutive buffer, use RPOOL_CopyToExternal(). SYNTAX RvStatus RvSipHeaderEncode( IN void* pHeader, IN RvSipHeaderType eType, IN HRPOOL hPool, OUT HPAGE* hPage, OUT RvUint32* length); PARAMETERS pHeader The handle to the header structure.
Control Functions RvSipHeaderParse() RvSipHeaderParse() DESCRIPTION Parses a SIP textual header, of any type, into a header. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters. Therefore, if the parse function fails, you will not be able to get the previous header parameter values.
Control Functions RvSipHeaderParseValue() RvSipHeaderParseValue() DESCRIPTION Parses a SIP textual header value, of any header type, into a header. A SIP header has the following grammar: “header-name:header-value”. This function takes the header-value part as a parameter and parses it into the supplied object. All the textual parameters are placed inside the object. Note Before performing the parse operation, the SIP Stack resets all the header parameters.
Control Functions RvSipHeaderIsBadSyntax() RvSipHeaderIsBadSyntax() DESCRIPTION Checks if the given header is a bad-syntax header or not. A SIP header has the following grammar: “header-name:header-value”. When a header contains a syntax error, the header-value is kept as a separate bad-syntax string. Use this function to check whether or not this header contains a bad-syntax string.
Control Functions RvSipHeaderIsBadSyntax() 830 HP C SIP Stack Message Layer Reference Guide
TYPE DEFINITIONS AND STATUS CODES This part includes the following sections: Message Type Definitions
29 MESSAGE TYPE DEFINITIONS This section includes The SIP Stack Message type definitions defined in the RvSipMsgTypes.h and RvSipXXXHeader.h header files.
Handle Type Definitions HANDLE TYPE DEFINITIONS 834 The Handle type definitions are: RvSipAddressHandle RvSipAllowEventsHeaderHandle RvSipAllowHeaderHandle RvSipAuthenticationHeaderHandle RvSipAuthorizationHeaderHandle RvSipBodyHandle RvSipBodyPartHandle RvSipContactHeaderHandle RvSipContentDispositionHeaderHandle RvSipContentTypeHeaderHandle RvSipCSeqHeaderHandle RvSipDateHeaderHandle RvSipEventHeaderHandle RvSipExpiresHeaderHandle RvSipHeade
Handle Type Definitions RvSipAddressHandle RvSipAddressHandle DESCRIPTION The handle to the SIP address object.
Handle Type Definitions RvSipAllowEventsHeaderHandle RvSipAllowEventsHeaderHandle DESCRIPTION The handle of the Allow-Events header.
Handle Type Definitions RvSipAllowHeaderHandle RvSipAllowHeaderHandle DESCRIPTION The handle to the Allow header.
Handle Type Definitions RvSipAuthenticationHeaderHandle RvSipAuthenticationHeaderHandle DESCRIPTION The handle to the Authentication header.
Handle Type Definitions RvSipAuthorizationHeaderHandle RvSipAuthorizationHeaderHandle DESCRIPTION The handle to the Authorization header.
Handle Type Definitions RvSipBodyHandle RvSipBodyHandle DESCRIPTION The handle of the message body object.
Handle Type Definitions RvSipBodyPartHandle RvSipBodyPartHandle DESCRIPTION The handle of the message body part object.
Handle Type Definitions RvSipContentDispositionHeaderHandle RvSipContentDispositionHeaderHandle DESCRIPTION The handle of the Content-Disposition header.
Handle Type Definitions RvSipContactHeaderHandle RvSipContactHeaderHandle DESCRIPTION The handle to the Contact header.
Handle Type Definitions RvSipContentTypeHeaderHandle RvSipContentTypeHeaderHandle DESCRIPTION The handle of the Content-Type header.
Handle Type Definitions RvSipCSeqHeaderHandle RvSipCSeqHeaderHandle DESCRIPTION The handle to the CSeq header.
Handle Type Definitions RvSipDateHeaderHandle RvSipDateHeaderHandle DESCRIPTION The handle of the Date header.
Handle Type Definitions RvSipEventHeaderHandle RvSipEventHeaderHandle DESCRIPTION The handle of the Event header.
Handle Type Definitions RvSipExpiresHeaderHandle RvSipExpiresHeaderHandle DESCRIPTION The handle of the expires header.
Handle Type Definitions RvSipHeadersListElemHandle RvSipHeadersListElemHandle DESCRIPTION The handle to the position of one element in the header list. This handle is used for getting and setting headers in the header list.
Handle Type Definitions RvSipMinSEHeaderHandle RvSipMinSEHeaderHandle DESCRIPTION The handle of the min-se header.
Handle Type Definitions RvSipMsgHandle RvSipMsgHandle DESCRIPTION The handle to the message.
Handle Type Definitions RvSipMsgMgrHandle RvSipMsgMgrHandle DESCRIPTION The handle to the MessageMgr.
Handle Type Definitions RvSipOtherHeaderHandle RvSipOtherHeaderHandle DESCRIPTION The handle to the Other header.
Handle Type Definitions RvSipPartyHeaderHandle RvSipPartyHeaderHandle DESCRIPTION The handle to the Party header.
Handle Type Definitions RvSipRAckHeaderHandle RvSipRAckHeaderHandle DESCRIPTION The handle of the RAck header.
Handle Type Definitions RvSipReferredByHeaderHandle RvSipReferredByHeaderHandle DESCRIPTION The handle of the Referred-By header.
Handle Type Definitions RvSipReferToHeaderHandle RvSipReferToHeaderHandle DESCRIPTION The handle of the Refer-To header.
Handle Type Definitions RvSipReplacesHeaderHandle RvSipReplacesHeaderHandle DESCRIPTION The handle of the Replaces header.
Handle Type Definitions RvSipRetryAfterHeaderHandle RvSipRetryAfterHeaderHandle DESCRIPTION The handle of the Retry-After header.
Handle Type Definitions RvSipRouteHopHeaderHandle RvSipRouteHopHeaderHandle DESCRIPTION The handle of the Route-Hop header.
Handle Type Definitions RvSipRSeqHeaderHandle RvSipRSeqHeaderHandle DESCRIPTION The handle of the RSeq header.
Handle Type Definitions RvSipSessionExpiresHeaderHandle RvSipSessionExpiresHeaderHandle DESCRIPTION The handle of the Session-Expires header.
Handle Type Definitions RvSipSubscriptionStateHeaderHandle RvSipSubscriptionStateHeaderHandle DESCRIPTION The handle of the Subscription-State header.
Handle Type Definitions RvSipViaHeaderHandle RvSipViaHeaderHandle DESCRIPTION The handle to the Via header.
String Name Type Definitions STRING NAME TYPE DEFINITIONS The String Name type definitions are: RvSipAddressStringName RvSipAllowEventsHeaderStringName RvSipAllowHeaderStringName RvSipAuthenticationHeaderStringName RvSipAuthorizationHeaderStringName RvSipContactHeaderStringName RvSipContentDispositionHeaderStringName RvSipContentTypeHeaderStringName RvSipCSeqHeaderStringName RvSipDateHeaderStringName RvSipEventHeaderStringName RvSipExpiresHeaderStr
String Name Type Definitions RvSipAddressStringName RvSipAddressStringName DESCRIPTION Defines all address parameters that are kept in the object in a string format. This enumeration is defined in the RvSipAddress.h header file.
String Name Type Definitions RvSipAllowEventsHeaderStringName RvSipAllowEventsHeaderStringName DESCRIPTION Defines all Allow-Events header parameters that are kept in the object in string format. This enumeration is defined in the RvSipAllowEventsHeader.h header file.
String Name Type Definitions RvSipAllowHeaderStringName RvSipAllowHeaderStringName DESCRIPTION Defines all Allow header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipAllowHeader.h header file.
String Name Type Definitions RvSipAuthenticationHeaderStringName RvSipAuthenticationHeaderStringName DESCRIPTION Defines all Authentication header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipAuthenticationHeader.h header file.
String Name Type Definitions RvSipAuthorizationHeaderStringName RvSipAuthorizationHeaderStringName DESCRIPTION Defines all Authorization header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipAuthorizationHeader.h header file.
String Name Type Definitions RvSipContactHeaderStringName RvSipContactHeaderStringName DESCRIPTION Defines all Contact header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipContactHeader.h header file.
String Name Type Definitions RvSipContentDispositionHeaderStringName RvSipContentDispositionHeaderStringName DESCRIPTION Defines all Content-Disposition header parameters that are kept in the object in a string format.This enumeration is defined in the RvSipContentDispositionHeader.h header file.
String Name Type Definitions RvSipContentTypeHeaderStringName RvSipContentTypeHeaderStringName DESCRIPTION Defines all Content-Type header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipContentTypeHeader.h header file.
String Name Type Definitions RvSipCSeqHeaderStringName RvSipCSeqHeaderStringName DESCRIPTION Defines all CSeq header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipCSeqHeader.h header file.
String Name Type Definitions RvSipDateHeaderStringName RvSipDateHeaderStringName DESCRIPTION Defines all Date header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipDateHeader.h header file.
String Name Type Definitions RvSipEventHeaderStringName RvSipEventHeaderStringName DESCRIPTION Defines all Event header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipEventHeader.h header file.
String Name Type Definitions RvSipExpiresHeaderStringName RvSipExpiresHeaderStringName DEFINITION Defines all Expires header parameters that are kept in the object in string format. This enumeration is defined in the RvSipExpiresHeader.h header file.
String Name Type Definitions RvSipMessageStringName RvSipMessageStringName DESCRIPTION Defines all message parameters that are kept in the object in a string format. This enumeration is defined in the RvSipMsg.h header file.
String Name Type Definitions RvSipMinSEHeaderStringName RvSipMinSEHeaderStringName DESCRIPTION Defines all Min-SE header parameters that are kept in the object in string format. This enumeration is defined in the RvSipMinSEHeader.h header file.
String Name Type Definitions RvSipOtherHeaderStringName RvSipOtherHeaderStringName DESCRIPTION Defines all Other header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipOtherHeader.h header file.
String Name Type Definitions RvSipPartyHeaderStringName RvSipPartyHeaderStringName DESCRIPTION Defines all Party header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipPartyHeader.h header file.
String Name Type Definitions RvSipRAckHeaderStringName RvSipRAckHeaderStringName DEFINITION Defines all RAck header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipRAckHeader.h header file.
String Name Type Definitions RvSipReferredByHeaderStringName RvSipReferredByHeaderStringName DESCRIPTION Defines all the Referred-By header parameters that are kept in the object in string format. This enumeration is defined in the RvSipReferredByHeader.h header file.
String Name Type Definitions RvSipReferToHeaderStringName RvSipReferToHeaderStringName DESCRIPTION Defines all Refer-To header parameters that are kept in the object in string format. This enumeration is defined in the RvSipReferToHeader.h header file.
String Name Type Definitions RvSipReplacesHeaderStringName RvSipReplacesHeaderStringName DESCRIPTION Defines all Replaces header parameters that are kept in the object in string format. This enumeration is defined in the RvSipReplacesHeader.h header file.
String Name Type Definitions RvSipRetryAfterHeaderStringName RvSipRetryAfterHeaderStringName DESCRIPTION Defines all Retry-After header parameters that are kept in the object in string format. This enumeration is defined in the RvSipRetryAfterHeader.h header file.
String Name Type Definitions RvSipRouteHopHeaderStringName RvSipRouteHopHeaderStringName DESCRIPTION Defines all the Route-Hop header parameters that are kept in the object in string format. This enumeration is defined in the RvSipRouteHopHeader.h header file.
String Name Type Definitions RvSipRSeqHeaderStringName RvSipRSeqHeaderStringName DESCRIPTION Defines all RSeq header parameters that are kept in the object in string format. This enumeration is defined in the RvSipRSeqHeader.h header file.
String Name Type Definitions RvSipSessionExpiresHeaderStringName RvSipSessionExpiresHeaderStringName DESCRIPTION Defines all Session-Expires header parameters that are kept in the object in string format. This enumeration is defined in the RvSipSessionExpiresHeader.h header file.
String Name Type Definitions RvSipSubscriptionStateHeaderStringName RvSipSubscriptionStateHeaderStringName DESCRIPTION Defines all Subscription-State header parameters that are kept in the object in string format. This enumeration is defined in the RvSipSubscriptionStateHeader.h header file.
String Name Type Definitions RvSipViaHeaderStringName RvSipViaHeaderStringName DESCRIPTION Defines all Via header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipViaHeader.h header file.
String Name Type Definitions RvSipReplacesHeaderStringName RvSipReplacesHeaderStringName DESCRIPTION Defines all Replaces header parameters that are kept in the object in a string format. This enumeration is defined in the RvSipReplacesHeader.h header file.
String Name Type Definitions RvSipAuthenticationInfoHeaderStringName RvSipAuthenticationInfoHeaderStringName DESCRIPTION Defines all Authentication-Info header fields that are kept in the object in a string format. This enumeration is defined in the RvSipAuthenticationInfoHeader.h header file.
Message API Type Definitions MESSAGE API TYPE DEFINITIONS 894 The Message API type definitions are: RvSipAddressType RvSipAuthAlgorithm RvSipAuthQopOption RvSipAuthScheme RvSipAuthStale RvSipAuthenticationHeaderType RvSipAuthorizationHeaderType RvSipContactAction RvSipDateMonth RvSipDateWeekDay RvSipDispositionType RvSipDispositionHandling RvSipExpiresFormat RvSipHeadersLocation RvSipHeaderType RvSipMediaType RvSipMediaSubType RvSipMethodType
Message API Type Definitions RvSipAddressType RvSipAddressType DESCRIPTION The enumeration of the SIP address types for use in the address object.
Message API Type Definitions RvSipAuthAlgorithm RvSipAuthAlgorithm DESCRIPTION The enumeration used to indicate for the authentication algorithm type.
Message API Type Definitions RvSipAuthQopOption RvSipAuthQopOption DESCRIPTION The enumeration used to indicate the authentication Qop options.
Message API Type Definitions RvSipAuthScheme RvSipAuthScheme DESCRIPTION The enumeration used to indicate the authentication scheme.
Message API Type Definitions RvSipAuthStale RvSipAuthStale DESCRIPTION The enumeration used to indicate the authentication stale parameter.
Message API Type Definitions RvSipAuthenticationHeaderType RvSipAuthenticationHeaderType DESCRIPTION Indicates whether the Authentication header is a WWW–Authenticate header or a Proxy–Authenticate header. This enumeration is defined in the RvSipAuthenticationHeader.h file.
Message API Type Definitions RvSipAuthorizationHeaderType RvSipAuthorizationHeaderType DESCRIPTION Indicates whether the Authorization header is a WWW–Authorization header or a Proxy–Authorization header. This enumeration is defined in the RvSipAuthorizationHeader.h file.
Message API Type Definitions RvSipContactAction RvSipContactAction DESCRIPTION This enumeration is used to indicate the contact action.
Message API Type Definitions RvSipDateMonth RvSipDateMonth DESCRIPTION The enumeration used to indicate the month within a given date.
Message API Type Definitions RvSipDateWeekDay RvSipDateWeekDay DESCRIPTION The enumeration used to indicate the week day within a given date.
Message API Type Definitions RvSipDispositionType RvSipDispositionType DESCRIPTION Indicates the disposition type of a Content-Disposition header.
Message API Type Definitions RvSipDispositionHandling RvSipDispositionHandling DESCRIPTION Indicates the handling type of a Content-Disposition header.
Message API Type Definitions RvSipExpiresFormat RvSipExpiresFormat DESCRIPTION The enumeration used to indicate the format of a given Expires header. If the header is not initialized the format is undefined. An initialized Expires header can either contain a Date header or an integer indicating delta-seconds time.
Message API Type Definitions RvSipHeadersLocation RvSipHeadersLocation DESCRIPTION The enumeration used for retrieving parameters from the header list. The parameter indicate the location the header you wish to retrieve.
Message API Type Definitions RvSipHeaderType RvSipHeaderType DESCRIPTION Defines the header types of a SIP message.
Message API Type Definitions RvSipHeaderType RVSIP_HEADERTYPE_REASON, RVSIP_HEADERTYPE_WARNING, RVSIP_HEADERTYPE_TIMESTAMP, RVSIP_HEADERTYPE_INFO, RVSIP_HEADERTYPE_ACCEPT, /* 30 */ RVSIP_HEADERTYPE_ACCEPT_ENCODING, RVSIP_HEADERTYPE_ACCEPT_LANGUAGE, RVSIP_HEADERTYPE_REPLY_TO }RvSipHeaderType; REMARKS Defines the header types that are stored in the headers list in a SIP message.
Message API Type Definitions RvSipMediaType RvSipMediaType DESCRIPTION Indicates the media type of the message body. The media type enumeration is found in the Content-Type header (The Content-Type has the format of ContentType: media type/media sub type). When the media type is not set, it has the value of RVSIP_MEDIATYPE_UNDEFINED.
Message API Type Definitions RvSipMediaSubType RvSipMediaSubType DESCRIPTION Indicates the media sub-type of the message body. The media sub-type enumeration is found in the Content-Type header (The Content-Type has the format of Content-Type: media type/media sub type). When the media sub-type is not set, it has the value of RVSIP_MEDIASUBTYPE_UNDEFINED.
Message API Type Definitions RvSipMethodType RvSipMethodType DESCRIPTION Defines the methods supported by the SIP Stack.
Message API Type Definitions RvSipMsgHeadersOption RvSipMsgHeadersOption DESCRIPTION Defines which type of headers the user wishes to get in the following functions: RvSipMsgGetHeaderExt RvSipMsgGetHeaderByTypeExt RvSipMsgGetHeaderByNameExt SYNTAX typedef enum{ RVSIP_MSG_HEADERS_OPTION_UNDEFINED = -1, RVSIP_MSG_HEADERS_OPTION_LEGAL_SYNTAX, RVSIP_MSG_HEADERS_OPTION_ALL }RvSipMsgHeadersOption; PARAMETERS RVSIP_MSG_HEADERS_OPTION_LEGAL_SYNTAX Only legal headers, with no syntax errors.
Message API Type Definitions RvSipMsgType RvSipMsgType DESCRIPTION Determines the type of message: request or response. SYNTAX typedef enum{ RVSIP_MSG_UNDEFINED = -1, RVSIP_MSG_REQUEST, RVSIP_MSG_RESPONSE }RvSipMsgType; PARAMETERS RVSIP_MSG_UNDEFINED Undefined message type. RVSIP_MSG_REQUEST Request message type. RVSIP_MSG_RESPONSE Response message type.
Message API Type Definitions RvSipReplacesEarlyFlagType RvSipReplacesEarlyFlagType DESCRIPTION Defines how the early-only parameter was received (early-only, early-only=true, early-only=1).
Message API Type Definitions RvSipRouteHopHeaderType RvSipRouteHopHeaderType DESCRIPTION Defines whether the Route-Hop header represents a Route or Record-Route header. This enumeration is defined in the RvSipRouteHopHeader.h file.
Message API Type Definitions RvSipSessionExpiresRefresherType RvSipSessionExpiresRefresherType DESCRIPTION For use when the session timer feature is enabled. SYNTAX typedef enum{ RVSIP_SESSION_EXPIRES_REFRESHER_NONE = -1, RVSIP_SESSION_EXPIRES_REFRESHER_UAC, RVSIP_SESSION_EXPIRES_REFRESHER_UAS }RvSipSessionExpiresRefresherType; PARAMETERS RVSIP_SESSION_EXPIRES_REFRESHER_NONE The refresher side of the call has not been set. RVSIP_SESSION_EXPIRES_REFRESHER_UAC The refresher of the call is the UAC.
Message API Type Definitions RvSipSubscriptionReason RvSipSubscriptionReason DESCRIPTION Indicates the reason in the Subscription-State header.
Message API Type Definitions RvSipSubscriptionSubstate RvSipSubscriptionSubstate DESCRIPTION Indicates the substate in the Subscription-State header.
Message API Type Definitions RvSipTelUriEnumdiType RvSipTelUriEnumdiType DESCRIPTION Indicates the enumdi type of a TEL URI address. SYNTAX typedef enum{ RVSIP_ENUMDI_TYPE_UNDEFINED = -1, RVSIP_ENUMDI_TYPE_EXISTS_EMPTY }RvSipTelUriEnumdiType; PARAMETERS RVSIP_ENUMDI_TYPE_UNDEFINED The enumdi parameter was not found in the TEL URI address. RVSIP_ENUMDI_TYPE_EXISTS_EMPTY The enumdi parameter (";enumdi") was found in the TEL URI address.
Message API Type Definitions RvSipTransport RvSipTransport DESCRIPTION Determines the transport protocol to be used for sending SIP requests and responses. SYNTAX typedef enum{ RVSIP_TRANSPORT_UNDEFINED = -1, RVSIP_TRANSPORT_UDP, RVSIP_TRANSPORT_TCP, RVSIP_TRANSPORT_TLS, RVSIP_TRANSPORT_OTHER }RvSipTransport; PARAMETERS RVSIP_TRANSPORT_UNDEFINED Undefined transport protocol. RVSIP_TRANSPORT_UDP UDP transport protocol. RVSIP_TRANSPORT_TCP TCP transport protocol. RVSIP_TRANSPORT_TLS TLS transport protocol.
Message API Type Definitions RvSipUserParam RvSipUserParam DESCRIPTION The enumeration of the user-param parameter of the SIP-URL. SYNTAX typedef enum{ RVSIP_USERPARAM_UNDEFINED, RVSIP_USERPARAM_PHONE, RVSIP_USERPARAM_IP, RVSIP_USERPARAM_OTHER }RvSipUserParam; PARAMETERS RVSIP_USERPARAM_UNDEFINED Undefined user parameter. RVSIP_USERPARAM_PHONE Indicates that the SIP URL contains a phone number. RVSIP_USERPARAM_IP Indicates that the SIP URL contains either a host name or an IP address.
Message API Type Definitions RvSipUrlScheme RvSipUrlScheme DESCRIPTION The enumeration of the SIP-URL scheme. SYNTAX typedef enum{ RVSIP_URL_SCHEME_UNDEFINED = -1, RVSIP_URL_SCHEME_SIP, RVSIP_URL_SCHEME_SIPS }RvSipUrlScheme; PARAMETERS RVSIP_URL_SCHEME_UNDEFINED The URL scheme is undefined. RVSIP_URL_SCHEME_SIP The URL scheme is “SIP”. RVSIP_URL_SCHEME_SIPS The URL scheme is “SIPS”.
Message API Type Definitions RvSipUrlLrParamType RvSipUrlLrParamType DEFINITION The enumeration that defines how the lr parameter is kept in the SIP address: lr; lr=1; lr=true; SYNTAX typedef enum{ RVSIP_URL_LR_TYPE_UNDEFINED = -1, RVSIP_URL_LR_TYPE_EMPTY, RVSIP_URL_LR_TYPE_1, RVSIP_URL_LR_TYPE_TRUE, RVSIP_URL_LR_TYPE_ON }RvSipUrlLrType; PARAMETERS RVSIP_URL_LR_TYPE_UNDEFINED The URL lr parameter type is undefined. RVSIP_URL_LR_TYPE_EMPTY The URL lr parameter is kept as “lr;”.
Message API Type Definitions RvSipUrlLrParamType 926 HP C SIP Stack Message Layer Reference Guide
INDEX R RvSipAddrAbsUriGetIdentifier() 124 RvSipAddrAbsUriGetScheme() 122 RvSipAddrAbsUriSetIdentifier() 125 RvSipAddrAbsUriSetScheme() 123 RvSipAddrConstruct() 78 RvSipAddrConstructInAuthorizationHeader() 74 RvSipAddrConstructInContactHeader() 73 RvSipAddrConstructInPartyHeader() 72 RvSipAddrConstructInReferredByHeader() 77 RvSipAddrConstructInReferToHeader() 76 RvSipAddrConstructInRouteHopHeader() 75 RvSipAddrConstructInStartLine() 71 RvSipAddrCopy() 79 RvSipAddrEncode() 80 RvSipAddressHandle 835 RvSipAd
RvSipAddrUrlSetIsSecure() 120 RvSipAddrUrlSetLrParam() 99 RvSipAddrUrlSetLrParamType() 101 RvSipAddrUrlSetMaddrParam() 109 RvSipAddrUrlSetMethod() 104 RvSipAddrUrlSetOtherParams() 118 RvSipAddrUrlSetPortNum() 95 RvSipAddrUrlSetTransport() 107 RvSipAddrUrlSetTtlNum() 97 RvSipAddrUrlSetUser() 91 RvSipAddrUrlSetUserParam() 112 RvSipAllowEventsHeaderConstruct() 164 RvSipAllowEventsHeaderConstructInMsg() 163 RvSipAllowEventsHeaderCopy() 165 RvSipAllowEventsHeaderEncode() 166 RvSipAllowEventsHeaderFix() 169 RvSip
RvSipAuthenticationHeaderGetStrAuthSchem e() 196 RvSipAuthenticationHeaderGetStrBadSyntax( ) 222 RvSipAuthenticationHeaderGetStrCipherKey() 229 RvSipAuthenticationHeaderGetStringLength() 194 RvSipAuthenticationHeaderGetStrIntegrityKey () 227 RvSipAuthenticationHeaderGetStrQop() 206 RvSipAuthenticationHeaderHandle 838 RvSipAuthenticationHeaderParse() 189 RvSipAuthenticationHeaderParseValue() 190 RvSipAuthenticationHeaderSetAKAVersion() 226 RvSipAuthenticationHeaderSetAuthAlgorithm( ) 212 RvSipAuthenticationH
RvSipAuthorizationHeaderConstructInMsg() 261 RvSipAuthorizationHeaderCopy() 263 RvSipAuthorizationHeaderEncode() 264 RvSipAuthorizationHeaderFix() 267 RvSipAuthorizationHeaderGetAuthAlgorithm() 286 RvSipAuthorizationHeaderGetAuthScheme() 273 RvSipAuthorizationHeaderGetCNonce() 293 RvSipAuthorizationHeaderGetCredentialIdenti fier() 271 RvSipAuthorizationHeaderGetDigestUri() 295 RvSipAuthorizationHeaderGetHeaderType() 297 RvSipAuthorizationHeaderGetIntegrityProtect ed() 309 RvSipAuthorizationHeaderGetNonce()
RvSipBodyGetBodyStrLength() 814 RvSipBodyGetContentType() 812 RvSipBodyGetRpoolString() 823 RvSipBodyHandle 840 RvSipBodyMultipartParse() 809 RvSipBodyPartHandle 841 RvSipBodyPushBodyPart() 820 RvSipBodyRemoveBodyPart() 822 RvSipBodySetBodyStr() 817 RvSipBodySetContentType() 813 RvSipBodySetRpoolString() 824 RvSipContactAction 902 RvSipContactHeaderConstruct() 314 RvSipContactHeaderConstructInMsg() 313 RvSipContactHeaderCopy() 315 RvSipContactHeaderEncode() 316 RvSipContactHeaderFix() 319 RvSipContactHeader
RvSipContentTypeHeaderGetBase() 388 RvSipContentTypeHeaderGetBoundary() 384 RvSipContentTypeHeaderGetCompactForm() 397 RvSipContentTypeHeaderGetMediaSubType( ) 381 RvSipContentTypeHeaderGetMediaType() 378 RvSipContentTypeHeaderGetOtherParams() 390 RvSipContentTypeHeaderGetStrBadSyntax() 393 RvSipContentTypeHeaderGetStringLength() 377 RvSipContentTypeHeaderGetStrMediaSubTy pe() 382 RvSipContentTypeHeaderGetStrMediaType() 379 RvSipContentTypeHeaderGetVersion() 386 RvSipContentTypeHeaderHandle 844 RvSipContent
RvSipDateMonth 903 RvSipDateWeekDay 904 RvSipDispositionHandling 906 RvSipDispositionType 905 RvSipEventHeaderConstruct() 454 RvSipEventHeaderConstructInMsg() 453 RvSipEventHeaderCopy() 455 RvSipEventHeaderEncode() 456 RvSipEventHeaderFix() 459 RvSipEventHeaderGetCompactForm() 477 RvSipEventHeaderGetEventId() 471 RvSipEventHeaderGetEventPackage() 465 RvSipEventHeaderGetEventParam() 469 RvSipEventHeaderGetEventTemplate() 467 RvSipEventHeaderGetRpoolString() 463 RvSipEventHeaderGetStrBadSyntax() 473 RvSipEven
RvSipMsgDestruct() 6 RvSipMsgEncode() 8 RvSipMsgForceCompactForm() 11 RvSipMsgGetBadSyntaxHeaders() 37 RvSipMsgGetBody() 54 RvSipMsgGetBodyObject() 57 RvSipMsgGetCallIdCompactForm() 65 RvSipMsgGetCallIdHeader() 50 RvSipMsgGetContentLengthCompactForm() 67 RvSipMsgGetContentLengthHeader() 46 RvSipMsgGetContentTypeHeader() 52 RvSipMsgGetCSeqHeader() 48 RvSipMsgGetFromHeader() 44 RvSipMsgGetHeader() 25 RvSipMsgGetHeaderByName() 29 RvSipMsgGetHeaderByNameExt() 35 RvSipMsgGetHeaderByType() 27 RvSipMsgGetHeaderByT
RvSipPartyHeaderGetTag() 552 RvSipPartyHeaderGetType() 560 RvSipPartyHeaderHandle 854 RvSipPartyHeaderParse() 545 RvSipPartyHeaderParseValue() 546 RvSipPartyHeaderSetAddrSpec() 557 RvSipPartyHeaderSetCompactForm() 567 RvSipPartyHeaderSetDisplayName() 555 RvSipPartyHeaderSetOtherParams() 559 RvSipPartyHeaderSetRpoolString() 563 RvSipPartyHeaderSetStrBadSyntax() 566 RvSipPartyHeaderSetTag() 553 RvSipPartyHeaderSetType() 561 RvSipPartyHeaderStringName 881 RvSipPartyIsEqual() 549 RvSipRAckHeaderConstruct() 572
RvSipReferToHeaderSetDisplayName() 603 RvSipReferToHeaderSetOtherParams() 607 RvSipReferToHeaderSetReplacesHeader() 605 RvSipReferToHeaderSetStrBadSyntax() 610 RvSipReferToHeaderStringName 884 RvSipReplacesEarlyFlagType 916 RvSipReplacesHeaderHandle 858 RvSipReplacesHeaderStringName 885, 892 RvSipRetryAfterHeaderConstruct() 642 RvSipRetryAfterHeaderConstructInMsg() 641 RvSipRetryAfterHeaderCopy() 643 RvSipRetryAfterHeaderEncode() 644 RvSipRetryAfterHeaderFix() 647 RvSipRetryAfterHeaderGetDateHandle() 653 Rv
RvSipRSeqHeaderParseValue() 698 RvSipRSeqHeaderSetResponseNum() 702 RvSipRSeqHeaderSetStrBadSyntax() 706 RvSipRSeqHeaderStringName 888 RvSipSessionExpiresHeaderConstruct() 712 RvSipSessionExpiresHeaderConstructInMsg() 711 RvSipSessionExpiresHeaderCopy() 713 RvSipSessionExpiresHeaderEncode() 714 RvSipSessionExpiresHeaderFix() 717 RvSipSessionExpiresHeaderGetCompactFor m() 730 RvSipSessionExpiresHeaderGetDeltaSecond s() 720 RvSipSessionExpiresHeaderGetOtherParams () 724 RvSipSessionExpiresHeaderGetRefresherTy
RvSipViaHeaderConstruct() 762 RvSipViaHeaderConstructInMsg() 761 RvSipViaHeaderCopy() 763 RvSipViaHeaderEncode() 764 RvSipViaHeaderFix() 767 RvSipViaHeaderGetAliasParam() 797 RvSipViaHeaderGetBranchParam() 785 RvSipViaHeaderGetCompactForm() 799 RvSipViaHeaderGetHiddenParam() 787 RvSipViaHeaderGetHost() 773 RvSipViaHeaderGetMaddrParam() 779 RvSipViaHeaderGetOtherParams() 789 RvSipViaHeaderGetPortNum() 775 RvSipViaHeaderGetReceivedParam() 781 RvSipViaHeaderGetRpoolString() 791 RvSipViaHeaderGetRportParam() 78
