class IAXFrameOut

This class holds an outgoing IAX full frame. More...

Full nameTelEngine::IAXFrameOut
Definition#include <libs/yiax/yateiax.h>
InheritsTelEngine::IAXFullFrame [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

This class holds all data needded to manage an outgoing IAX full frame

inline  IAXFrameOut (Type type, u_int32_t subclass, u_int16_t sCallNo, u_int16_t dCallNo, unsigned char oSeqNo, unsigned char iSeqNo, u_int32_t tStamp, const unsigned char* buf, unsigned int len, u_int16_t retransCount, u_int32_t retransInterval, bool ackOnly)

IAXFrameOut

Constructor. Constructs an outgoing full frame

Parameters:
typeFrame type
subclassFrame subclass
sCallNoSource (remote) call number
dCallNoDestination (local) call number
oSeqNoOutgoing sequence number
iSeqNoIncoming (expected) sequence number
tStampFrame timestamp
bufIE buffer
lenIE buffer length
retransCountRetransmission counter
retransIntervalTime interval to the next retransmission
ackOnlyAcknoledge only flag. If true, the frame only expects an ACK

 ~IAXFrameOut ()

~IAXFrameOut

[virtual]

Destructor

inline bool  timeout ()

timeout

[const]

Get the timeout (retransmission counter) of this frame

Returns: True if the retransmission counter is 0

inline bool  timeForRetrans (u_int64_t time)

timeForRetrans

[const]

Ask the frame if it's time for retransmit

Parameters:
timeCurrent time

Returns: True if it's time to retransmit

void  setRetrans ()

setRetrans

Set the retransmission flag of this frame

void  transmitted ()

transmitted

Update the retransmission counter and the time to next retransmission

inline bool  ack ()

ack

[const]

Get the acknoledged flag of this frame

Returns: The acknoledged flag of this frame

inline void  setAck ()

setAck

Set the acknoledged flag of this frame

inline bool  ackOnly ()

ackOnly

[const]

Get the acknoledge only flag of this frame

Returns: The acknoledge only flag of this frame

void  adjustAuthTimeout (u_int64_t nextTransTime)

adjustAuthTimeout

Increase the timeout for acknoledged authentication frames sent and set the counter to 1

Parameters:
nextTransTimeNext transmission time


Generated by: paulc on bussard on Fri Apr 1 18:17:10 2011, using kdoc 2.0a54.