share/man/man3sip/sip_get_trans.3sip

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SIP_GET_TRANS 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_get_trans \- lookup a transaction
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  13 #include <sip.h>
  14
  15 \fBconst struct sip_xaction *\fR\fIsip_get_trans\fR(\fBsip_msg_t\fR \fIsip_msg\fR, \fBint\fR \fIwhich\fR,
  16      \fBint *\fR\fIerror\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBsip_get_trans()\fR transaction for the SIP message \fIsip_msg\fR. A
  23 transaction is not freed if there are any references on it.
  24 .sp
  25 .LP
  26 The transaction type should be specified as one of the following:
  27 .br
  28 .in +2
  29 \fBSIP_CLIENT_TRANSACTON\fR - lookup a client transaction
  30 .in -2
  31 .br
  32 .in +2
  33 \fBSIP_SERVER_TRANSACTON\fR - lookup a server transaction
  34 .in -2
  35 .sp
  36 .LP
  37 The \fBsip_get_trans()\fR function matches a transaction to a message as
  38 specified in RFC 3261, sections 17.1.3 and 17.2.3. The \fBsip_get_trans()\fR
  39 function holds a reference to the returned transaction. The caller must release
  40 this reference after use.
  41 .SH RETURN VALUES
  42 .sp
  43 .LP
  44 The \fBsip_get_trans()\fR function returns the required value on success or
  45 \fINULL\fR on failure.
  46 .sp
  47 .LP
  48 The value of \fBerrno\fR is not changed by these calls in the event of an
  49 error.
  50 .SH ERRORS
  51 .sp
  52 .LP
  53 On success, the value of the location pointed to by \fIerror\fR is set to
  54 \fB0\fR.
  55 .SH ATTRIBUTES
  56 .sp
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 Interface Stability     Committed
  69 _
  70 MT-Level        MT-Safe
  71 .TE
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fBlibsip\fR(3LIB)