Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sip_sendmsg(3sip) [opensolaris man page]

sip_sendmsg(3SIP)				   Session Initiation Protocol Library Functions				 sip_sendmsg(3SIP)

NAME

       sip_sendmsg - send an outbound SIP message to the SIP stack for processing

SYNOPSIS

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

       int sip_sendmsg(sip_conn_object_t obj, sip_msg_t sip_msg,
	    sip_dialog_t dialog, uint32_t flags);

DESCRIPTION

       The  sip_sendmsg()  function is used to send an outbound SIP message sip_msg to the SIP stack on its way to the peer. The connection object
       for the SIP message is passed as obj. The caller also provides the dialog associated with the message, if one exists. The value of flags is
       the result of ORing the following, as required:

       SIP_SEND_STATEFUL     Send  the	request  or response statefully. This results in the stack creating and maintaining a transaction for this
			     request/response. If this flag is not set transactions are not created for the request/response.

       SIP_DIALOG_ON_FORK    When this flag is set, the stack may create multiple dialogs for a dialog completing response. This may result due to
			     forking of the dialog creating request. If this flag is not set, the first response to a dialog creating request cre-
			     ates a dialog, but subsequent ones do not. It is only meaningful if the stack is configured to maintain dialogs.

RETURN VALUES

       The sip_sendmsg() function returns 0 on success and the appropriate error on failure.

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

ERRORS

       The sip_sendmsg() function can return one of the following errors on failure:

       EINVAL	 If a message is being statefully sent and the branchid in the VIA header does not conform to RFC  3261  or  when  accessing  CSEQ
		 header while creating a transaction.

       ENOENT	 If a message is being statefully sent, error getting the CSEQ header while creating a transaction.

       EPROTO	 If a message is being statefully sent, error getting the CSEQ value while creating a transaction.

       ENOMEM	 If  the  message  is  being  statefully  sent, error allocating memory for creating or adding a transaction or during transaction
		 related processing.

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)

SunOS 5.11							    25 Jan 2007 						 sip_sendmsg(3SIP)

Check Out this Related Man Page

sip_create_response(3SIP)			   Session Initiation Protocol Library Functions			 sip_create_response(3SIP)

NAME

       sip_create_response - create a response for a SIP request

SYNOPSIS

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

       sip_msg_t sip_create_response(sip_msg_t sip_request,
	    int response_code, char *response_phase,
	    char *totag, char *contact_uri);

DESCRIPTION

       The  sip_create_response()  function creates and returns a SIP message in response to the SIP request sip_request. The response line in the
       resulting SIP message is created using the response code in response_code and the phrase in response_phrase. The response line has the SIP-
       Version	of  "2.0".  If	a non-null totag is specified, the resulting SIP response has a TO header with a tag value from totag. If totag is
       null and the response_code is anything other than 100 (TRYING), sip_create_response() adds a TO header with a randomly generated tag value.
       If the response_code is 100 and totag is null, the SIP response has a TO header without a tag parameter. If contact_uri is non-null, a CON-
       TACT header is added to the SIP response with the URI specified in contact_uri. The SIP response has  the  following  headers  copied  from
       sip_request:
	 All VIA headers
	 FROM header
	 TO header (with tag added, if required, as stated above)
	 CALL-ID header
	 CSEQ header
	 All RECORD-ROUTE headers

RETURN VALUES

       The sip_create_response() function returns the resulting SIP message on success and NULL on failure.

       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)

SunOS 5.11							    25 Jan 2007 					 sip_create_response(3SIP)
Man Page