share/man/man3sip/sip_create_response.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_CREATE_RESPONSE 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_create_response \- create a response for a SIP request
   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 \fBsip_msg_t\fR \fIsip_create_response\fR(\fBsip_msg_t\fR \fIsip_request\fR,
  16      \fBint\fR \fIresponse_code\fR, \fBchar *\fR\fIresponse_phase\fR,
  17      \fBchar *\fR\fItotag\fR, \fBchar *\fR\fIcontact_uri\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBsip_create_response()\fR function creates and returns a \fBSIP\fR
  24 message in response to the \fBSIP\fR request \fIsip_request\fR. The response
  25 line in the resulting \fBSIP\fR message is created using the response code in
  26 \fIresponse_code\fR and the phrase in \fIresponse_phrase\fR. The response line
  27 has the \fBSIP\fR-Version of "2.0". If a non-null \fItotag\fR is specified, the
  28 resulting \fBSIP\fR response has a \fBTO\fR header with a tag value from
  29 \fItotag\fR. If \fItotag\fR is null and the \fIresponse_code\fR is anything
  30 other than \fB100\fR (\fBTRYING\fR), \fBsip_create_response()\fR adds a
  31 \fBTO\fR header with a randomly generated tag value. If the \fIresponse_code\fR
  32 is \fB100\fR and \fItotag\fR is null, the \fBSIP\fR response has a \fBTO\fR
  33 header without a tag parameter. If \fIcontact_uri\fR is non-null, a
  34 \fBCONTACT\fR header is added to the \fBSIP\fR response with the \fBURI\fR
  35 specified in \fIcontact_uri\fR. The \fBSIP\fR response has the following
  36 headers copied from \fIsip_request\fR:
  37 .br
  38 .in +2
  39 All \fBVIA\fR headers
  40 .in -2
  41 .br
  42 .in +2
  43 \fBFROM\fR header
  44 .in -2
  45 .br
  46 .in +2
  47 \fBTO\fR header (with tag added, if required, as stated above)
  48 .in -2
  49 .br
  50 .in +2
  51 \fBCALL-ID\fR header
  52 .in -2
  53 .br
  54 .in +2
  55 \fBCSEQ\fR header
  56 .in -2
  57 .br
  58 .in +2
  59 All \fBRECORD-ROUTE\fR headers
  60 .in -2
  61 .SH RETURN VALUES
  62 .sp
  63 .LP
  64 The \fBsip_create_response()\fR function returns the resulting \fBSIP\fR
  65 message on success and \fBNULL\fR on failure.
  66 .sp
  67 .LP
  68 The value of \fBerrno\fR is not changed by these calls in the event of an
  69 error.
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for descriptions of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 Interface Stability     Committed
  84 _
  85 MT-Level        MT-Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBlibsip\fR(3LIB)