Session Initiation Protocol Library Functions
sipgetrequestmethod(3SIP)
NAME
sipgetrequestmethod, sipgetresponsecode,
sipgetresponsephrase, sipgetsipversion - obtain attri-
butes from the start line in a SIP message
SYNOPSIS
cc [ flag ... ] file ... -lsip [ library ... ]
#include
sipmethodt sipgetrequestmethod(const sipmsgt sipmsg,
int *error);
int sipgetresponsecode(sipmsgt sipmsg,
int *error);
const sipstrt *sipgetresponsephrase(sipmsgt sipmsg,
int *error);
const sipstrt*sipgetsipversion(sipmsgt sipmsg,
int *error);
DESCRIPTION
For functions that return a pointer of type sipstrt,
sipstrt is supplied by:
typedef struct sipstr {
char *sipstrptr;
int sipstrlen;
}sipstrt;
The sipstrptr parameter points to the start of the
returned value and sipstrlen supplies the length of the
returned value.
For example, given the following request line in a SIP mes-
sage sipmsg that is input to sipgetrequesturistr():
FROM : ;tag=1928301774
the return is a pointer to sipstrt with the sipstrptr
member pointing to "A" of Alice and sipstrlen being set to
5, the length of Alice.
SunOS 5.11 Last change: 25 Jan 2007 1
Session Initiation Protocol Library Functions
sipgetrequestmethod(3SIP)
Access functions for headers that can have multiple values
take the value as the input, while those that can have only
one value take the SIP message sipmsg as the input.
The sipgetrequestmethod() function will return the SIP
method from the request line in the SIP message sipmsg.
The method can be one of the following:
INVITE
ACK
OPTIONS
BYE
CANCEL
REGISTER
REFER
INFO
SUBSCRIBE
NOTIFY
PRACK
UNKNOWN
The sipgetresponsecode() function will return the
response code response from the request line in the SIP
message sipmsg.
The sipgetresposephrase() function will return the
response phrase response from the request line in the SIP
message sipmsg.
The sipgetsipversion() function will return the version
of the SIP protocol from the request or the response line in
the SIP message sipmsg.
RETURN VALUES
For functions that return a pointer to sipstrt, the return
value is the specified value on success or NUL in case of
error. For functions that return an integer, the return
value is the specified value on success and -1 on error.
The value of errno is not changed by these calls in the
event of an error.
ERORS
These functions take a pointer to an integer error as an
argument. If the error is non-null, one of the following
values is set:
SunOS 5.11 Last change: 25 Jan 2007 2
Session Initiation Protocol Library Functions
sipgetrequestmethod(3SIP)
EINVAL The input SIP message sipmsg or the header value
is null; or the specified header/header value is
deleted.
EPROTO The header value is not present or invalid. The
parser could not parse it correctly.
ENOMEM There is an error allocating memory for the return
value.
On success, the value of the location pointed to by error is
set to 0.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO
libsip(3LIB)
SunOS 5.11 Last change: 25 Jan 2007 3
Session Initiation Protocol Library Functions
sipgetrequestmethod(3SIP)
SunOS 5.11 Last change: 25 Jan 2007 4
|
