class UDPTLSession

UDPTL session. More...

Contains pure virtuals
Full nameTelEngine::UDPTLSession
Definition#include <libs/yrtp/yatertp.h>
InheritsTelEngine::Mutex [public ], TelEngine::UDPSession [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

A bidirectional UDPTL session usable for T.38

 ~UDPTLSession ()

~UDPTLSession

Destructor

inline bool  localAddr (SocketAddr& addr)

localAddr

Set the local network address of the RTP transport of this session

Parameters:
addrNew local RTP transport address

Returns: True if address set, false if a failure occured

inline u_int16_t  maxLen ()

maxLen

[const]

Get the maximum UDPTL packet length

Returns: Maximum length of UDPTL packet length in bytes

inline u_int8_t  maxSec ()

maxSec

[const]

Get the maximum number of UDPTL secondary IFPs

Returns: Maximum number of secondary IFPs, zero if disabled

void  rtpData (const void* data, int len)

rtpData

[virtual]

This method is called to send or process an UDPTL packet

Parameters:
dataPointer to raw UDPTL data
lenLength of the data packet

Reimplemented from RTPProcessor.

bool  udptlSend (const void* data, int len, u_int16_t seq)

udptlSend

Send UDPTL data over the transport, add older blocks for error recovery

Parameters:
dataPointer to IFP block to send as primary
lenLength of primary IFP block
seqSequence number to incorporate in message

Returns: True if data block was sent, false if an error occured

 UDPTLSession (u_int16_t maxLen = 250, u_int8_t maxSec = 2)

UDPTLSession

[protected]

UDPTL Session constructor

Parameters:
maxLenMaximum length of UDPTL packet, at least longest primary IFP + 5 bytes
maxSecMaximum number of secondary IFPs, set to zero to disable

void  timerTick (const Time& when)

timerTick

[protected virtual]

Method called periodically to push any asynchronous data or statistics

Parameters:
whenTime to use as base in all computing

Reimplemented from RTPProcessor.

RTPTransport*  createTransport ()

createTransport

[protected virtual]

Create a new UDPTL transport for this session. Override this method to create objects derived from RTPTransport.

Returns: Pointer to the new transport or NULL on failure

Reimplemented from UDPSession.

void  udptlRecv (const void* data, int len, u_int16_t seq, bool recovered)

udptlRecv

[protected pure virtual]

Method called when UDPTL data is received

Parameters:
dataPointer to IFP block
lenLength of the IFP block
seqSequence number of the block
recoveredTrue if the IFP block was recovered after data loss


Generated by: paulc on bussard on Tue Apr 12 17:15:21 2011, using kdoc 2.0a54.