share/man/man3sip/sip_msg_is_request.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_MSG_IS_REQUEST 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_msg_is_request, sip_message_is_response \- determine if the SIP message is
   9 a request or a response
  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 \fBboolean_t\fR \fIsip_msg_is_request\fR(\fBconst sip_msg_t\fR \fIsip_msg\fR,
  17      \fBint *\fR\fIerror\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBboolean_t\fR \fIsip_msg_is_response\fR(\fBconst sip_msg_t\fR \fIsip_msg\fR,
  23      \fBint *\fR\fIerror\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBsip_msg_is_request()\fR function returns \fBB_TRUE\fR if \fIsip_msg\fR
  30 is a request and \fBB_FALSE\fR otherwise.
  31 .sp
  32 .LP
  33 The \fBsip_msg_is_response()\fR function returns \fBB_TRUE\fR if \fIsip_msg\fR
  34 is a response and \fBB_FALSE\fR otherwise.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 For functions that return an integer, the return value is the specified value
  39 on success and \fB-1\fR on error.
  40 .sp
  41 .LP
  42 The value of \fBerrno\fR is not changed by these calls in the event of an
  43 error.
  44 .SH ERRORS
  45 .sp
  46 .LP
  47 These functions take a pointer to an integer \fIerror\fR as an argument. If the
  48 error is non-null, one of the following values is set:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBEINVAL\fR\fR
  53 .ad
  54 .RS 10n
  55 The input \fBSIP\fR message \fIsip_msg\fR or the header value is null; or the
  56 specified header/header value is deleted.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBEPROTO\fR\fR
  63 .ad
  64 .RS 10n
  65 The header value is not present or invalid. The parser could not parse it
  66 correctly.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBENOMEM\fR\fR
  73 .ad
  74 .RS 10n
  75 There is an error allocating memory for the return value.
  76 .RE
  77
  78 .sp
  79 .LP
  80 On success, the value of the location pointed to by \fIerror\fR is set to
  81 \fB0\fR.
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Committed
  96 _
  97 MT-Level        MT-Safe
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBlibsip\fR(3LIB)