H323DataCapability Class Reference

#include <h323caps.h>

Inheritance diagram for H323DataCapability:

H323Capability H323_H224Capability H323_T120Capability H323_T38Capability H323NonStandardDataCapability H323_T38NonStandardCapability List of all members.

Public Member Functions

Identification functions
virtual MainTypes GetMainType () const
Operations
virtual unsigned GetDefaultSessionID () const
Protocol manipulation
virtual PBoolean OnSendingPDU (H245_Capability &pdu) const
virtual PBoolean OnSendingPDU (H245_DataType &pdu) const
virtual PBoolean OnSendingPDU (H245_ModeElement &pdu) const
virtual PBoolean OnSendingPDU (H245_DataApplicationCapability &pdu) const
virtual PBoolean OnSendingPDU (H245_DataApplicationCapability &pdu, CommandType type) const
virtual PBoolean OnSendingPDU (H245_DataMode &pdu) const=0
virtual PBoolean OnReceivedPDU (const H245_Capability &pdu)
virtual PBoolean OnReceivedPDU (const H245_DataType &pdu, PBoolean receiver)
virtual PBoolean OnReceivedPDU (const H245_DataApplicationCapability &pdu)
virtual PBoolean OnReceivedPDU (const H245_DataApplicationCapability &pdu, CommandType type)

Protected Attributes

unsigned maxBitRate

Detailed Description

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.


Constructor & Destructor Documentation

H323DataCapability::H323DataCapability ( unsigned  maxBitRate = 0  ) 

Create a new data capability.

Parameters:
maxBitRate  Maximum bit rate for data in 100's b/s

H323DataCapability::H323DataCapability ( unsigned  maxBitRate = 0  ) 

Create a new data capability.

Parameters:
maxBitRate  Maximum bit rate for data in 100's b/s


Member Function Documentation

virtual MainTypes H323DataCapability::GetMainType (  )  const [virtual]

Get the main type of the capability. Always returns e_Data.

Implements H323Capability.

virtual unsigned H323DataCapability::GetDefaultSessionID (  )  const [virtual]

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.

Reimplemented from H323Capability.

virtual PBoolean H323DataCapability::OnSendingPDU ( H245_Capability pdu  )  const [virtual]

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

Implements H323Capability.

virtual PBoolean H323DataCapability::OnSendingPDU ( H245_DataType pdu  )  const [virtual]

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

Reimplemented from H323Capability.

virtual PBoolean H323DataCapability::OnSendingPDU ( H245_ModeElement pdu  )  const [virtual]

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

Implements H323Capability.

virtual PBoolean H323DataCapability::OnSendingPDU ( H245_DataApplicationCapability pdu  )  const [virtual]

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

Reimplemented in H323_H224Capability, H323NonStandardDataCapability, H323_T120Capability, and H323_T38Capability.

virtual PBoolean H323DataCapability::OnSendingPDU ( H245_DataApplicationCapability pdu,
CommandType  type 
) const [virtual]

Parameters:
pdu  PDU to set information on
type  Type of PDU to send in

virtual PBoolean H323DataCapability::OnSendingPDU ( H245_DataMode pdu  )  const [pure virtual]

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

Implemented in H323_H224Capability, H323NonStandardDataCapability, H323_T120Capability, and H323_T38Capability.

virtual PBoolean H323DataCapability::OnReceivedPDU ( const H245_Capability pdu  )  [virtual]

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 PFalse then the received PDU codec description is not supported, so will be ignored. The default behaviour simply returns PTrue.

Parameters:
pdu  PDU to get information from

Reimplemented from H323Capability.

virtual PBoolean H323DataCapability::OnReceivedPDU ( const H245_DataType pdu,
PBoolean  receiver 
) [virtual]

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

Reimplemented from H323Capability.

virtual PBoolean H323DataCapability::OnReceivedPDU ( const H245_DataApplicationCapability pdu  )  [virtual]

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

Reimplemented in H323_H224Capability, H323NonStandardDataCapability, H323_T120Capability, and H323_T38Capability.

virtual PBoolean H323DataCapability::OnReceivedPDU ( const H245_DataApplicationCapability pdu,
CommandType  type 
) [virtual]

Parameters:
pdu  PDU to set information on
type  Type of PDU to send in


Member Data Documentation

unsigned H323DataCapability::maxBitRate [protected]


The documentation for this class was generated from the following file:
Generated on Mon Sep 15 11:49:32 2008 for OPAL by  doxygen 1.5.1