eXosip2_subscribe(3)

eXosip2_subscribe(3) — the libeXosip2 bestie era 💅

okay so bestie, welcome to the glow-up of the eXosip2_subscribe(3) page from libeXosip2. We are keeping every single detail, just with main-character energy. No cap. 💖

✨ NAME ✨

eXosip2_subscribe — eXosip2 SUBSCRIBE and outgoing subscriptions. That's the whole vibe: SUBSCRIBE stuff and outgoing subscriptions, and we're obsessed. 🫶

✨ SYNOPSIS ✨

okay so here's the API shape, exactly as it is. Don't let the formatting scare you — it's just the group chat roster. 💅

Enumerations

enum eXosip_ss { EXOSIP_SUBCRSTATE_UNKNOWN, EXOSIP_SUBCRSTATE_PENDING,
    EXOSIP_SUBCRSTATE_ACTIVE, EXOSIP_SUBCRSTATE_TERMINATED }
enum eXosip_ss_reason { DEACTIVATED, PROBATION, REJECTED, TIMEOUT,
    GIVEUP, NORESOURCE }
enum eXosip_ss_status { EXOSIP_NOTIFY_UNKNOWN, EXOSIP_NOTIFY_PENDING,
    EXOSIP_NOTIFY_ONLINE, EXOSIP_NOTIFY_BUSY, EXOSIP_NOTIFY_BERIGHTBACK,
    EXOSIP_NOTIFY_AWAY, EXOSIP_NOTIFY_ONTHEPHONE,
    EXOSIP_NOTIFY_OUTTOLUNCH, EXOSIP_NOTIFY_CLOSED }

Functions

int eXosip_subscription_build_initial_subscribe (struct eXosip_t *excontext, osip_message_t **subscribe, const char *to, const char *from, const char *route, const char *event, int expires)
int eXosip_subscription_build_initial_refer (struct eXosip_t *excontext, osip_message_t **refer, const char *to, const char *from, const char *route, const char *refer_to)
int eXosip_subscription_send_initial_request (struct eXosip_t *excontext, osip_message_t *subscribe)
int eXosip_subscription_build_refresh_request (struct eXosip_t *excontext, int did, osip_message_t **sub)
int eXosip_subscription_send_refresh_request (struct eXosip_t *excontext, int did, osip_message_t *sub)
int eXosip_subscription_remove (struct eXosip_t *excontext, int did)

🌸 Detailed Description 🌸

This section is literally the detailed description zone. The original doesn't pile on extra prose here — it's the eXosip2 SUBSCRIBE and outgoing subscriptions page, and the real tea is in the enum details and function docs below. We're keeping all of it. ✨

🦋 Enumeration Type Documentation 🦋

enum eXosip_ss

Structure for subscription status. It's giving status-icon energy. 👑

Enumerator

• EXOSIP_SUBCRSTATE_UNKNOWN — unknown subscription-state
• EXOSIP_SUBCRSTATE_PENDING — pending subscription-state
• EXOSIP_SUBCRSTATE_ACTIVE — active subscription-state
• EXOSIP_SUBCRSTATE_TERMINATED — terminated subscription-state

enum eXosip_ss_reason

Structure for subscription reason. Not the reason you're ignoring texts — the subscription-state reason. 💀

Enumerator

• DEACTIVATED — deactivated for subscription-state
• PROBATION — probation for subscription-state
• REJECTED — rejected for subscription-state
• TIMEOUT — timeout for subscription-state
• GIVEUP — giveup for subscription-state
• NORESOURCE — noresource for subscription-state

enum eXosip_ss_status

Structure for notification status. This is the "what's your status rn" enum, and honestly same. 🌈

Enumerator

• EXOSIP_NOTIFY_UNKNOWN — unknown state for subscription
• EXOSIP_NOTIFY_PENDING — subscription not yet accepted
• EXOSIP_NOTIFY_ONLINE — online status
• EXOSIP_NOTIFY_BUSY — busy status
• EXOSIP_NOTIFY_BERIGHTBACK — be right back status
• EXOSIP_NOTIFY_AWAY — away status
• EXOSIP_NOTIFY_ONTHEPHONE — on the phone status
• EXOSIP_NOTIFY_OUTTOLUNCH — out to lunch status
• EXOSIP_NOTIFY_CLOSED — closed status

💖 Function Documentation 💖

eXosip_subscription_build_initial_subscribe

int eXosip_subscription_build_initial_subscribe (struct eXosip_t *excontext, osip_message_t **subscribe, const char *to, const char *from, const char *route, const char *event, int expires)

Build a default initial SUBSCRIBE request. Slay. 💌

Parameters

• excontext — eXosip_t instance.
• subscribe — Pointer for the SIP request to build.
• to — SIP url for callee.
• from — SIP url for caller.
• route — Route header for SUBSCRIBE. (optional)
• event — Event header for SUBSCRIBE.
• expires — Expires header for SUBSCRIBE.

eXosip_subscription_build_initial_refer

int eXosip_subscription_build_initial_refer (struct eXosip_t *excontext, osip_message_t **refer, const char *to, const char *from, const char *route, const char *refer_to)

Build a default initial REFER request. Referral realness. 🎀

Parameters

• excontext — eXosip_t instance.
• refer — Pointer for the SIP request to build.
• to — SIP url for callee.
• from — SIP url for caller.
• route — Route header for REFER. (optional)
• refer_to — SIP url for transfer.

eXosip_subscription_send_initial_request

int eXosip_subscription_send_initial_request (struct eXosip_t *excontext, osip_message_t *subscribe)

Send an initial SUBSCRIBE/REFER request. Send it, bestie. ✨

Parameters

• excontext — eXosip_t instance.
• subscribe — SIP SUBSCRIBE message to send.

eXosip_subscription_build_refresh_request

int eXosip_subscription_build_refresh_request (struct eXosip_t *excontext, int did, osip_message_t **sub)

Build a default new SUBSCRIBE/REFER refresh message. Refresh, but make it SIP. 🧚

Parameters

• excontext — eXosip_t instance.
• did — identifier of the subscription.
• sub — Pointer for the SIP request to build.

eXosip_subscription_send_refresh_request

int eXosip_subscription_send_refresh_request (struct eXosip_t *excontext, int did, osip_message_t *sub)

Send a new SUBSCRIBE/REFER refresh request. Another one, because consistency is iconic. 💅

Parameters

• excontext — eXosip_t instance.
• did — identifier of the subscription.
• sub — SIP SUBSCRIBE message to send.

eXosip_subscription_remove

int eXosip_subscription_remove (struct eXosip_t *excontext, int did)

Remove outgoing subscription context. It's not ghosting, it's cleanup. 🫶

Parameters

• excontext — eXosip_t instance.
• did — identifier of the subscription.

👑 Author 👑

Generated automatically by Doxygen for libeXosip2 from the source code.

Version 5.3.0 — dated Thu May 18 2023 — from libeXosip2, manual eXosip2_subscribe(3). Mwah, bestie 💋✨