pj::Error Struct Reference

#include <types.hpp>

Public Member Functions
string	info (bool multi_line=false) const
	Error ()
	Error (pj_status_t prm_status, const string &prm_title, const string &prm_reason, const string &prm_src_file, int prm_src_line)

Data Fields
pj_status_t	status
string	title
string	reason
string	srcFile
int	srcLine

Detailed Description

This structure contains information about an error that is thrown as an exception.

Constructor & Destructor Documentation

Error() [1/2]

pj::Error::Error

(

)

Default constructor

Error() [2/2]

pj::Error::Error	(	pj_status_t	prm_status,
		const string &	prm_title,
		const string &	prm_reason,
		const string &	prm_src_file,
		int	prm_src_line
	)

Construct an Error instance from the specified parameters. If prm_reason is empty, it will be filled with the error description for the status code.

Member Function Documentation

info()

string pj::Error::info

(

bool

multi_line = false

)

const

Build error string.

Field Documentation

status

pj_status_t pj::Error::status

The error code.

title

string pj::Error::title

The PJSUA API operation that throws the error.

reason

string pj::Error::reason

The error message

srcFile

string pj::Error::srcFile

The PJSUA source file that throws the error

srcLine

int pj::Error::srcLine

The line number of PJSUA source file that throws the error

---

The documentation for this struct was generated from the following file:

• types.hpp