Yate
Public Member Functions
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, bool mark=false)
 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, IAXIEList *ieList, u_int16_t maxlen, u_int16_t retransCount, u_int32_t retransInterval, bool ackOnly, bool mark=false)
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,
bool  mark = false 
) [inline]

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
markMark flag
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,
IAXIEList ieList,
u_int16_t  maxlen,
u_int16_t  retransCount,
u_int32_t  retransInterval,
bool  ackOnly,
bool  mark = false 
) [inline]

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
ieListList of frame IEs
maxlenMax frame data length
retransCountRetransmission counter
retransIntervalTime interval to the next retransmission
ackOnlyAcknoledge only flag. If true, the frame only expects an ACK
markMark flag
virtual ~IAXFrameOut ( ) [inline, virtual]

Destructor


Member Function Documentation

bool ack ( ) const [inline]

Get the acknoledged flag of this frame

Returns:
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:
nextTransTimeNext transmission time
void setAck ( ) [inline]

Set the acknoledged flag of this frame

void setRetrans ( )

Set the retransmission flag of this frame

bool timeForRetrans ( u_int64_t  time) const [inline]

Ask the frame if it's time for retransmit

Parameters:
timeCurrent time
Returns:
True if it's time to retransmit
bool timeout ( ) const [inline]

Get the timeout (retransmission counter) of this frame

Returns:
True if the retransmission counter is 0
void transmitted ( )

Update the retransmission counter and the time to next retransmission


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