An IAX2 transaction. More...

#include <yateiax.h>

Inheritance diagram for IAXTransaction:

Public Types
enum	Type { Incorrect, New, RegReq, RegRel, Poke }
enum	State { Connected, NewLocalInvite, NewLocalInvite_AuthRecv, NewLocalInvite_RepSent, NewRemoteInvite, NewRemoteInvite_AuthSent, NewRemoteInvite_RepRecv, Unknown, Terminated, Terminating }
Public Member Functions
virtual	~IAXTransaction ()
IAXEngine *	getEngine () const
Type	type () const
State	state () const
u_int64_t	timeStamp () const
bool	outgoing () const
void	setUserData (void *data)
void *	getUserData () const
u_int16_t	localCallNo () const
u_int16_t	remoteCallNo () const
const SocketAddr &	remoteAddr () const
const String &	username ()
const String &	callingNo ()
const String &	callingName ()
const String &	calledNo ()
const String &	calledContext ()
const String &	challenge ()
IAXFormat *	getFormat (int type)
IAXMediaData *	getData (int type)
u_int32_t	format (int type)
u_int32_t	formatIn (int type)
u_int32_t	formatOut (int type)
u_int32_t	capability () const
u_int32_t	expire () const
const String &	authdata ()
IAXTransaction *	processFrame (IAXFrame *frame)
IAXTransaction *	processMedia (DataBlock &data, u_int32_t tStamp, int type=IAXFormat::Audio, bool full=false, bool mark=false)
unsigned int	sendMedia (const DataBlock &data, u_int32_t format, int type=IAXFormat::Audio, bool mark=false)
IAXEvent *	getEvent (u_int64_t time)
bool	sendAnswer ()
bool	sendRinging ()
bool	sendProgress ()
bool	sendAccept (unsigned int *expires=0)
bool	sendHangup (const char *cause=0, u_int8_t code=0)
bool	sendReject (const char *cause=0, u_int8_t code=0)
bool	sendAuth ()
bool	sendAuthReply (const String &response)
bool	sendDtmf (u_int8_t dtmf)
bool	sendText (const char *text)
bool	sendNoise (u_int8_t noise)
bool	abortReg ()
bool	enableTrunking (IAXMetaTrunkFrame *trunkFrame)
void	processCallToken (const DataBlock &callToken)
void	print (bool printStats=false, bool printFrames=false, const char *location="status")
Static Public Member Functions
static IAXTransaction *	factoryIn (IAXEngine engine, IAXFullFrame frame, u_int16_t lcallno, const SocketAddr &addr, void *data=0)
static IAXTransaction *	factoryOut (IAXEngine engine, Type type, u_int16_t lcallno, const SocketAddr &addr, IAXIEList &ieList, void data=0)
static unsigned char	getMaxFrameList ()
static bool	setMaxFrameList (unsigned char value)
Static Public Attributes
static String	s_iax_modNoAuthMethod
static String	s_iax_modNoMediaFormat
static String	s_iax_modInvalidAuth
static String	s_iax_modNoUsername
Protected Member Functions
	IAXTransaction (IAXEngine engine, IAXFullFrame frame, u_int16_t lcallno, const SocketAddr &addr, void *data=0)
	IAXTransaction (IAXEngine engine, Type type, u_int16_t lcallno, const SocketAddr &addr, IAXIEList &ieList, void data=0)
virtual void	destroyed ()
void	init (IAXIEList &ieList)
bool	incrementSeqNo (const IAXFullFrame *frame, bool inbound)
bool	isFrameAcceptable (const IAXFullFrame *frame)
bool	changeState (State newState)
IAXEvent *	terminate (u_int8_t evType, bool local, IAXFullFrame *frame=0, bool createIEList=true)
IAXEvent *	waitForTerminate (u_int8_t evType, bool local, IAXFullFrame *frame)
void	postFrame (IAXFrame::Type type, u_int32_t subclass, void *data=0, u_int16_t len=0, u_int32_t tStamp=0, bool ackOnly=false, bool mark=false)
void	postFrameIes (IAXFrame::Type type, u_int32_t subclass, IAXIEList *ies, u_int32_t tStamp=0, bool ackOnly=false)
bool	sendFrame (IAXFrameOut *frame, bool vnak=false)
IAXEvent *	createEvent (u_int8_t evType, bool local, IAXFullFrame *frame, State newState)
IAXEvent *	createResponse (IAXFrameOut *frame, u_int8_t findType, u_int8_t findSubclass, u_int8_t evType, bool local, State newState)
IAXEvent *	getEventResponse (IAXFrameOut *frame, bool &delFrame)
IAXEvent *	getEventResponse_New (IAXFrameOut *frame, bool &delFrame)
IAXEvent *	processAuthReq (IAXEvent *event)
IAXEvent *	processAccept (IAXEvent *event)
IAXEvent *	processAuthRep (IAXEvent *event)
IAXEvent *	getEventResponse_Reg (IAXFrameOut *frame, bool &delFrame)
IAXEvent *	processRegAck (IAXEvent *event)
IAXEvent *	getEventStartTrans (IAXFullFrame *frame, bool &delFrame)
IAXEvent *	getEventRequest (IAXFullFrame *frame, bool &delFrame)
IAXEvent *	getEventRequest_New (IAXFullFrame *frame, bool &delFrame)
IAXFullFrame *	findInFrame (IAXFrame::Type type, u_int32_t subclass)
bool	findInFrameTimestamp (const IAXFullFrame *frameOut, IAXFrame::Type type, u_int32_t subclass)
bool	findInFrameAck (const IAXFullFrame *frameOut)
void	ackInFrames ()
bool	sendConnected (IAXFullFrame::ControlType subclass, IAXFrame::Type frametype=IAXFrame::Control)
void	sendAck (const IAXFullFrame *frame)
void	sendInval ()
void	sendVNAK ()
void	sendUnsupport (u_int32_t subclass)
IAXEvent *	processInternalOutgoingRequest (IAXFrameOut *frame, bool &delFrame)
IAXEvent *	processInternalIncomingRequest (const IAXFullFrame *frame, bool &delFrame)
IAXEvent *	processMidCallControl (IAXFullFrame *frame, bool &delFrame)
IAXEvent *	processMidCallIAXControl (IAXFullFrame *frame, bool &delFrame)
IAXEvent *	remoteRejectCall (IAXFullFrame *frame, bool &delFrame)
IAXEvent *	getEventTerminating (u_int64_t time)
IAXTransaction *	processMediaFrame (const IAXFullFrame *frame, int type)
IAXTransaction *	retransmitOnVNAK (u_int16_t seqNo)
IAXEvent *	internalAccept ()
IAXEvent *	internalReject (String &reason)
void	eventTerminated (IAXEvent *event)
IAXEvent *	keepEvent (IAXEvent *event)
Friends
class	IAXEvent
class	IAXEngine

Detailed Description

An IAX2 transaction.

This class holds all the data needded for the management of an IAX2 transaction which might be a call leg, a register/unregister or a poke one

Member Enumeration Documentation

enum State

The transaction state as enumeration

enum Type

The transaction type as enumeration

Constructor & Destructor Documentation

virtual ~IAXTransaction ( ) [virtual]

Destructor

IAXTransaction	(	IAXEngine *	engine,
		IAXFullFrame *	frame,
		u_int16_t	lcallno,
		const SocketAddr &	addr,
		void *	data = `0`
	)		`[protected]`

Constructor: constructs an incoming transaction from a received full frame with an IAX control message that needs a new transaction

Parameters:

engine	The engine that owns this transaction
frame	A valid full frame
lcallno	Local call number
addr	Address from where the frame was received
data	Pointer to arbitrary user data

IAXTransaction	(	IAXEngine *	engine,
		Type	type,
		u_int16_t	lcallno,
		const SocketAddr &	addr,
		IAXIEList &	ieList,
		void *	data = `0`
	)		`[protected]`

Constructor: constructs an outgoing transaction with an IAX control message that needs a new transaction

Parameters:

engine	The engine that owns this transaction
type	Transaction type: see Type enumeration
lcallno	Local call number
addr	Address to use
ieList	Starting IE list
data	Pointer to arbitrary user data

Member Function Documentation

bool abortReg ( )

Abort a registration transaction This method is thread safe

Returns:: False transaction is not a registration one or is already terminating

void ackInFrames ( ) [protected]

Acknoledge the last received full frame

const String& authdata ( ) [inline]

Retrieve the authentication data sent/received during authentication

Returns:: A reference to the authentication data

const String& calledContext ( ) [inline]

Retrieve the called context

Returns:: A reference to the called context

const String& calledNo ( ) [inline]

Retrieve the called number

Returns:: A reference to the called number

const String& callingName ( ) [inline]

Retrieve the calling name

Returns:: A reference to the calling name

const String& callingNo ( ) [inline]

Retrieve the calling number

Returns:: A reference to the calling number

u_int32_t capability ( ) const [inline]

Retrieve the media capability of this transaction

Returns:: The media capability of this transaction

const String& challenge ( ) [inline]

Retrieve the challenge sent/received during authentication

Returns:: A reference to the challenge

bool changeState ( State newState ) [protected]

Change the transaction state

Parameters:

newState the new transaction state

Returns:: False if trying to change a termination state into a non termination one

IAXEvent* createEvent	(	u_int8_t	evType,
		bool	local,
		IAXFullFrame *	frame,
		State	newState
	)		`[protected]`

Create an event

Parameters:

evType	Event type
local	If true it is a locally generated event.
frame	Frame to create from
newState	The transaction new state

Returns:: Pointer to an IAXEvent or 0 (invalid IE list)

IAXEvent* createResponse	(	IAXFrameOut *	frame,
		u_int8_t	findType,
		u_int8_t	findSubclass,
		u_int8_t	evType,
		bool	local,
		State	newState
	)		`[protected]`

Create an event from a received frame that is a response to a sent frame and change the transaction state to newState. Remove the response from incoming list.

Parameters:

frame	Frame to create response for
findType	Frame type to find
findSubclass	Frame subclass to find
evType	Event type to generate
local	Local flag for the generated event.
newState	New transaction state if an event was generated

Returns:: Pointer to an IAXEvent or 0 (invalid IE list)

virtual void destroyed ( ) [protected, virtual]

Cleanup

Reimplemented from RefObject.

bool enableTrunking ( IAXMetaTrunkFrame * trunkFrame )

Enable trunking for this transaction

Parameters:

trunkFrame Pointer to IAXMetaTrunkFrame used to send trunked media

Returns:: False trunking is already enabled for this transactio or trunkFrame is 0

void eventTerminated ( IAXEvent * event ) [protected]

Event terminated feedback This method is thread safe

Parameters:

event The event notifying termination

u_int32_t expire ( ) const [inline]

Retrieve the expiring time for a register/unregister transaction

Returns:: The expiring time for a register/unregister transaction

static IAXTransaction* factoryIn	(	IAXEngine *	engine,
		IAXFullFrame *	frame,
		u_int16_t	lcallno,
		const SocketAddr &	addr,
		void *	data = `0`
	)		`[static]`

Constructs an incoming transaction from a received full frame with an IAX control message that needs a new transaction

Parameters:

engine	The engine that owns this transaction
frame	A valid full frame
lcallno	Local call number
addr	Address from where the frame was received
data	Pointer to arbitrary user data

static IAXTransaction* factoryOut	(	IAXEngine *	engine,
		Type	type,
		u_int16_t	lcallno,
		const SocketAddr &	addr,
		IAXIEList &	ieList,
		void *	data = `0`
	)		`[static]`

Constructs an outgoing transaction with an IAX control message that needs a new transaction

Parameters:

engine	The engine that owns this transaction
type	Transaction type
lcallno	Local call number
addr	Address to use
ieList	Starting IE list
data	Pointer to arbitrary user data

IAXFullFrame* findInFrame	(	IAXFrame::Type	type,
		u_int32_t	subclass
	)		`[protected]`

Search for a frame in m_inFrames having the given type and subclass

Parameters:

type	Frame type to find.
subclass	Frame subclass to find.

Returns:: Pointer to frame if found or 0.

bool findInFrameAck ( const IAXFullFrame * frameOut ) [protected]

Search in m_inFrames for an ACK frame which confirm the received frame and deletes it

Parameters:

frameOut Frame to find response for

Returns:: True if found.

bool findInFrameTimestamp	(	const IAXFullFrame *	frameOut,
		IAXFrame::Type	type,
		u_int32_t	subclass
	)		`[protected]`

Search in m_inFrames for a frame with the same timestamp as frameOut and deletes it.

Parameters:

frameOut	Frame to find response for
type	Frame type to find
subclass	Frame subclass to find

Returns:: True if found.

u_int32_t format ( int type ) [inline]

Retrieve the media format used during initialization

Parameters:

type	Media type to retrieve

Returns:: The initial media format for the given type

References IAXFormat::format().

u_int32_t formatIn ( int type ) [inline]

Retrieve the incoming media format

Parameters:

type	Media type to retrieve

Returns:: The incoming media format for the given type

References IAXFormat::in().

u_int32_t formatOut ( int type ) [inline]

Retrieve the outgoing media format

Parameters:

type	Media type to retrieve

Returns:: The outgoing media format for the given type

References IAXFormat::out().

IAXMediaData* getData ( int type )

Retrieve the media data for a given type

Parameters:

type	Media type to retrieve

Returns:: IAXMediaData pointer or 0 for invalid type

IAXEngine* getEngine ( ) const [inline]

The IAX engine this transaction belongs to

Returns:: Pointer to the IAXEngine of this transaction

IAXEvent* getEvent ( u_int64_t time )

Get an IAX event from the queue This method is thread safe.

Parameters:

time	The time this method was called

Returns:: Pointer to an IAXEvent or 0 if none available

IAXEvent* getEventRequest	(	IAXFullFrame *	frame,
		bool &	delFrame
	)		`[protected]`

Find out if a frame is a remote request

Parameters:

frame	Frame to process
delFrame	Delete rame flag. If true on exit, a request was found

Returns:: Pointer to an IAXEvent or 0

IAXEvent* getEventRequest_New	(	IAXFullFrame *	frame,
		bool &	delFrame
	)		`[protected]`

Find out if a frame is a remote request if transaction type is New

Parameters:

frame	Frame to process
delFrame	Delete rame flag. If true on exit, a request was found

Returns:: Pointer to an IAXEvent or 0

IAXEvent* getEventResponse	(	IAXFrameOut *	frame,
		bool &	delFrame
	)		`[protected]`

Find a response for a previously sent frame

Parameters:

frame	Frame to find response for
delFrame	Delete frame flag. If true on exit, a response was found

Returns:: Pointer to an IAXEvent or 0

IAXEvent* getEventResponse_New	(	IAXFrameOut *	frame,
		bool &	delFrame
	)		`[protected]`

Find a response for a previously sent frame if the transaction type is New

Parameters:

frame	Frame to find response for
delFrame	Delete frame flag. If true on exit, a response was found

Returns:: Pointer to an IAXEvent or 0

IAXEvent* getEventResponse_Reg	(	IAXFrameOut *	frame,
		bool &	delFrame
	)		`[protected]`

Find a response for a previously sent frame if the transaction type is RegReq/RegRel

Parameters:

frame	Frame to find response for
delFrame	Delete frame flag. If true on exit, a response was found

Returns:: Pointer to an IAXEvent or 0

IAXEvent* getEventStartTrans	(	IAXFullFrame *	frame,
		bool &	delFrame
	)		`[protected]`

Find out if an incoming frame would start a transaction

Parameters:

frame	Frame to process
delFrame	Delete frame flag. If true on exit, frame is valid

Returns:: Pointer to an IAXEvent or 0

IAXEvent* getEventTerminating ( u_int64_t time ) [protected]

Terminate the transaction if state is Terminating on a remote request

Parameters:

time	Current time

Returns:: A valid IAXEvent or 0

IAXFormat* getFormat ( int type )

Retrieve the media of a given type

Parameters:

type	Media type to retrieve

Returns:: IAXFormat pointer or 0 for invalid type

static unsigned char getMaxFrameList ( ) [static]

Get the maximum allowed number of full frames in the incoming frame list

Returns:: The maximum allowed number of full frames in the incoming frame list

void* getUserData ( ) const [inline]

Return the opaque user data stored in the transaction

Returns:: Pointer set by user

Referenced by IAXEvent::getUserData().

bool incrementSeqNo	(	const IAXFullFrame *	frame,
		bool	inbound
	)		`[protected]`

Increment sequence numbers (inbound or outbound) for the frames that need it

Parameters:

frame	Received frame if inbound is true, otherwise a transmitted one
inbound	True for inbound frames

Returns:: True if incremented.

void init ( IAXIEList & ieList ) [protected]

Init data members from an IE list

Parameters:

ieList IE list to init from

IAXEvent* internalAccept ( ) [protected]

Generate an Accept event after internally accepting a transaction

Returns:: A valid IAXEvent

IAXEvent* internalReject ( String & reason ) [protected]

Generate a Reject event after internally rejecting a transaction

Parameters:

reason The reason of rejecting

Returns:: A valid IAXEvent

bool isFrameAcceptable ( const IAXFullFrame * frame ) [protected]

Test if frame is acceptable (not an out of order or a late one)

Parameters:

frame Frame to test

Returns:: True if frame can be added to incoming frame list

IAXEvent* keepEvent ( IAXEvent * event ) [inline, protected]

Set the current event

Parameters:

event The event notifying termination

Returns:: event

u_int16_t localCallNo ( ) const [inline]

Retrieve the local call number

Returns:: 15-bit local call number

bool outgoing ( ) const [inline]

Get the direction of this transaction

Returns:: True if it is an outgoing transaction

void postFrame	(	IAXFrame::Type	type,
		u_int32_t	subclass,
		void *	data = `0`,
		u_int16_t	len = `0`,
		u_int32_t	tStamp = `0`,
		bool	ackOnly = `false`,
		bool	mark = `false`
	)		`[protected]`

Constructs an IAXFrameOut frame, send it to remote peer and put it in the transmission list This method is thread safe

Parameters:

type	Frame type
subclass	Frame subclass
data	Frame IE list
len	Frame IE list length
tStamp	Frame timestamp. If 0 the transaction timestamp will be used
ackOnly	Frame's acknoledge only flag
mark	Frame mark flag

void postFrameIes	(	IAXFrame::Type	type,
		u_int32_t	subclass,
		IAXIEList *	ies,
		u_int32_t	tStamp = `0`,
		bool	ackOnly = `false`
	)		`[protected]`

Constructs an IAXFrameOut frame, send it to remote peer and put it in the transmission list This method is thread safe

Parameters:

type	Frame type
subclass	Frame subclass
ies	Frame IE list
tStamp	Frame timestamp. If 0 the transaction timestamp will be used
ackOnly	Frame's acknoledge only flag

void print	(	bool	printStats = `false`,
		bool	printFrames = `false`,
		const char *	location = `"status"`
	)

Print transaction data on stdin

Parameters:

printStats	True to print media statistics
printFrames	True to print in/out pending frames
location	Additional location info to be shown in debug

IAXEvent* processAccept ( IAXEvent * event ) [protected]

Process an accept. If not valid (call m_engine->acceptFormatAndCapability) send a reject. Otherwise return the event

Parameters:

event Already generated event

Returns:: Pointer to a valid IAXEvent

IAXEvent* processAuthRep ( IAXEvent * event ) [protected]

Process an authentication reply

Parameters:

event Already generated event

Returns:: Pointer to a valid IAXEvent

IAXEvent* processAuthReq ( IAXEvent * event ) [protected]

Process an authentication request. If valid, send an authentication reply

Parameters:

event Already generated event

Returns:: Pointer to a valid IAXEvent

void processCallToken ( const DataBlock & callToken )

Process a received call token This method is thread safe

Parameters:

callToken Received call token

IAXTransaction* processFrame ( IAXFrame * frame )

Process a frame from remote peer This method is thread safe.

Parameters:

frame IAX frame belonging to this transaction to process

Returns:: 'this' if successful or NULL if the frame is invalid

IAXEvent* processInternalIncomingRequest	(	const IAXFullFrame *	frame,
		bool &	delFrame
	)		`[protected]`

Internal protocol incoming frames processing (PING/LAGRQ)

Parameters:

frame	Frame to process
delFrame	Delete frame flag. If true on exit, a request was found

Returns:: 0.

IAXEvent* processInternalOutgoingRequest	(	IAXFrameOut *	frame,
		bool &	delFrame
	)		`[protected]`

Internal protocol outgoing frames processing (PING/LAGRQ)

Parameters:

frame	Frame to process
delFrame	Delete frame flag. If true on exit, a response was found

Returns:: 0.

IAXTransaction* processMedia	(	DataBlock &	data,
		u_int32_t	tStamp,
		int	type = `IAXFormat::Audio`,
		bool	full = `false`,
		bool	mark = `false`
	)

Process received media data

Parameters:

data	Received data
tStamp	Mini frame timestamp
type	Media type
full	True if received in a full frame
mark	Mark flag

Returns:: 0

IAXTransaction* processMediaFrame	(	const IAXFullFrame *	frame,
		int	type
	)		`[protected]`

Process received media full frames

Parameters:

frame	Received frame
type	Media type

Returns:: 0

IAXEvent* processMidCallControl	(	IAXFullFrame *	frame,
		bool &	delFrame
	)		`[protected]`

Process mid call control frames

Parameters:

frame	Frame to process
delFrame	Delete frame flag. If true on exit, a request was found

Returns:: A valid IAXEvent or 0

IAXEvent* processMidCallIAXControl	(	IAXFullFrame *	frame,
		bool &	delFrame
	)		`[protected]`

Process mid call IAX control frames

Parameters:

frame	Frame to process
delFrame	Delete frame flag. If true on exit, a request was found

Returns:: A valid IAXEvent or 0

IAXEvent* processRegAck ( IAXEvent * event ) [protected]

Update transaction data from the event

Parameters:

event Already generated event

Returns:: The received event

const SocketAddr& remoteAddr ( ) const [inline]

Retrieve the remote host+port address

Returns:: A reference to the remote address

u_int16_t remoteCallNo ( ) const [inline]

Retrieve the remote call number

Returns:: 15-bit remote call number

IAXEvent* remoteRejectCall	(	IAXFullFrame *	frame,
		bool &	delFrame
	)		`[protected]`

Test if frame is a Reject/RegRej frame

Parameters:

frame	Frame to process.
delFrame	Delete frame flag. If true on exit, a request was found

Returns:: A valid IAXEvent or 0.

IAXTransaction* retransmitOnVNAK ( u_int16_t seqNo ) [protected]

Send all frames from outgoing queue with outbound sequence number starting with seqNo.

Parameters:

seqNo Requested sequence number

Returns:: 0

bool sendAccept ( unsigned int * expires = 0 )

Send an ACCEPT/REGACK frame to remote peer This method is thread safe

Parameters:

expires Optional pointer to expiring time for register transactions

Returns:: False if the transaction type is not New and state is NewRemoteInvite or NewRemoteInvite_AuthRep or if the transaction type is not RegReq and state is NewRemoteInvite or type is not RegReq/RegRel and state is NewRemoteInvite_AuthRep

void sendAck ( const IAXFullFrame * frame ) [protected]

Send an ACK frame

Parameters:

frame Aknoledged frame

bool sendAnswer ( ) [inline]

Send an ANSWER frame to remote peer This method is thread safe

Returns:: False if the current transaction state is not Connected

bool sendAuth ( )

Send an AUTHREQ/REGAUTH frame to remote peer This method is thread safe

Returns:: False if the current transaction state is not NewRemoteInvite

bool sendAuthReply ( const String & response )

Send an AUTHREP/REGREQ/REGREL frame to remote peer as a response to AUTHREQ/REGREQ/REGREL This method is thread safe

Parameters:

response Response to send

Returns:: False if the current transaction state is not NewLocalInvite_AuthRecv

bool sendConnected	(	IAXFullFrame::ControlType	subclass,
		IAXFrame::Type	frametype = `IAXFrame::Control`
	)		`[protected]`

Send a frame to remote peer in state Connected This method is thread safe

Parameters:

subclass	Frame subclass to send
frametype	Frame type to send

Returns:: False if the current transaction state is not Connected

bool sendDtmf ( u_int8_t dtmf ) [inline]

Send a DTMF frame to remote peer This method is thread safe

Parameters:

dtmf	DTMF char to send

Returns:: False if the current transaction state is not Connected or dtmf is grater then 127

bool sendFrame	(	IAXFrameOut *	frame,
		bool	vnak = `false`
	)		`[protected]`

Send a full frame to remote peer

Parameters:

frame	Frame to send
vnak	If true the transmission is a response to a VNAK frame

Returns:: True on success

bool sendHangup	(	const char *	cause = `0`,
		u_int8_t	code = `0`
	)

Send a HANGUP frame to remote peer This method is thread safe

Parameters:

cause	Optional reason for hangup
code	Optional code of reason

Returns:: False if the transaction type is not New or state is Terminated/Terminating

void sendInval ( ) [protected]

Send an INVAL frame

unsigned int sendMedia	(	const DataBlock &	data,
		u_int32_t	format,
		int	type = `IAXFormat::Audio`,
		bool	mark = `false`
	)

Send media data to remote peer. Update the outgoing media format if changed

Parameters:

data	Data to send
format	Data format
type	Media type
mark	Mark flag

Returns:: The number of bytes sent

bool sendNoise ( u_int8_t noise ) [inline]

Send a NOISE frame to remote peer This method is thread safe

Parameters:

noise Noise value to send

Returns:: False if the current transaction state is not Connected or noise is grater then 127

bool sendProgress ( ) [inline]

Send a PROCEEDING frame to remote peer This method is thread safe

Returns:: False if the current transaction state is not Connected

bool sendReject	(	const char *	cause = `0`,
		u_int8_t	code = `0`
	)

Send a REJECT/REGREJ frame to remote peer This method is thread safe

Parameters:

cause	Optional reason for reject
code	Optional code of reason

Returns:: False if the transaction type is not New/RegReq/RegRel or state is Terminated/Terminating

bool sendRinging ( ) [inline]

Send a RINGING frame to remote peer This method is thread safe

Returns:: False if the current transaction state is not Connected

bool sendText ( const char * text )

Send a TEXT frame to remote peer This method is thread safe

Parameters:

text	Text to send

Returns:: False if the current transaction state is not Connected

void sendUnsupport ( u_int32_t subclass ) [protected]

Send an Unsupport frame

Parameters:

subclass Unsupported frame's subclass

void sendVNAK ( ) [protected]

Send an VNAK frame

static bool setMaxFrameList ( unsigned char value ) [static]

Set the maximum allowed number of full frames in the incoming frame list

Parameters:

value The new value of m_maxInFrames

Returns:: False if value is greater then IAX2_MAX_TRANSINFRAMELIST

void setUserData ( void * data ) [inline]

Store a pointer to arbitrary user data

Parameters:

data	User provided pointer

State state ( ) const [inline]

Get the state of this transaction

Returns:: The state of the transaction as enumeration

IAXEvent* terminate	(	u_int8_t	evType,
		bool	local,
		IAXFullFrame *	frame = `0`,
		bool	createIEList = `true`
	)		`[protected]`

Terminate the transaction.

Parameters:

evType	IAXEvent type to generate
local	If true it is a locally generated event
frame	Frame to build event from
createIEList	If true create IE list in the generated event