H323NonStandardDataCapability Class Reference

#include <h323caps.h>

Inheritance diagram for H323NonStandardDataCapability:

H323DataCapability H323NonStandardCapabilityInfo H323Capability H323_T38NonStandardCapability List of all members.

Public Member Functions

Construction
 H323NonStandardDataCapability (unsigned maxBitRate, const BYTE *dataBlock, PINDEX dataSize, PINDEX comparisonOffset=0, PINDEX comparisonLength=P_MAX_INDEX)
 H323NonStandardDataCapability (unsigned maxBitRate, const PString &oid, const BYTE *dataBlock, PINDEX dataSize, PINDEX comparisonOffset=0, PINDEX comparisonLength=P_MAX_INDEX)
 H323NonStandardDataCapability (unsigned maxBitRate, BYTE country, BYTE extension, WORD maufacturer, const BYTE *dataBlock, PINDEX dataSize, PINDEX comparisonOffset=0, PINDEX comparisonLength=P_MAX_INDEX)
Overrides from class PObject
Comparison Compare (const PObject &obj) const
Identification functions
virtual unsigned GetSubType () const
Protocol manipulation
virtual BOOL OnSendingPDU (H245_DataApplicationCapability &pdu) const
virtual BOOL OnSendingPDU (H245_DataMode &pdu) const
virtual BOOL OnReceivedPDU (const H245_DataApplicationCapability &pdu)
virtual BOOL IsMatch (const PASN_Choice &subTypePDU) const

Detailed Description

This class describes the interface to a non-standard data codec 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 the codec.

Definition at line 1731 of file h323caps.h.


Constructor & Destructor Documentation

H323NonStandardDataCapability::H323NonStandardDataCapability ( unsigned  maxBitRate,
const BYTE *  dataBlock,
PINDEX  dataSize,
PINDEX  comparisonOffset = 0,
PINDEX  comparisonLength = P_MAX_INDEX 
)

Create a new set of information about a non-standard codec.

Parameters:
maxBitRate  Maximum bit rate for data in 100's b/s
dataBlock  Non-Standard data for codec type
dataSize  Size of dataBlock. If 0 and dataBlock != NULL use strlen(dataBlock)
comparisonOffset  Offset into dataBlock to compare
comparisonLength  Length of bytes to compare

Definition at line 2229 of file h323caps.cxx.

H323NonStandardDataCapability::H323NonStandardDataCapability ( unsigned  maxBitRate,
const PString &  oid,
const BYTE *  dataBlock,
PINDEX  dataSize,
PINDEX  comparisonOffset = 0,
PINDEX  comparisonLength = P_MAX_INDEX 
)

Create a new set of information about a non-standard codec.

Parameters:
maxBitRate  Maximum bit rate for data in 100's b/s
oid  OID for indentification of codec
dataBlock  Non-Standard data for codec type
dataSize  Size of dataBlock. If 0 and dataBlock != NULL use strlen(dataBlock)
comparisonOffset  Offset into dataBlock to compare
comparisonLength  Length of bytes to compare

Definition at line 2240 of file h323caps.cxx.

H323NonStandardDataCapability::H323NonStandardDataCapability ( unsigned  maxBitRate,
BYTE  country,
BYTE  extension,
WORD  maufacturer,
const BYTE *  dataBlock,
PINDEX  dataSize,
PINDEX  comparisonOffset = 0,
PINDEX  comparisonLength = P_MAX_INDEX 
)

Create a new set of information about a non-standard codec.

Parameters:
maxBitRate  Maximum bit rate for data in 100's b/s
country  t35 information
extension  t35 information
maufacturer  t35 information
dataBlock  Non-Standard data for codec type
dataSize  Size of dataBlock. If 0 and dataBlock != NULL use strlen(dataBlock)
comparisonOffset  Offset into dataBlock to compare
comparisonLength  Length of bytes to compare

Definition at line 2252 of file h323caps.cxx.


Member Function Documentation

PObject::Comparison H323NonStandardDataCapability::Compare ( const PObject &  obj  )  const

Compare two capability instances. This compares the main and sub-types of the capability.

Reimplemented from H323Capability.

Definition at line 2266 of file h323caps.cxx.

References H323NonStandardCapabilityInfo::CompareInfo().

unsigned H323NonStandardDataCapability::GetSubType (  )  const [virtual]

Get the sub-type of the capability. This is a code dependent on the main type of the capability.

This returns one of the four possible combinations of mode and speed using the enum values of the protocol ASN H245_AudioCapability class.

Implements H323Capability.

Definition at line 2275 of file h323caps.cxx.

References H245_DataApplicationCapability_application::e_nonStandard.

BOOL H323NonStandardDataCapability::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 calls H323NonStandardCapabilityinfo::OnSendingPDU() to handle the PDU.

Parameters:
pdu  PDU to set information on

Reimplemented from H323DataCapability.

Definition at line 2281 of file h323caps.cxx.

References H245_DataApplicationCapability_application::e_nonStandard, H245_DataApplicationCapability::m_application, and H323NonStandardCapabilityInfo::OnSendingNonStandardPDU().

BOOL H323NonStandardDataCapability::OnSendingPDU ( H245_DataMode 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 H323NonStandardCapabilityinfo::OnSendingPDU() to handle the PDU.

Parameters:
pdu  PDU to set information on

Implements H323DataCapability.

Definition at line 2287 of file h323caps.cxx.

References H245_DataMode_application::e_nonStandard, H245_DataMode::m_application, and H323NonStandardCapabilityInfo::OnSendingNonStandardPDU().

BOOL H323NonStandardDataCapability::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 calls H323NonStandardCapabilityinfo::OnReceivedPDU() to handle the provided PDU.

Parameters:
pdu  PDU to set information on

Reimplemented from H323DataCapability.

Definition at line 2293 of file h323caps.cxx.

References H245_DataApplicationCapability_application::e_nonStandard, H245_DataApplicationCapability::m_application, and H323NonStandardCapabilityInfo::OnReceivedNonStandardPDU().

BOOL H323NonStandardDataCapability::IsMatch ( const PASN_Choice &  subTypePDU  )  const [virtual]

Compare the nonStandardData part of the capability, if applicable.

Parameters:
subTypePDU  sub-type PDU of H323Capability

Reimplemented from H323Capability.

Definition at line 2299 of file h323caps.cxx.

References H323NonStandardCapabilityInfo::IsMatch(), and H323Capability::IsMatch().


The documentation for this class was generated from the following files:
Generated on Thu Oct 25 13:45:29 2007 for h323plus by  doxygen 1.5.2