share/man/man3sip/sip_process_new_packet.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_PROCESS_NEW_PACKET 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_process_new_packet \- send an inbound message to the SIP stack for
   9 processing
  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 \fBvoid\fR \fIsip_process_new_packet\fR(\fBsip_conn_object_t\fR \fIconn_object\fR,
  17      \fBvoid *\fR\fImsgstr\fR, \fBsize_t\fR \fImsgstr\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBsip_process_new_packet()\fR function receives incoming message, creates
  24 a \fBSIP\fR message, processes it and passes it on to the application. For a
  25 byte-stream protocol like \fBTCP\fR \fBsip_process_new_packet()\fR also takes
  26 care of breaking the byte stream into message boundaries using the
  27 \fBCONTENT-LENGTH\fR header in the \fBSIP\fR message. If the \fBSIP\fR message
  28 arriving on \fBTCP\fR does not contain a \fBCONTENT-LENGTH\fR header, the
  29 behavior is unspecified. \fBsip_process_new_packet()\fR deletes the \fBSIP\fR
  30 message on return from the application's receive function, thus if the
  31 application wishes to retain the \fBSIP\fR message for future use, it must use
  32 \fBsip_hod_msg()\fR so that the message is not freed by
  33 \fBsip_process_new_packet()\fR.
  34 .SH RETURN VALUES
  35 .sp
  36 .LP
  37 The value of \fBerrno\fR is not changed by these calls in the event of an
  38 error.
  39 .SH ATTRIBUTES
  40 .sp
  41 .LP
  42 See \fBattributes\fR(5) for descriptions of the following attributes:
  43 .sp
  44
  45 .sp
  46 .TS
  47 box;
  48 c | c
  49 l | l .
  50 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  51 _
  52 Interface Stability     Committed
  53 _
  54 MT-Level        MT-Safe
  55 .TE
  56
  57 .SH SEE ALSO
  58 .sp
  59 .LP
  60 \fBlibsip\fR(3LIB)