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 retransIntervalMs, bool ackOnly, bool mark = false)

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
retransIntervalMsTime interval to the next retransmission
ackOnlyAcknoledge only flag. If true, the frame only expects an ACK
markMark flag

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, IAXIEList* ieList, u_int16_t maxlen, u_int16_t retransCount, u_int32_t retransIntervalMs, bool ackOnly, bool mark = false)

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
ieListList of frame IEs
maxlenMax frame data length
retransCountRetransmission counter
retransIntervalMsTime interval to the next retransmission
ackOnlyAcknoledge only flag. If true, the frame only expects an ACK
markMark flag

 ~IAXFrameOut ()

~IAXFrameOut

[virtual]

Destructor

inline unsigned int  retransCount ()

retransCount

[const]

Get the retransmission counter of this frame

Returns: 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

inline void  setRetrans ()

setRetrans

Set the retransmission flag of this frame

inline 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

inline bool  canSetTimeout ()

canSetTimeout

Check if absolute timeout can be set

Returns: True if absolute timeout can be set

inline void  setTimeout (u_int64_t tout)

setTimeout

Set absolute timeout. Reset retransmission counter

Parameters:
toutTimeout time


Generated by: paulc on bussard on Mon Feb 10 13:15:47 2014, using kdoc 2.0a54.