xref: /illumos-gate/usr/src/man/man3sip/sip_get_trans.3sip (revision 6bb6b5762ca4b17cd5fb3c6c123f17489d5635aa)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SIP_GET_TRANS 3SIP "Jan 25, 2007"
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(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO

libsip(3LIB)