SIP_GET_TRANS(3SIP) Session Initiation Protocol Library Functions

NAME

sip_get_trans - lookup a transaction

SYNOPSIS

cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>

const struct sip_xaction *sip_get_trans(sip_msg_t sip_msg, int which,
int *error);

DESCRIPTION

The sip_get_trans() transaction for the SIP message sip_msg. A
transaction is not freed if there are any references on it.


The transaction type should be specified as one of the following:
SIP_CLIENT_TRANSACTON - lookup a client transaction
SIP_SERVER_TRANSACTON - lookup a server transaction


The sip_get_trans() function matches a transaction to a message as
specified in RFC 3261, sections 17.1.3 and 17.2.3. The
sip_get_trans() function holds a reference to the returned
transaction. The caller must release this reference after use.

RETURN VALUES

The sip_get_trans() function returns the required value on success or
NULL on failure.


The value of errno is not changed by these calls in the event of an
error.

ERRORS

On success, the value of the location pointed to by error is set to
0.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+

SEE ALSO

libsip(3LIB)

January 25, 2007 SIP_GET_TRANS(3SIP)