IAXFrameOut Class Reference

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

#include <yateiax.h>

Inheritance diagram for IAXFrameOut:

IAXFullFrame IAXFrame RefObject GenObject

List of all members.

Public Member Functions

 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)
virtual ~IAXFrameOut ()
bool timeout () const
bool timeForRetrans (u_int64_t time) const
void setRetrans ()
void transmitted ()
bool ack () const
void setAck ()
bool ackOnly () const
void adjustAuthTimeout (u_int64_t nextTransTime)


Detailed Description

This class holds an outgoing IAX full frame.

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


Constructor & Destructor Documentation

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 
) [inline]

Constructor. Constructs an outgoing full frame

Parameters:
type Frame type
subclass Frame subclass
sCallNo Source (remote) call number
dCallNo Destination (local) call number
oSeqNo Outgoing sequence number
iSeqNo Incoming (expected) sequence number
tStamp Frame timestamp
buf IE buffer
len IE buffer length
retransCount Retransmission counter
retransInterval Time interval to the next retransmission
ackOnly Acknoledge only flag. If true, the frame only expects an ACK

virtual ~IAXFrameOut (  )  [inline, virtual]

Destructor


Member Function Documentation

bool timeout (  )  const [inline]

Get the timeout (retransmission counter) of this frame

Returns:
True if the retransmission counter is 0

bool timeForRetrans ( u_int64_t  time  )  const [inline]

Ask the frame if it's time for retransmit

Parameters:
time Current time
Returns:
True if it's time to retransmit

void setRetrans (  ) 

Set the retransmission flag of this frame

void transmitted (  ) 

Update the retransmission counter and the time to next retransmission

bool ack (  )  const [inline]

Get the acknoledged flag of this frame

Returns:
The acknoledged flag of this frame

void setAck (  )  [inline]

Set the acknoledged flag of this frame

bool ackOnly (  )  const [inline]

Get the acknoledge only flag of this frame

Returns:
The acknoledge only flag of this frame

void adjustAuthTimeout ( u_int64_t  nextTransTime  ) 

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

Parameters:
nextTransTime Next transmission time


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

Generated on Mon Aug 11 16:18:52 2008 for Yate by  doxygen 1.5.6