share/man/man3sip/sip_get_trans_method.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_METHOD 3SIP "Feb 10, 2007"
   7 .SH NAME
   8 sip_get_trans_method, sip_get_trans_state, sip_get_trans_orig_msg,
   9 sip_get_trans_conn_obj, sip_get_trans_resp_msg, sip_get_trans_branchid \- get
  10 transaction attributes
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  15 #include <sip.h>
  16
  17 \fBsip_method_t\fR \fIsip_get_trans_method\fR(\fBsip_transaction_t\fR \fIsip_trans\fR,
  18      \fBint *\fR\fIerror\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fIsip_get_trans_state\fR(\fBsip_transaction_t\fR \fItrans\fR, \fBint *\fR\fIerror\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBconst struct sip_message *\fR\fIsip_get_trans_orig_msg\fR
  29      (\fBsip_transaction_t\fR \fIsip_trans\fR, \fBint *\fR\fIerror\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBconst struct sip_message *\fR\fIsip_get_trans_resp_msg\fR
  35      (\fBsip_transaction_t\fR \fIsip_trans\fR, \fBint *\fR\fIerror\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBconst struct sip_conn_object *\fR\fIsip_get_trans_conn_obj\fR
  41      (\fBsip_transaction_t\fR \fIsip_trans\fR, \fBint *\fR\fIerror\fR);
  42 .fi
  43
  44 .LP
  45 .nf
  46 \fBchar *\fR\fIsip_get_trans_branchid\fR(\fBsip_transaction_t\fR \fItrans\fR, \fBint *\fR\fIerror\fR);
  47 .fi
  48
  49 .SH DESCRIPTION
  50 .sp
  51 .LP
  52 The \fBsip_get_trans_method()\fR function returns the method the SIP message
  53 that created the transaction \fIsip_trans\fR.
  54 .sp
  55 .LP
  56 The \fBsip_get_trans_state()\fR function returns the state of the transaction
  57 \fIsip_trans\fR.
  58 .sp
  59 .LP
  60 A newly created transaction is in the state:
  61 .br
  62 .in +2
  63 \fBSIP_NEW_TRANSACTION\fR
  64 .in -2
  65 .sp
  66 .LP
  67 A client transaction could be in one of the following states:
  68 .br
  69 .in +2
  70 \fBSIP_CLNT_CALLING\fR
  71 .in -2
  72 .br
  73 .in +2
  74 \fBSIP_CLNT_INV_PROCEEDING\fR
  75 .in -2
  76 .br
  77 .in +2
  78 \fBSIP_CLNT_INV_TERMINATED\fR
  79 .in -2
  80 .br
  81 .in +2
  82 \fBSIP_CLNT_INV_COMPLETED\fR
  83 .in -2
  84 .br
  85 .in +2
  86 \fBSIP_CLNT_TRYING\fR
  87 .in -2
  88 .br
  89 .in +2
  90 \fBSIP_CLNT_NONINV_PROCEEDING\fR
  91 .in -2
  92 .br
  93 .in +2
  94 \fBSIP_CLNT_NONINV_TERMINATED\fR
  95 .in -2
  96 .br
  97 .in +2
  98 \fBSIP_CLNT_NONINV_COMPLETED\fR
  99 .in -2
 100 .sp
 101 .LP
 102 A server transaction could be in one of the following states:
 103 .br
 104 .in +2
 105 \fBSIP_SRV_INV_PROCEEDING\fR
 106 .in -2
 107 .br
 108 .in +2
 109 \fBSIP_SRV_INV_COMPLETED\fR
 110 .in -2
 111 .br
 112 .in +2
 113 \fBSIP_SRV_CONFIRMED\fR
 114 .in -2
 115 .br
 116 .in +2
 117 \fBSIP_SRV_INV_TERMINATED\fR
 118 .in -2
 119 .br
 120 .in +2
 121 \fBSIP_SRV_TRYING\fR
 122 .in -2
 123 .br
 124 .in +2
 125 \fBSIP_SRV_NONINV_PROCEEDING\fR
 126 .in -2
 127 .br
 128 .in +2
 129 \fBSIP_SRV_NONINV_COMPLETED\fR
 130 .in -2
 131 .br
 132 .in +2
 133 \fBSIP_SRV_NONINV_TERMINATED\fR
 134 .in -2
 135 .sp
 136 .LP
 137 The \fBsip_get_trans_orig_msg()\fR function returns the message that created
 138 the transaction \fIsip_trans\fR. This could be a request on the client or a
 139 response on the server.
 140 .sp
 141 .LP
 142 The \fBsip_get_trans_resp_msg()\fR function returns the last response that was
 143 sent on the transaction \fIsip_trans\fR. Typically, this response is used by
 144 the transaction layer for retransmissions for unreliable transports or for
 145 responding to retransmitted requests. A response that terminates a transaction
 146 is not returned.
 147 .sp
 148 .LP
 149 The \fBsip_get_trans_conn_obj()\fR function returns the cached connection
 150 object, if any, in the transaction\fIsip_trans\fR.
 151 .sp
 152 .LP
 153 The \fBsip_get_trans_branchid()\fR function returns the branch ID for the
 154 message that created the transaction\fIsip_trans\fR. The caller is responsible
 155 for freeing the returned string.
 156 .SH RETURN VALUES
 157 .sp
 158 .LP
 159 The \fBsip_get_trans_orig_msg()\fR, \fBsip_get_trans_resp_msg()\fR,
 160 \fBsip_get_trans_conn_obj()\fR, and \fBsip_get_trans_branchid()\fR functions
 161 return the required value on success or \fINULL\fR on failure.
 162 .sp
 163 .LP
 164 The \fBsip_get_trans_state()\fR and \fBsip_get_trans_method()\fR functions
 165 return the required value on success and  -1 on failure.
 166 .sp
 167 .LP
 168 The value of \fBerrno\fR is not changed by these calls in the event of an
 169 error.
 170 .SH ERRORS
 171 .sp
 172 .LP
 173 If the error is non-null, one of the following values is set:
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fBEINVAL\fR\fR
 178 .ad
 179 .RS 10n
 180 The input transaction \fIsip_trans\fR is \fINULL\fR.
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fBENOMEM\fR\fR
 187 .ad
 188 .RS 10n
 189 For \fBsip_get_trans_branchid()\fR there is an  error allocating memory for the
 190 branch ID string.
 191 .RE
 192
 193 .sp
 194 .LP
 195 On success, the value of the location pointed to by \fIerror\fR is set to
 196 \fB0\fR.
 197 .SH ATTRIBUTES
 198 .sp
 199 .LP
 200 See \fBattributes\fR(5) for descriptions of the following attributes:
 201 .sp
 202
 203 .sp
 204 .TS
 205 box;
 206 c | c
 207 l | l .
 208 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 209 _
 210 Interface Stability     Committed
 211 _
 212 MT-Level        MT-Safe
 213 .TE
 214
 215 .SH SEE ALSO
 216 .sp
 217 .LP
 218 \fBlibsip\fR(3LIB)