---
name: "eXosip2_event"
section: "3"
platform: "linux"
package: "libexosip2-dev"
version: "4.1.0-2.1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/eXosip2_event"
---

# eXosip2\_event(3)

eXosip2 event API

## NAME

eXosip2\_event - eXosip2 event API

### Data Structures

struct **eXosip\_event**\

### Enumerations

enum **eXosip\_event\_type** { **EXOSIP\_REGISTRATION\_SUCCESS**, **EXOSIP\_REGISTRATION\_FAILURE**, **EXOSIP\_CALL\_INVITE**, **EXOSIP\_CALL\_REINVITE**, **EXOSIP\_CALL\_NOANSWER**, **EXOSIP\_CALL\_PROCEEDING**, **EXOSIP\_CALL\_RINGING**, **EXOSIP\_CALL\_ANSWERED**, **EXOSIP\_CALL\_REDIRECTED**, **EXOSIP\_CALL\_REQUESTFAILURE**, **EXOSIP\_CALL\_SERVERFAILURE**, **EXOSIP\_CALL\_GLOBALFAILURE**, **EXOSIP\_CALL\_ACK**, **EXOSIP\_CALL\_CANCELLED**, **EXOSIP\_CALL\_MESSAGE\_NEW**, **EXOSIP\_CALL\_MESSAGE\_PROCEEDING**, **EXOSIP\_CALL\_MESSAGE\_ANSWERED**, **EXOSIP\_CALL\_MESSAGE\_REDIRECTED**, **EXOSIP\_CALL\_MESSAGE\_REQUESTFAILURE**, **EXOSIP\_CALL\_MESSAGE\_SERVERFAILURE**, **EXOSIP\_CALL\_MESSAGE\_GLOBALFAILURE**, **EXOSIP\_CALL\_CLOSED**, **EXOSIP\_CALL\_RELEASED**, **EXOSIP\_MESSAGE\_NEW**, **EXOSIP\_MESSAGE\_PROCEEDING**, **EXOSIP\_MESSAGE\_ANSWERED**, **EXOSIP\_MESSAGE\_REDIRECTED**, **EXOSIP\_MESSAGE\_REQUESTFAILURE**, **EXOSIP\_MESSAGE\_SERVERFAILURE**, **EXOSIP\_MESSAGE\_GLOBALFAILURE**, **EXOSIP\_SUBSCRIPTION\_NOANSWER**, **EXOSIP\_SUBSCRIPTION\_PROCEEDING**, **EXOSIP\_SUBSCRIPTION\_ANSWERED**, **EXOSIP\_SUBSCRIPTION\_REDIRECTED**, **EXOSIP\_SUBSCRIPTION\_REQUESTFAILURE**, **EXOSIP\_SUBSCRIPTION\_SERVERFAILURE**, **EXOSIP\_SUBSCRIPTION\_GLOBALFAILURE**, **EXOSIP\_SUBSCRIPTION\_NOTIFY**, **EXOSIP\_IN\_SUBSCRIPTION\_NEW**, **EXOSIP\_NOTIFICATION\_NOANSWER**, **EXOSIP\_NOTIFICATION\_PROCEEDING**, **EXOSIP\_NOTIFICATION\_ANSWERED**, **EXOSIP\_NOTIFICATION\_REDIRECTED**, **EXOSIP\_NOTIFICATION\_REQUESTFAILURE**, **EXOSIP\_NOTIFICATION\_SERVERFAILURE**, **EXOSIP\_NOTIFICATION\_GLOBALFAILURE**, **EXOSIP\_EVENT\_COUNT** }\

### Functions

void **eXosip\_event\_free** (**eXosip\_event\_t** \*je)\
 **eXosip\_event\_t** \* **eXosip\_event\_wait** (struct eXosip\_t \*excontext, int tv\_s, int tv\_ms)\
 **eXosip\_event\_t** \* **eXosip\_event\_get** (struct eXosip\_t \*excontext)\
 int **eXosip\_event\_geteventsocket** (struct eXosip\_t \*excontext)\

## Detailed Description

## Enumeration Type Documentation

### enum eXosip\_event\_type

Structure for event type description

**Enumerator**

- *EXOSIP\_REGISTRATION\_SUCCESS*

  *user is successfully registred.*

- *EXOSIP\_REGISTRATION\_FAILURE*

  *user is not registred.*

- *EXOSIP\_CALL\_INVITE*

  *announce a new call*

- *EXOSIP\_CALL\_REINVITE*

  *announce a new INVITE within call*

- *EXOSIP\_CALL\_NOANSWER*

  *announce no answer within the timeout*

- *EXOSIP\_CALL\_PROCEEDING*

  *announce processing by a remote app*

- *EXOSIP\_CALL\_RINGING*

  *announce ringback*

- *EXOSIP\_CALL\_ANSWERED*

  *announce start of call*

- *EXOSIP\_CALL\_REDIRECTED*

  *announce a redirection*

- *EXOSIP\_CALL\_REQUESTFAILURE*

  *announce a request failure*

- *EXOSIP\_CALL\_SERVERFAILURE*

  *announce a server failure*

- *EXOSIP\_CALL\_GLOBALFAILURE*

  *announce a global failure*

- *EXOSIP\_CALL\_ACK*

  *ACK received for 200ok to INVITE*

- *EXOSIP\_CALL\_CANCELLED*

  *announce that call has been cancelled*

- *EXOSIP\_CALL\_MESSAGE\_NEW*

  *announce new incoming request.*

- *EXOSIP\_CALL\_MESSAGE\_PROCEEDING*

  *announce a 1xx for request.*

- *EXOSIP\_CALL\_MESSAGE\_ANSWERED*

  *announce a 200ok*

- *EXOSIP\_CALL\_MESSAGE\_REDIRECTED*

  *announce a failure.*

- *EXOSIP\_CALL\_MESSAGE\_REQUESTFAILURE*

  *announce a failure.*

- *EXOSIP\_CALL\_MESSAGE\_SERVERFAILURE*

  *announce a failure.*

- *EXOSIP\_CALL\_MESSAGE\_GLOBALFAILURE*

  *announce a failure.*

- *EXOSIP\_CALL\_CLOSED*

  *a BYE was received for this call*

- *EXOSIP\_CALL\_RELEASED*

  *call context is cleared.*

- *EXOSIP\_MESSAGE\_NEW*

  *announce new incoming request.*

- *EXOSIP\_MESSAGE\_PROCEEDING*

  *announce a 1xx for request.*

- *EXOSIP\_MESSAGE\_ANSWERED*

  *announce a 200ok*

- *EXOSIP\_MESSAGE\_REDIRECTED*

  *announce a failure.*

- *EXOSIP\_MESSAGE\_REQUESTFAILURE*

  *announce a failure.*

- *EXOSIP\_MESSAGE\_SERVERFAILURE*

  *announce a failure.*

- *EXOSIP\_MESSAGE\_GLOBALFAILURE*

  *announce a failure.*

- *EXOSIP\_SUBSCRIPTION\_NOANSWER*

  *announce no answer*

- *EXOSIP\_SUBSCRIPTION\_PROCEEDING*

  *announce a 1xx*

- *EXOSIP\_SUBSCRIPTION\_ANSWERED*

  *announce a 200ok*

- *EXOSIP\_SUBSCRIPTION\_REDIRECTED*

  *announce a redirection*

- *EXOSIP\_SUBSCRIPTION\_REQUESTFAILURE*

  *announce a request failure*

- *EXOSIP\_SUBSCRIPTION\_SERVERFAILURE*

  *announce a server failure*

- *EXOSIP\_SUBSCRIPTION\_GLOBALFAILURE*

  *announce a global failure*

- *EXOSIP\_SUBSCRIPTION\_NOTIFY*

  *announce new NOTIFY request*

- *EXOSIP\_IN\_SUBSCRIPTION\_NEW*

  *announce new incoming SUBSCRIBE.*

- *EXOSIP\_NOTIFICATION\_NOANSWER*

  *announce no answer*

- *EXOSIP\_NOTIFICATION\_PROCEEDING*

  *announce a 1xx*

- *EXOSIP\_NOTIFICATION\_ANSWERED*

  *announce a 200ok*

- *EXOSIP\_NOTIFICATION\_REDIRECTED*

  *announce a redirection*

- *EXOSIP\_NOTIFICATION\_REQUESTFAILURE*

  *announce a request failure*

- *EXOSIP\_NOTIFICATION\_SERVERFAILURE*

  *announce a server failure*

- *EXOSIP\_NOTIFICATION\_GLOBALFAILURE*

  *announce a global failure*

- *EXOSIP\_EVENT\_COUNT*

  *MAX number of events*

## Function Documentation

### void eXosip\_event\_free (eXosip\_event\_t \* je)

*Free resource in an eXosip event.*

**Parameters:**

*je event to work on.*

### eXosip\_event\_t\* eXosip\_event\_wait (struct eXosip\_t \* excontext, int tv\_s, int tv\_ms)

*Wait for an eXosip event.*

**Parameters:**

*excontext eXosip\_t instance.* \
 *tv\_s timeout value (seconds).* \
 *tv\_ms timeout value (mseconds).*

### eXosip\_event\_t\* eXosip\_event\_get (struct eXosip\_t \* excontext)

*Wait for next eXosip event.* **DEPRECATED API** *This API will block - You should use eXosip\_event\_wait instead which is more convenient. limitation: This method will not process automatic 200ok retransmission for INVITE transaction.*

**Parameters:**

*excontext eXosip\_t instance.*

### int eXosip\_event\_geteventsocket (struct eXosip\_t \* excontext)

*This socket receive some data yhen an event happens internally. NOTE: you must call eXosip\_event\_wait until there is no more events in the fifo.*

**Parameters:**

*excontext eXosip\_t instance.*

## Author

*Generated automatically by Doxygen for libeXosip2 from the source code.*