usr/src/man/man3sip/sip_get_request_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_REQUEST_METHOD 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_get_request_method, sip_get_response_code, sip_get_response_phrase,
   9 sip_get_sip_version \- obtain attributes from the start line in a SIP message
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  14 #include <sip.h>
  15
  16 \fBsip_method_t\fR \fIsip_get_request_method\fR(\fBconst sip_msg_t\fR \fIsip_msg\fR,
  17      \fBint *\fR\fIerror\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fIsip_get_response_code\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  23      \fBint *\fR\fIerror\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBconst sip_str_t *\fR\fIsip_get_response_phrase\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  29      \fBint *\fR\fIerror\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBconst sip_str_t*\fR\fIsip_get_sip_version\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  35      \fBint *\fR\fIerror\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 For functions that return a pointer of type \fBsip_str_t\fR, \fBsip_str_t\fR is
  42 supplied by:
  43 .sp
  44 .in +2
  45 .nf
  46 typedef struct sip_str {
  47      char       *sip_str_ptr;
  48      int        sip_str_len;
  49 }sip_str_t;
  50 .fi
  51 .in -2
  52
  53 .sp
  54 .LP
  55 The \fIsip_str_ptr\fR parameter points to the start of the returned value and
  56 \fIsip_str_len\fR supplies the length of the returned value.
  57 .sp
  58 .LP
  59 For example, given the following request line in a \fBSIP\fR message
  60 \fIsip_msg\fR that is input to \fBsip_get_request_uri_str()\fR:
  61 .sp
  62 .in +2
  63 .nf
  64 FROM : <Alice sip:alice@atlanta.com>;tag=1928301774
  65 .fi
  66 .in -2
  67
  68 .sp
  69 .LP
  70 the return is a pointer to \fIsip_str_t\fR with the \fIsip_str_ptr\fR member
  71 pointing to "\fBA\fR" of \fBAlice\fR and \fIsip_str_len\fR being set to
  72 \fB5\fR, the length of \fBAlice\fR.
  73 .sp
  74 .LP
  75 Access functions for headers that can have multiple values take the value as
  76 the input, while those that can have only one value take the \fBSIP\fR message
  77 \fIsip_msg\fR as the input.
  78 .sp
  79 .LP
  80 The \fBsip_get_request_method()\fR function will return the \fBSIP\fR method
  81 from the request line in the  \fBSIP\fR message \fIsip_msg\fR. The method can
  82 be one of the following:
  83 .br
  84 .in +2
  85 INVITE
  86 .in -2
  87 .br
  88 .in +2
  89 ACK
  90 .in -2
  91 .br
  92 .in +2
  93 OPTIONS
  94 .in -2
  95 .br
  96 .in +2
  97 BYE
  98 .in -2
  99 .br
 100 .in +2
 101 CANCEL
 102 .in -2
 103 .br
 104 .in +2
 105 REGISTER
 106 .in -2
 107 .br
 108 .in +2
 109 REFER
 110 .in -2
 111 .br
 112 .in +2
 113 INFO
 114 .in -2
 115 .br
 116 .in +2
 117 SUBSCRIBE
 118 .in -2
 119 .br
 120 .in +2
 121 NOTIFY
 122 .in -2
 123 .br
 124 .in +2
 125 PRACK
 126 .in -2
 127 .br
 128 .in +2
 129 UNKNOWN
 130 .in -2
 131 .sp
 132 .LP
 133 The \fBsip_get_response_code()\fR function will return the response code
 134 \fIresponse\fR from the request line in the  \fBSIP\fR message \fIsip_msg\fR.
 135 .sp
 136 .LP
 137 The \fBsip_get_respose_phrase()\fR function will return the response phrase
 138 \fIresponse\fR from the request line in the  \fBSIP\fR message \fIsip_msg\fR.
 139 .sp
 140 .LP
 141 The \fBsip_get_sip_version()\fR function will return the version of the
 142 \fBSIP\fR protocol from the request or the response line in the \fBSIP\fR
 143 message \fIsip_msg\fR.
 144 .SH RETURN VALUES
 145 .sp
 146 .LP
 147 For functions that return a pointer to \fIsip_str_t\fR, the return value is the
 148 specified value on success or \fBNULL\fR in case of error. For functions that
 149 return an integer, the return value is the specified value on success and
 150 \fB-1\fR on error.
 151 .sp
 152 .LP
 153 The value of \fBerrno\fR is not changed by these calls in the event of an
 154 error.
 155 .SH ERRORS
 156 .sp
 157 .LP
 158 These functions take a pointer to an integer \fIerror\fR as an argument. If the
 159 error is non-null, one of the following values is set:
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fBEINVAL\fR\fR
 164 .ad
 165 .RS 10n
 166 The input \fBSIP\fR message \fIsip_msg\fR or the header value is null; or the
 167 specified header/header value is deleted.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fBEPROTO\fR\fR
 174 .ad
 175 .RS 10n
 176 The header value is not present or invalid. The parser could not parse it
 177 correctly.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fB\fBENOMEM\fR\fR
 184 .ad
 185 .RS 10n
 186 There is an error allocating memory for the return value.
 187 .RE
 188
 189 .sp
 190 .LP
 191 On success, the value of the location pointed to by \fIerror\fR is set to
 192 \fB0\fR.
 193 .SH ATTRIBUTES
 194 .sp
 195 .LP
 196 See \fBattributes\fR(5) for descriptions of the following attributes:
 197 .sp
 198
 199 .sp
 200 .TS
 201 box;
 202 c | c
 203 l | l .
 204 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 205 _
 206 Interface Stability     Committed
 207 _
 208 MT-Level        MT-Safe
 209 .TE
 210
 211 .SH SEE ALSO
 212 .sp
 213 .LP
 214 \fBlibsip\fR(3LIB)