sip_types.h File Reference

---

Detailed Description

#include <pjsip/sip_config.h>
#include <pj/types.h>

Data Structures
struct	pjsip_buffer
struct	pjsip_host_port
struct	pjsip_host_info
Defines
#define	PJSIP_RETURN_EXCEPTION()   pjsip_exception_to_status(PJ_GET_EXCEPTION())
#define	PJSIP_THROW_SPEC(list)
Typedefs
typedef struct pjsip_transport	pjsip_transport
typedef struct pjsip_tpmgr	pjsip_tpmgr
typedef struct pjsip_endpoint	pjsip_endpoint
typedef struct pjsip_transaction	pjsip_transaction
typedef struct pjsip_event	pjsip_event
typedef struct pjsip_tx_data	pjsip_tx_data
typedef struct pjsip_rx_data	pjsip_rx_data
typedef struct pjsip_msg	pjsip_msg
typedef struct pjsip_msg_body	pjsip_msg_body
typedef struct pjsip_hdr	pjsip_hdr
typedef struct pjsip_uri	pjsip_uri
typedef struct pjsip_method	pjsip_method
typedef struct pjsip_resolver_t	pjsip_resolver_t
typedef struct pjsip_cred_info	pjsip_cred_info
typedef struct pjsip_module	pjsip_module
typedef pjsip_module	pjsip_user_agent
typedef struct pjsip_dialog	pjsip_dialog
Enumerations
enum	pjsip_transport_type_e {   PJSIP_TRANSPORT_UNSPECIFIED, PJSIP_TRANSPORT_UDP, PJSIP_TRANSPORT_TCP, PJSIP_TRANSPORT_TLS,   PJSIP_TRANSPORT_SCTP, PJSIP_TRANSPORT_LOOP, PJSIP_TRANSPORT_LOOP_DGRAM, PJSIP_TRANSPORT_START_OTHER,   PJSIP_TRANSPORT_IPV6 = 128, PJSIP_TRANSPORT_UDP6 = PJSIP_TRANSPORT_UDP + PJSIP_TRANSPORT_IPV6, PJSIP_TRANSPORT_TCP6 = PJSIP_TRANSPORT_TCP + PJSIP_TRANSPORT_IPV6 }
enum	pjsip_role_e { PJSIP_ROLE_UAC, PJSIP_ROLE_UAS, PJSIP_UAC_ROLE = PJSIP_ROLE_UAC, PJSIP_UAS_ROLE = PJSIP_ROLE_UAS }
Functions
pj_status_t	pjsip_exception_to_status (int exception_id)

---

Define Documentation

 

#define PJSIP_RETURN_EXCEPTION

(

)

pjsip_exception_to_status(PJ_GET_EXCEPTION())

Return standard pj_status_t status from current exception.

#define PJSIP_THROW_SPEC

(

list

)

Attributes to inform that the function may throw exceptions.

---

Typedef Documentation

typedef struct pjsip_transport pjsip_transport

Forward declaration for SIP transport.

typedef struct pjsip_tpmgr pjsip_tpmgr

Forward declaration for transport manager.

typedef struct pjsip_endpoint pjsip_endpoint

Forward declaration for endpoint (sip_endpoint.h).

typedef struct pjsip_transaction pjsip_transaction

Forward declaration for transactions (sip_transaction.h).

typedef struct pjsip_event pjsip_event

Forward declaration for events (sip_event.h).

typedef struct pjsip_tx_data pjsip_tx_data

Forward declaration for transmit data/buffer (sip_transport.h).

typedef struct pjsip_rx_data pjsip_rx_data

Forward declaration for receive data/buffer (sip_transport.h).

typedef struct pjsip_msg pjsip_msg

Forward declaration for message (sip_msg.h).

typedef struct pjsip_msg_body pjsip_msg_body

Forward declaration for message body (sip_msg.h).

typedef struct pjsip_hdr pjsip_hdr

Forward declaration for header field (sip_msg.h).

typedef struct pjsip_uri pjsip_uri

Forward declaration for URI (sip_uri.h).

typedef struct pjsip_method pjsip_method

Forward declaration for SIP method (sip_msg.h)

typedef struct pjsip_resolver_t pjsip_resolver_t

Opaque data type for the resolver engine (sip_resolve.h).

typedef struct pjsip_cred_info pjsip_cred_info

Forward declaration for credential.

typedef struct pjsip_module pjsip_module

Forward declaration for module (sip_module.h).

typedef pjsip_module pjsip_user_agent

Forward declaration for user agent type (sip_ua_layer.h).

typedef struct pjsip_dialog pjsip_dialog

Forward declaration for dialog (sip_dialog.h).

---

Enumeration Type Documentation

enum pjsip_transport_type_e

Transport types.

Enumerator:

PJSIP_TRANSPORT_UNSPECIFIED	Unspecified.
PJSIP_TRANSPORT_UDP	UDP.
PJSIP_TRANSPORT_TCP	TCP.
PJSIP_TRANSPORT_TLS	TLS.
PJSIP_TRANSPORT_SCTP	SCTP.
PJSIP_TRANSPORT_LOOP	Loopback (stream, reliable)
PJSIP_TRANSPORT_LOOP_DGRAM	Loopback (datagram, unreliable)
PJSIP_TRANSPORT_START_OTHER	Start of user defined transport
PJSIP_TRANSPORT_IPV6	Start of IPv6 transports
PJSIP_TRANSPORT_UDP6	UDP over IPv6
PJSIP_TRANSPORT_TCP6	TCP over IPv6

enum pjsip_role_e

Transaction role.

Enumerator:

PJSIP_ROLE_UAC	Role is UAC.
PJSIP_ROLE_UAS	Role is UAS.
PJSIP_UAC_ROLE	Role is UAC.
PJSIP_UAS_ROLE	Role is UAS.

---

Function Documentation

pj_status_t pjsip_exception_to_status

(

int

exception_id

)

Convert exception ID into pj_status_t status.

Parameters:

exception_id

Exception Id.

Returns:

Error code for the specified exception Id.