eXosip2_call man page

eXosip2_call

Synopsis

Functions

int eXosip_call_set_reference (int id, void *reference)
void * eXosip_call_get_reference (int cid)
int eXosip_call_build_initial_invite (osip_message_t **invite, const char *to, const char *from, const char *route, const char *subject)
int eXosip_call_send_initial_invite (osip_message_t *invite)
int eXosip_call_build_request (int did, const char *method, osip_message_t **request)
int eXosip_call_build_ack (int did, osip_message_t **ack)
int eXosip_call_send_ack (int did, osip_message_t *ack)
int eXosip_call_build_refer (int did, const char *refer_to, osip_message_t **request)
int eXosip_call_build_info (int did, osip_message_t **request)
int eXosip_call_build_options (int did, osip_message_t **request)
int eXosip_call_build_update (int did, osip_message_t **request)
int eXosip_call_build_notify (int did, int subscription_status, osip_message_t **request)
int eXosip_call_send_request (int did, osip_message_t *request)
int eXosip_call_build_answer (int tid, int status, osip_message_t **answer)
int eXosip_call_send_answer (int tid, int status, osip_message_t *answer)
int eXosip_call_terminate (int cid, int did)
int eXosip_call_build_prack (int tid, osip_message_t **prack)
int eXosip_call_send_prack (int tid, osip_message_t *prack)
int eXosip_transfer_send_notify (int did, int subscription_status, char *body)
int eXosip_call_get_referto (int did, char *refer_to, size_t refer_to_len)
int eXosip_call_find_by_replaces (char *replaces)

Detailed Description

Function Documentation

int eXosip_call_set_reference (int id, void * reference)

Set a new application context for an existing call

Parameters

id call-id or dialog-id of call
reference New application context.

void* eXosip_call_get_reference (int cid)

Get the application context pointer for an existing call.

Parameters

cid id of the call.

Returns

Application context reference

int eXosip_call_build_initial_invite (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.

Parameters

invite Pointer for the SIP element to hold.
to SIP url for callee.
from SIP url for caller.
route Route header for INVITE. (optional)
subject Subject for the call.

int eXosip_call_send_initial_invite (osip_message_t * invite)

Initiate a call.

Parameters

invite SIP INVITE message to send.

int eXosip_call_build_request (int did, const char * method, osip_message_t ** request)

Build a default request within a call. (INVITE, OPTIONS, INFO, REFER)

Parameters

did dialog id of call.
method request type to build.
request The sip request to build.

int eXosip_call_build_ack (int did, osip_message_t ** ack)

Build a default ACK for a 200ok received.

Parameters

did dialog id of call.
ack The sip request to build.

int eXosip_call_send_ack (int did, osip_message_t * ack)

Send the ACK for the 200ok received..

Parameters

did dialog id of call.
ack SIP ACK message to send.

int eXosip_call_build_refer (int did, const char * refer_to, osip_message_t ** request)

Build a default REFER for a call transfer.

Parameters

did dialog id of call.
refer_to url for call transfer (Refer-To header).
request The sip request to build.

int eXosip_call_build_info (int did, osip_message_t ** request)

Build a default INFO within a call.

Parameters

did dialog id of call.
request The sip request to build.

int eXosip_call_build_options (int did, osip_message_t ** request)

Build a default OPTIONS within a call.

Parameters

did dialog id of call.
request The sip request to build.

int eXosip_call_build_update (int did, osip_message_t ** request)

Build a default UPDATE within a call.

Parameters

did dialog id of call.
request The sip request to build.

int eXosip_call_build_notify (int did, int subscription_status, osip_message_t ** request)

Build a default NOTIFY within a call.

Parameters

did dialog id of call.
subscription_status Subscription status of the request.
request The sip request to build.

int eXosip_call_send_request (int did, osip_message_t * request)

send the request within call. (INVITE, OPTIONS, INFO, REFER, UPDATE)

Parameters

did dialog id of call.
request The sip request to send.

int eXosip_call_build_answer (int tid, int status, osip_message_t ** answer)

Build default Answer for request.

Parameters

tid id of transaction to answer.
status Status code to use.
answer The sip answer to build.

int eXosip_call_send_answer (int tid, int status, osip_message_t * answer)

Send Answer for invite.

Parameters

tid id of transaction to answer.
status response status if answer is NULL. (not allowed for 2XX)
answer The sip answer to send.

int eXosip_call_terminate (int cid, int did)

Terminate a call. send CANCEL, BYE or 603 Decline.

Parameters

cid call id of call.
did dialog id of call.

int eXosip_call_build_prack (int tid, osip_message_t ** prack)

Build a PRACK for invite.

Parameters

tid id of the invite transaction.
prack The sip prack to build.

int eXosip_call_send_prack (int tid, osip_message_t * prack)

Send a PRACK for invite.

Parameters

tid id of the invite transaction.
prack The sip prack to send.

int eXosip_transfer_send_notify (int did, int subscription_status, char * body)

Send a NOTIFY containing the information about a call transfer.

THIS METHOD WILL BE REPLACED or REMOVED, please use the new API to build NOTIFY.

Parameters

did dialog id of call.
subscription_status the subscription status.
body the body to attach to NOTIFY.

int eXosip_call_get_referto (int did, char * refer_to, size_t refer_to_len)

Get Refer-To header with Replace parameter from dialog.

Parameters

did id of the dialog.
refer_to buffer to be filled with refer-to info.
refer_to_len size of refer_to buffer.

int eXosip_call_find_by_replaces (char * replaces)

Return did (or cid) for the replace header.

Parameters

replaces buffer to be filled with refer-to info.

Author

Generated automatically by Doxygen for libeXosip2 from the source code.

Info

Wed Jan 29 2020 Version 3.1.0 libeXosip2