eXosip2_call(3)

πŸ“¦ version 5.3.0, in epel 9

🌸 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 call
  • reference β€” 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 if answer is NULL. (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 of refer_to buffer.

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