.TH "eXosip2_call" 3 "Thu Dec 15 2016" "Version 4.1.0" "libeXosip2" \" -*- nroff -*-
.ad l
.nh
.SH NAME
eXosip2_call \- eXosip2 INVITE and Call Management
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBeXosip_call_set_reference\fP (struct eXosip_t *excontext, int id, void *reference)"
.br
.ti -1c
.RI "void * \fBeXosip_call_get_reference\fP (struct eXosip_t *excontext, int cid)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_initial_invite\fP (struct eXosip_t *excontext, osip_message_t **invite, const char *to, const char *from, const char *route, const char *subject)"
.br
.ti -1c
.RI "int \fBeXosip_call_send_initial_invite\fP (struct eXosip_t *excontext, osip_message_t *invite)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_request\fP (struct eXosip_t *excontext, int did, const char *method, osip_message_t **request)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_ack\fP (struct eXosip_t *excontext, int did, osip_message_t **ack)"
.br
.ti -1c
.RI "int \fBeXosip_call_send_ack\fP (struct eXosip_t *excontext, int did, osip_message_t *ack)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_refer\fP (struct eXosip_t *excontext, int did, const char *refer_to, osip_message_t **request)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_info\fP (struct eXosip_t *excontext, int did, osip_message_t **request)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_options\fP (struct eXosip_t *excontext, int did, osip_message_t **request)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_update\fP (struct eXosip_t *excontext, int did, osip_message_t **request)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_notify\fP (struct eXosip_t *excontext, int did, int subscription_status, osip_message_t **request)"
.br
.ti -1c
.RI "int \fBeXosip_call_send_request\fP (struct eXosip_t *excontext, int did, osip_message_t *request)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_answer\fP (struct eXosip_t *excontext, int tid, int status, osip_message_t **answer)"
.br
.ti -1c
.RI "int \fBeXosip_call_send_answer\fP (struct eXosip_t *excontext, int tid, int status, osip_message_t *answer)"
.br
.ti -1c
.RI "int \fBeXosip_call_terminate\fP (struct eXosip_t *excontext, int cid, int did)"
.br
.ti -1c
.RI "int \fBeXosip_call_build_prack\fP (struct eXosip_t *excontext, int tid, osip_message_t **prack)"
.br
.ti -1c
.RI "int \fBeXosip_call_send_prack\fP (struct eXosip_t *excontext, int tid, osip_message_t *prack)"
.br
.ti -1c
.RI "int \fBeXosip_call_get_referto\fP (struct eXosip_t *excontext, int did, char *refer_to, size_t refer_to_len)"
.br
.ti -1c
.RI "int \fBeXosip_call_find_by_replaces\fP (struct eXosip_t *excontext, char *replaces)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "int eXosip_call_set_reference (struct eXosip_t * excontext, int id, void * reference)"
Set a new application context for an existing call
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIid\fP call-id or dialog-id of call 
.br
\fIreference\fP New application context\&. 
.RE
.PP

.SS "void* eXosip_call_get_reference (struct eXosip_t * excontext, int cid)"
Get the application context pointer for an existing call\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIcid\fP id of the call\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
Application context reference 
.RE
.PP

.SS "int eXosip_call_build_initial_invite (struct eXosip_t * excontext, osip_message_t ** invite, const char * to, const char * from, const char * route, const char * subject)"
Build a default INVITE message for a new call\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIinvite\fP Pointer for the SIP element to hold\&. 
.br
\fIto\fP SIP url for callee\&. 
.br
\fIfrom\fP SIP url for caller\&. 
.br
\fIroute\fP Route header for INVITE\&. (optional) 
.br
\fIsubject\fP Subject for the call\&. 
.RE
.PP

.SS "int eXosip_call_send_initial_invite (struct eXosip_t * excontext, osip_message_t * invite)"
Initiate a call\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIinvite\fP SIP INVITE message to send\&. 
.RE
.PP

.SS "int eXosip_call_build_request (struct eXosip_t * excontext, int did, const char * method, osip_message_t ** request)"
Build a default request within a call\&. (INVITE, OPTIONS, INFO, REFER)
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fImethod\fP request type to build\&. 
.br
\fIrequest\fP The sip request to build\&. 
.RE
.PP

.SS "int eXosip_call_build_ack (struct eXosip_t * excontext, int did, osip_message_t ** ack)"
Build a default ACK for a 200ok received\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fIack\fP The sip request to build\&. 
.RE
.PP

.SS "int eXosip_call_send_ack (struct eXosip_t * excontext, int did, osip_message_t * ack)"
Send the ACK for the 200ok received\&.\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fIack\fP SIP ACK message to send\&. 
.RE
.PP

.SS "int eXosip_call_build_refer (struct eXosip_t * excontext, int did, const char * refer_to, osip_message_t ** request)"
Build a default REFER for a call transfer\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fIrefer_to\fP url for call transfer (Refer-To header)\&. 
.br
\fIrequest\fP The sip request to build\&. 
.RE
.PP

.SS "int eXosip_call_build_info (struct eXosip_t * excontext, int did, osip_message_t ** request)"
Build a default INFO within a call\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fIrequest\fP The sip request to build\&. 
.RE
.PP

.SS "int eXosip_call_build_options (struct eXosip_t * excontext, int did, osip_message_t ** request)"
Build a default OPTIONS within a call\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fIrequest\fP The sip request to build\&. 
.RE
.PP

.SS "int eXosip_call_build_update (struct eXosip_t * excontext, int did, osip_message_t ** request)"
Build a default UPDATE within a call\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fIrequest\fP The sip request to build\&. 
.RE
.PP

.SS "int eXosip_call_build_notify (struct eXosip_t * excontext, int did, int subscription_status, osip_message_t ** request)"
Build a default NOTIFY within a call\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fIsubscription_status\fP Subscription status of the request\&. 
.br
\fIrequest\fP The sip request to build\&. 
.RE
.PP

.SS "int eXosip_call_send_request (struct eXosip_t * excontext, int did, osip_message_t * request)"
send the request within call\&. (INVITE, OPTIONS, INFO, REFER, UPDATE)
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP dialog id of call\&. 
.br
\fIrequest\fP The sip request to send\&. 
.RE
.PP

.SS "int eXosip_call_build_answer (struct eXosip_t * excontext, int tid, int status, osip_message_t ** answer)"
Build default Answer for request\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fItid\fP id of transaction to answer\&. 
.br
\fIstatus\fP Status code to use\&. 
.br
\fIanswer\fP The sip answer to build\&. 
.RE
.PP

.SS "int eXosip_call_send_answer (struct eXosip_t * excontext, int tid, int status, osip_message_t * answer)"
Send Answer for invite\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fItid\fP id of transaction to answer\&. 
.br
\fIstatus\fP response status if answer is NULL\&. (not allowed for 2XX) 
.br
\fIanswer\fP The sip answer to send\&. 
.RE
.PP

.SS "int eXosip_call_terminate (struct eXosip_t * excontext, int cid, int did)"
Terminate a call\&. send CANCEL, BYE or 603 Decline\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIcid\fP call id of call\&. 
.br
\fIdid\fP dialog id of call\&. 
.RE
.PP

.SS "int eXosip_call_build_prack (struct eXosip_t * excontext, int tid, osip_message_t ** prack)"
Build a PRACK for invite\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fItid\fP id of the invite transaction\&. 
.br
\fIprack\fP The sip prack to build\&. 
.RE
.PP

.SS "int eXosip_call_send_prack (struct eXosip_t * excontext, int tid, osip_message_t * prack)"
Send a PRACK for invite\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fItid\fP id of the invite transaction\&. 
.br
\fIprack\fP The sip prack to send\&. 
.RE
.PP

.SS "int eXosip_call_get_referto (struct eXosip_t * excontext, int did, char * refer_to, size_t refer_to_len)"
Get Refer-To header with Replace parameter from dialog\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIdid\fP id of the dialog\&. 
.br
\fIrefer_to\fP buffer to be filled with refer-to info\&. 
.br
\fIrefer_to_len\fP size of refer_to buffer\&. 
.RE
.PP

.SS "int eXosip_call_find_by_replaces (struct eXosip_t * excontext, char * replaces)"
Return did (or cid) for the replace header\&.
.PP
\fBParameters:\fP
.RS 4
\fIexcontext\fP eXosip_t instance\&. 
.br
\fIreplaces\fP buffer to be filled with refer-to info\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for libeXosip2 from the source code\&.