pj::SipTxOption Struct Reference

#include <siptypes.hpp>

Public Member Functions
bool	isEmpty () const
void	fromPj (const pjsua_msg_data &prm) throw (Error)
void	toPj (pjsua_msg_data &msg_data) const

Data Fields
string	targetUri
SipHeaderVector	headers
string	contentType
string	msgBody
SipMediaType	multipartContentType
SipMultipartPartVector	multipartParts

Detailed Description

Additional options when sending outgoing SIP message. This corresponds to pjsua_msg_data structure in PJSIP library.

Member Function Documentation

isEmpty()

bool pj::SipTxOption::isEmpty

(

)

const

Check if the options are empty. If the options are set with empty values, there will be no additional information sent with outgoing SIP message.

Returns

True if the options are empty.

fromPj()

void pj::SipTxOption::fromPj	(	const pjsua_msg_data &	prm	)
throw	(	Error
	)

Initiaize from PJSUA's pjsua_msg_data.

toPj()

void pj::SipTxOption::toPj

(

pjsua_msg_data &

msg_data

)

const

Convert to PJSUA's pjsua_msg_data.

Field Documentation

targetUri

string pj::SipTxOption::targetUri

Optional remote target URI (i.e. Target header). If empty (""), the target will be set to the remote URI (To header). At the moment this field is only used when sending initial INVITE and MESSAGE requests.

headers

SipHeaderVector pj::SipTxOption::headers

Additional message headers to be included in the outgoing message.

contentType

string pj::SipTxOption::contentType

MIME type of the message body, if application specifies the messageBody in this structure.

msgBody

string pj::SipTxOption::msgBody

Optional message body to be added to the message, only when the message doesn't have a body.

multipartContentType

SipMediaType pj::SipTxOption::multipartContentType

Content type of the multipart body. If application wants to send multipart message bodies, it puts the parts in multipartParts and set the content type in multipartContentType. If the message already contains a body, the body will be added to the multipart bodies.

multipartParts

SipMultipartPartVector pj::SipTxOption::multipartParts

Array of multipart parts. If application wants to send multipart message bodies, it puts the parts in parts and set the content type in multipart_ctype. If the message already contains a body, the body will be added to the multipart bodies.

---

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

• siptypes.hpp