class H323DataCapability

This class describes the interface to a data channel used to transfer data via the logical channels opened and managed by the H323 control channel.

Inheritance:


Public Methods

[more] Construction
[more] Identification functions
[more] Operations
[more] Protocol manipulation


Inherited from H323Capability:

Public Methods

Overrides from class PObject

Member variable access

Protected Fields

oCapabilityDirection capabilityDirection


Documentation

This class describes the interface to a data channel used to transfer data via the logical channels opened and managed by the H323 control channel.

An application may create a descendent off this class and override functions as required for descibing a codec.

o Construction

o H323DataCapability( unsigned maxBitRate = 0 )
Create a new data capability.
Parameters:
maxBitRate - Maximum bit rate for data in 100's b/s

o Identification functions

ovirtual MainTypes GetMainType() const
Get the main type of the capability. Always returns e_Data.

o Operations

ovirtual unsigned GetDefaultSessionID() const
Get the default RTP session. This function gets the default RTP session ID for the capability type. For example audio capabilities return the value RTP_Session::DefaultAudioSessionID etc.

The default behaviour returns 3, indicating a data session.

ovirtual H323Codec* CreateCodec( H323Codec::Direction direction ) const
Create the codec instance, allocating resources as required. As a data channel has no codec, this always returns NULL.
Parameters:
direction - Direction in which this instance runs

o Protocol manipulation

ovirtual BOOL OnSendingPDU( H245_Capability & pdu ) const
This function is called whenever and outgoing TerminalCapabilitySet PDU is being constructed for the control channel. It allows the capability to set the PDU fields from information in members specific to the class.

The default behaviour calls the OnSendingPDU() function with a more specific PDU type.

Parameters:
pdu - PDU to set information on

ovirtual BOOL OnSendingPDU( H245_DataType & pdu ) const
This function is called whenever and outgoing OpenLogicalChannel PDU is being constructed for the control channel. It allows the capability to set the PDU fields from information in members specific to the class.

The default behaviour calls the OnSendingPDU() function with a more specific PDU type.

Parameters:
pdu - PDU to set information on

ovirtual BOOL OnSendingPDU( H245_ModeElement & pdu ) const
This function is called whenever and outgoing RequestMode PDU is being constructed for the control channel. It allows the capability to set the PDU fields from information in members specific to the class.

The default behaviour calls the OnSendingPDU() function with a more specific PDU type.

Parameters:
pdu - PDU to set information on

ovirtual BOOL OnSendingPDU( H245_DataApplicationCapability & pdu ) const = 0
This function is called whenever and outgoing TerminalCapabilitySet or OpenLogicalChannel PDU is being constructed for the control channel. It allows the capability to set the PDU fields from information in members specific to the class.

The default behaviour is pure.

Parameters:
pdu - PDU to set information on

ovirtual BOOL OnSendingPDU( H245_DataMode & pdu ) const = 0
This function is called whenever and outgoing RequestMode PDU is being constructed for the control channel. It allows the capability to set the PDU fields from information in members specific to the class.

The default behaviour sets the PDUs tag according to the GetSubType() function (translated to different enum).

Parameters:
pdu - PDU to set information on

ovirtual BOOL OnReceivedPDU( const H245_Capability & pdu )
This function is called whenever and incoming TerminalCapabilitySet PDU is received on the control channel, and a new H323Capability descendent was created. This completes reading fields from the PDU into the classes members.

If the function returns FALSE then the received PDU codec description is not supported, so will be ignored. The default behaviour simply returns TRUE.

Parameters:
pdu - PDU to get information from

ovirtual BOOL OnReceivedPDU( const H245_DataType & pdu, BOOL receiver )
This function is called whenever and incoming OpenLogicalChannel PDU has been used to construct the control channel. It allows the capability to set from the PDU fields, information in members specific to the class.

The default behaviour is pure.

Parameters:
pdu - PDU to get information from
receiver - Is receiver OLC

ovirtual BOOL OnReceivedPDU( const H245_DataApplicationCapability & pdu ) = 0
This function is called whenever and incoming TerminalCapabilitySet or OpenLogicalChannel PDU has been used to construct the control channel. It allows the capability to set from the PDU fields, information in members specific to the class.

The default behaviour is pure.

Parameters:
pdu - PDU to set information on


Direct child classes:
H323_T38Capability
H323_T120Capability
H323NonStandardDataCapability

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.