class IAXMetaTrunkFrame

Meta trunk frame. More...

Full nameTelEngine::IAXMetaTrunkFrame
Definition#include <libs/yiax/yateiax.h>
InheritsTelEngine::Mutex [public ], TelEngine::RefObject [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

Handle meta trunk frame with timestamps

 IAXMetaTrunkFrame (IAXEngine* engine, const SocketAddr& addr, bool timestamps, unsigned int maxLen, unsigned int sendInterval)

IAXMetaTrunkFrame

Constructor. Constructs an outgoing meta trunk frame

Parameters:
engineThe engine that owns this frame
addrRemote peer address
timestampsTrue if miniframes have timestamps, false if not
maxLenMaximum frame length
sendIntervalTrunk send interval in milliseconds

 ~IAXMetaTrunkFrame ()

~IAXMetaTrunkFrame

[virtual]

Destructor

inline const SocketAddr&  addr ()

addr

[const]

Get the remote peer address

Returns: The remote peer address

inline unsigned int  calls ()

calls

[const]

Retrieve the number of calls using this trunk

Returns: The number of calls using this trunk

inline void  changeCalls (bool add)

changeCalls

Change the number of calls using this trunk

Parameters:
addTrue to add a call, false to remove it

inline bool  trunkTimestamps ()

trunkTimestamps

[const]

Check if the frame is adding mini frames timestamps

Returns: True if the frame is adding mini frames timestamps

inline unsigned int  sendInterval ()

sendInterval

[const]

Retrieve the send interval

Returns: Send interval in milliseconds

inline unsigned int  maxLen ()

maxLen

[const]

Retrieve the frame maximum length

Returns: Frame maximum length

unsigned int  add (u_int16_t sCallNo, const DataBlock& data, u_int32_t tStamp)

add

Add a mini frame. If no room, send before adding

Parameters:
sCallNoSorce call number
dataMini frame data
tStampMini frame timestamp

Returns: The number of data bytes added to trunk, 0 on failure

inline bool  timerTick (const Time& now = Time())

timerTick

Send this frame to remote peer if the time arrived

Parameters:
nowCurrent time

Returns: The result of the write operation

inline bool  send ()

send

Send this frame to remote peer if there is any data in buffer

Returns: The result of the write operation


Generated by: paulc on bussard on Sun Oct 20 21:06:06 2013, using kdoc 2.0a54.