xref: /titanic_51/usr/src/man/man3sip/sip_process_new_packet.3sip (revision ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2ab)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
SIP_PROCESS_NEW_PACKET 3SIP "Jan 25, 2007"
NAME
sip_process_new_packet - send an inbound message to the SIP stack for processing
SYNOPSIS

cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>

void sip_process_new_packet(sip_conn_object_t conn_object,
 void *msgstr, size_t msgstr);
DESCRIPTION

The sip_process_new_packet() function receives incoming message, creates a SIP message, processes it and passes it on to the application. For a byte-stream protocol like TCP sip_process_new_packet() also takes care of breaking the byte stream into message boundaries using the CONTENT-LENGTH header in the SIP message. If the SIP message arriving on TCP does not contain a CONTENT-LENGTH header, the behavior is unspecified. sip_process_new_packet() deletes the SIP message on return from the application's receive function, thus if the application wishes to retain the SIP message for future use, it must use sip_hod_msg() so that the message is not freed by sip_process_new_packet().

RETURN VALUES

The value of errno is not changed by these calls in the event of an error.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
SEE ALSO

libsip(3LIB)