Tribblix: manual page: sip_add_response

SIP_ADD_REQUEST_LINE(3SIP) Session Initiation Protocol Library Functions

NAME

sip_add_request_line, sip_add_response_line - add a request/response
line to a SIP message

SYNOPSIS

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

int sip_add_request_line(sip_msg_t sip_request,
sip_method_t method, char *request_uri);

int sip_add_response_line(sip_msg_t sip_response,
int response_code, char *response_phase);

DESCRIPTION

The sip_add_request_line() function adds a request line to the SIP
message sip_request. The request line is created using the SIP method
specified in method and the URI in request_uri. The SIP method can be
one of the following:
INVITE
ACK
OPTIONS
BYE
CANCEL
REGISTER
REFER
SUBSCRIBE
NOTIFY
PRACK
INFO

The resulting request line has the SIP-Version of "2.0".

The sip_add_response_line() function adds a response line to the SIP
message sip_response. The response line is created using the response
code response_code and the phrase in response_phrase. If the
response_code is one that is listed in RFC 3261, sip_get_resp_desc()
can be used to get the response phase for the response_code. The
resulting response line has the SIP-Version of "2.0".

RETURN VALUES

The sip_add_response_line() and sip_add_request_line() functions
return 0 on success and the appropriate error value in case of
failure.

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

ERRORS

On failure, the sip_add_response_line() and sip_add_request_line()
functions could return one of the following errors:

EINVAL
If mandatory input is not provided or if the input is
invalid.

ENOTSUP
If the input SIP message cannot be modified.

ENOMEM
If memory allocation fails when creating the
request/response line or when creating headers in the ACK
request.