share/man/man3sip/sip_add_request_line.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_ADD_REQUEST_LINE 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_add_request_line, sip_add_response_line \- add a request/response line to a
   9 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 \fBint\fR \fBsip_add_request_line\fR(\fBsip_msg_t\fR \fIsip_request\fR,
  17      \fBsip_method_t\fR \fImethod\fR, \fBchar *\fR\fIrequest_uri\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fIsip_add_response_line\fR(\fBsip_msg_t\fR \fIsip_response\fR,
  23      \fBint\fR \fIresponse_code\fR, \fBchar *\fR\fIresponse_phase\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBsip_add_request_line()\fR function adds a request line to the \fBSIP\fR
  30 message \fIsip_request\fR. The request line is created using the \fBSIP\fR
  31 method specified in \fImethod\fR and the \fBURI\fR in \fIrequest_uri\fR. The
  32 \fBSIP\fR method can be one of the following:
  33 .br
  34 .in +2
  35 \fBINVITE\fR
  36 .in -2
  37 .br
  38 .in +2
  39 \fBACK\fR
  40 .in -2
  41 .br
  42 .in +2
  43 \fBOPTIONS\fR
  44 .in -2
  45 .br
  46 .in +2
  47 \fBBYE\fR
  48 .in -2
  49 .br
  50 .in +2
  51 \fBCANCEL\fR
  52 .in -2
  53 .br
  54 .in +2
  55 \fBREGISTER\fR
  56 .in -2
  57 .br
  58 .in +2
  59 \fBREFER\fR
  60 .in -2
  61 .br
  62 .in +2
  63 \fBSUBSCRIBE\fR
  64 .in -2
  65 .br
  66 .in +2
  67 \fBNOTIFY\fR
  68 .in -2
  69 .br
  70 .in +2
  71 \fBPRACK\fR
  72 .in -2
  73 .br
  74 .in +2
  75 \fBINFO\fR
  76 .in -2
  77 .sp
  78 .LP
  79 The resulting request line has the \fBSIP\fR-Version of "2.0".
  80 .sp
  81 .LP
  82 The \fBsip_add_response_line()\fR function adds a response line to the
  83 \fBSIP\fR message \fIsip_response\fR. The response line is created using the
  84 response code \fIresponse_code\fR and the phrase in \fIresponse_phrase\fR. If
  85 the \fIresponse_code\fR is one that is listed in RFC 3261,
  86 \fBsip_get_resp_desc()\fR can be used to get the response phase for the
  87 \fIresponse_code\fR. The resulting response line has the \fBSIP\fR-Version of
  88 "2.0".
  89 .SH RETURN VALUES
  90 .sp
  91 .LP
  92 The \fBsip_add_response_line()\fR and \fBsip_add_request_line()\fR functions
  93 return \fB0\fR on success and the appropriate error value in case of failure.
  94 .sp
  95 .LP
  96 The value of \fBerrno\fR is not changed by these calls in the event of an
  97 error.
  98 .SH ERRORS
  99 .sp
 100 .LP
 101 On failure, the \fBsip_add_response_line()\fR and \fBsip_add_request_line()\fR
 102 functions could return one of the following errors:
 103 .sp
 104 .ne 2
 105 .na
 106 \fBEINVAL\fR
 107 .ad
 108 .RS 11n
 109 If mandatory input is not provided or if the input is invalid.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fBENOTSUP\fR
 116 .ad
 117 .RS 11n
 118 If the input \fBSIP\fR message cannot be modified.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fBENOMEM\fR
 125 .ad
 126 .RS 11n
 127 If memory allocation fails when creating the request/response line or when
 128 creating headers in the \fBACK\fR request.
 129 .RE
 130
 131 .SH ATTRIBUTES
 132 .sp
 133 .LP
 134 See \fBattributes\fR(5) for descriptions of the following attributes:
 135 .sp
 136
 137 .sp
 138 .TS
 139 box;
 140 c | c
 141 l | l .
 142 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 143 _
 144 Interface Stability     Committed
 145 _
 146 MT-Level        MT-Safe
 147 .TE
 148
 149 .SH SEE ALSO
 150 .sp
 151 .LP
 152 \fBlibsip\fR(3LIB)