General Data Structure

Data Structures
struct	pj::Error
struct	pj::Version
struct	pj::TimeVal

Macros
#define	PJSUA2_RAISE_ERROR(status)    PJSUA2_RAISE_ERROR2(status, string())
#define	PJSUA2_RAISE_ERROR2(status, op)    PJSUA2_RAISE_ERROR3(status, op, string())
#define	PJSUA2_RAISE_ERROR3(status, op, txt)
#define	PJSUA2_CHECK_RAISE_ERROR2(status, op)
#define	PJSUA2_CHECK_RAISE_ERROR(status)    PJSUA2_CHECK_RAISE_ERROR2(status, "")
#define	PJSUA2_CHECK_EXPR(expr)

Typedefs
typedef std::vector< std::string >	pj::StringVector
typedef std::vector< int >	pj::IntVector
typedef std::map< std::string, std::string >	pj::StringToStringMap
typedef void *	pj::Token
typedef string	pj::SocketAddress
typedef int	pj::TransportId
typedef void *	pj::TransportHandle
typedef void *	pj::TimerEntry
typedef void *	pj::GenericData

Enumerations
enum	{ pj::INVALID_ID = -1 , pj::SUCCESS = 0 }

Detailed Description

Macro Definition Documentation

PJSUA2_RAISE_ERROR

#define PJSUA2_RAISE_ERROR

(

status

)

PJSUA2_RAISE_ERROR2(status, string())

Raise Error exception

PJSUA2_RAISE_ERROR2

#define PJSUA2_RAISE_ERROR2	(		status,
			op
	)		PJSUA2_RAISE_ERROR3(status, op, string())

Raise Error exception

PJSUA2_RAISE_ERROR3

#define PJSUA2_RAISE_ERROR3	(		status,
			op,
			txt
	)

Value:

        do { \
            Error err_ = Error(status, op, txt, string(), 0); \
            PJ_LOG(1,(THIS_FILE, "%s", err_.info().c_str())); \
            throw err_; \
        } while (0)

Raise Error exception

PJSUA2_CHECK_RAISE_ERROR2

#define PJSUA2_CHECK_RAISE_ERROR2	(		status,
			op
	)

Value:

        do { \
            if (status != PJ_SUCCESS) { \
                PJSUA2_RAISE_ERROR2(status, op); \
            } \
        } while (0)

Raise Error exception if the expression fails

PJSUA2_CHECK_RAISE_ERROR

#define PJSUA2_CHECK_RAISE_ERROR

(

status

)

PJSUA2_CHECK_RAISE_ERROR2(status, "")

Raise Error exception if the status fails

PJSUA2_CHECK_EXPR

#define PJSUA2_CHECK_EXPR

(

expr

)

Value:

        do { \
            pj_status_t the_status = expr;      \
            PJSUA2_CHECK_RAISE_ERROR2(the_status, #expr); \
        } while (0)

Raise Error exception if the expression fails

Typedef Documentation

StringVector

typedef std::vector<std::string> pj::StringVector

Array of strings

IntVector

typedef std::vector<int> pj::IntVector

Array of integers

StringToStringMap

typedef std::map<std::string, std::string> pj::StringToStringMap

Map string to string

Token

typedef void* pj::Token

Type of token, i.e. arbitrary application user data

SocketAddress

typedef string pj::SocketAddress

Socket address, encoded as string. The socket address contains host and port number in "host[:port]" format. The host part may contain hostname, domain name, IPv4 or IPv6 address. For IPv6 address, the address will be enclosed with square brackets, e.g. "[::1]:5060".

TransportId

typedef int pj::TransportId

Transport ID is an integer.

TransportHandle

typedef void* pj::TransportHandle

Transport handle, corresponds to pjsip_transport instance.

TimerEntry

typedef void* pj::TimerEntry

Timer entry, corresponds to pj_timer_entry

GenericData

typedef void* pj::GenericData

Generic data

Enumeration Type Documentation

anonymous enum

anonymous enum

Constants

Enumerator
INVALID_ID	Invalid ID, equal to PJSUA_INVALID_ID
SUCCESS	Success, equal to PJ_SUCCESS