eXosip2_call(3)
πΈ NAME πΈ
eXosip2_call β eXosip2 INVITE and Call Management. That's the whole vibe, bestie: INVITE stuff and call management, all in one page. π
okay so this is the eXosip2_call(3) page from libeXosip2, and it's literally your call-handling toolbox. Let's get into it, no cap. π
β¨ SYNOPSIS β¨
Functions π¦
int eXosip_call_set_reference (struct eXosip_t *excontext, int id, void *reference)
void * eXosip_call_get_reference (struct eXosip_t *excontext, int cid)
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)
int eXosip_call_send_initial_invite (struct eXosip_t *excontext, osip_message_t *invite)
int eXosip_call_build_request (struct eXosip_t *excontext, int did, const char *method, osip_message_t **request)
int eXosip_call_build_ack (struct eXosip_t *excontext, int tid, osip_message_t **ack)
int eXosip_call_send_ack (struct eXosip_t *excontext, int tid, osip_message_t *ack)
int eXosip_call_build_refer (struct eXosip_t *excontext, int did, const char *refer_to, osip_message_t **request)
int eXosip_call_build_info (struct eXosip_t *excontext, int did, osip_message_t **request)
int eXosip_call_build_options (struct eXosip_t *excontext, int did, osip_message_t **request)
int eXosip_call_build_update (struct eXosip_t *excontext, int did, osip_message_t **request)
int eXosip_call_build_notify (struct eXosip_t *excontext, int did, int subscription_status, osip_message_t **request)
int eXosip_call_send_request (struct eXosip_t *excontext, int did, osip_message_t *request)
int eXosip_call_build_answer (struct eXosip_t *excontext, int tid, int status, osip_message_t **answer)
int eXosip_call_send_answer (struct eXosip_t *excontext, int tid, int status, osip_message_t *answer)
int eXosip_call_terminate (struct eXosip_t *excontext, int cid, int did)
int eXosip_call_terminate_with_reason (struct eXosip_t *excontext, int cid, int did, const char *reason)
int eXosip_call_terminate_with_header (struct eXosip_t *excontext, int cid, int did, const char *header_name, const char *header_value)
int eXosip_call_build_prack (struct eXosip_t *excontext, int tid, osip_message_t *response1xx, osip_message_t **prack)
int eXosip_call_send_prack (struct eXosip_t *excontext, int tid, osip_message_t *prack)
int eXosip_call_get_referto (struct eXosip_t *excontext, int did, char *refer_to, size_t refer_to_len)
int eXosip_call_find_by_replaces (struct eXosip_t *excontext, char *replaces)
π Detailed Description π
bestie, this section is not spilling any extra tea in the original β it's giving "the real details are down in Function Documentation." So keep scrolling, the function-by-function lore is right below. π
π Function Documentation π
eXosip_call_set_reference
int eXosip_call_set_reference (struct eXosip_t *excontext, int id, void *reference)
Set a new application context for an existing call. π«Ά
Parameters
excontextβ eXosip_t instance.idβ call-id or dialog-id of callreferenceβ New application context.
eXosip_call_get_reference
void * eXosip_call_get_reference (struct eXosip_t *excontext, int cid)
Get the application context pointer for an existing call.
Parameters
excontextβ eXosip_t instance.cidβ id of the call.
Returns β Application context reference
eXosip_call_build_initial_invite
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. β¨
Parameters
excontextβ eXosip_t instance.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.
eXosip_call_send_initial_invite
int eXosip_call_send_initial_invite (struct eXosip_t *excontext, osip_message_t *invite)
Initiate a call. π₯
Parameters
excontextβ eXosip_t instance.inviteβ SIP INVITE message to send.
eXosip_call_build_request
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) π¦
Parameters
excontextβ eXosip_t instance.didβ dialog id of call.methodβ request type to build.requestβ The sip request to build.
eXosip_call_build_ack
int eXosip_call_build_ack (struct eXosip_t *excontext, int tid, osip_message_t **ack)
Build a default ACK for a 200ok received. π
Parameters
excontextβ eXosip_t instance.tidβ transaction id of INVITE/2xx.ackβ The sip request to build.
eXosip_call_send_ack
int eXosip_call_send_ack (struct eXosip_t *excontext, int tid, osip_message_t *ack)
Send the ACK for the 200ok received.. π
Parameters
excontextβ eXosip_t instance.tidβ transaction id of INVITE/2xx.ackβ SIP ACK message to send.
eXosip_call_build_refer
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. π
Parameters
excontextβ eXosip_t instance.didβ dialog id of call.refer_toβ url for call transfer (Refer-To header).requestβ The sip request to build.
eXosip_call_build_info
int eXosip_call_build_info (struct eXosip_t *excontext, int did, osip_message_t **request)
Build a default INFO within a call. πΈ
Parameters
excontextβ eXosip_t instance.didβ dialog id of call.requestβ The sip request to build.
eXosip_call_build_options
int eXosip_call_build_options (struct eXosip_t *excontext, int did, osip_message_t **request)
Build a default OPTIONS within a call. β
Parameters
excontextβ eXosip_t instance.didβ dialog id of call.requestβ The sip request to build.
eXosip_call_build_update
int eXosip_call_build_update (struct eXosip_t *excontext, int did, osip_message_t **request)
Build a default UPDATE within a call. π
Parameters
excontextβ eXosip_t instance.didβ dialog id of call.requestβ The sip request to build.
eXosip_call_build_notify
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. π
Parameters
excontextβ eXosip_t instance.didβ dialog id of call.subscription_statusβ Subscription status of the request.requestβ The sip request to build.
eXosip_call_send_request
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) π
Parameters
excontextβ eXosip_t instance.didβ dialog id of call.requestβ The sip request to send.
eXosip_call_build_answer
int eXosip_call_build_answer (struct eXosip_t *excontext, int tid, int status, osip_message_t **answer)
Build default Answer for request. π
Parameters
excontextβ eXosip_t instance.tidβ id of transaction to answer.statusβ Status code to use.answerβ The sip answer to build.
eXosip_call_send_answer
int eXosip_call_send_answer (struct eXosip_t *excontext, int tid, int status, osip_message_t *answer)
Send Answer for invite. πβ¨
Parameters
excontextβ eXosip_t instance.tidβ id of transaction to answer.statusβ response status ifanswerisNULL. (not allowed for 2XX)answerβ The sip answer to send.
eXosip_call_terminate
int eXosip_call_terminate (struct eXosip_t *excontext, int cid, int did)
Terminate a call. send CANCEL, BYE or 603 Decline. βοΈπ
Parameters
excontextβ eXosip_t instance.cidβ call id of call.didβ dialog id of call.
eXosip_call_terminate_with_reason
int eXosip_call_terminate_with_reason (struct eXosip_t *excontext, int cid, int did, const char *reason)
Terminate a call and add a Reason header. send CANCEL, BYE or 603 Decline. π
Parameters
excontextβ eXosip_t instance.cidβ call id of call.didβ dialog id of call.reasonβ Reason header.
eXosip_call_terminate_with_header
int eXosip_call_terminate_with_header (struct eXosip_t *excontext, int cid, int did, const char *header_name, const char *header_value)
Terminate a call and add a Reason header. send CANCEL, BYE or 603 Decline. πβ¨
Parameters
excontextβ eXosip_t instance.cidβ call id of call.didβ dialog id of call.header_nameβ header name.header_valueβ header value.
eXosip_call_build_prack
int eXosip_call_build_prack (struct eXosip_t *excontext, int tid, osip_message_t *response1xx, osip_message_t **prack)
Build a PRACK for invite. π§
Parameters
excontextβ eXosip_t instance.tidβ id of the invite transaction.response1xxβ The sip response for which we build a PRACK.prackβ The sip prack to build.
eXosip_call_send_prack
int eXosip_call_send_prack (struct eXosip_t *excontext, int tid, osip_message_t *prack)
Send a PRACK for invite. π§ββοΈβ¨
Parameters
excontextβ eXosip_t instance.tidβ id of the invite transaction.prackβ The sip prack to send.
eXosip_call_get_referto
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. π
Parameters
excontextβ eXosip_t instance.didβ id of the dialog.refer_toβ buffer to be filled with refer-to info.refer_to_lenβ size ofrefer_tobuffer.
eXosip_call_find_by_replaces
int eXosip_call_find_by_replaces (struct eXosip_t *excontext, char *replaces)
Return did (or cid) for the replace header. π΅οΈββοΈ
Parameters
excontextβ eXosip_t instance.replacesβ buffer to be filled with refer-to info.
π«Ά Author π«Ά
Generated automatically by Doxygen for libeXosip2 from the source code.
okay bestie, that's the whole eXosip2_call(3) page from libeXosip2. Signing off with Version 5.3.0, dated Thu May 18 2023 β mwah, go make some calls. πβ¨π
π¦ where this page comes from
- epel 9: libeXosip2-devel 5.3.0-2.el9 Β· GPL-2.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms