class H323_UserInputCapability

This class describes the UserInput psuedo-channel

Inheritance:


Public Methods

[more] Construction
[more] Overrides from class PObject
[more] Identification functions
[more] Operations
[more] Protocol manipulation


Inherited from H323Capability:

Public Methods

Member variable access

Protected Fields

oCapabilityDirection capabilityDirection


Documentation

This class describes the UserInput psuedo-channel
o Construction

o H323_UserInputCapability( SubTypes subType )
Create the capability for User Input. The subType parameter is a value from the enum H245_UserInputCapability::Choices.

o Overrides from class PObject

ovirtual PObject* Clone() const
Create a copy of the object

o Identification functions

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

This function is overridden by one of the three main sub-classes off which real capabilities would be descendend.

ovirtual unsigned GetSubType() const
Get the sub-type of the capability. This is a code dependent on the main type of the capability.

ovirtual PString GetFormatName() const
Get the name of the media data format this class represents

o Operations

ovirtual H323Channel* CreateChannel( H323Connection & connection, H323Channel::Directions dir, unsigned sessionID, const H245_H2250LogicalChannelParameters* param ) const
Create the channel instance, allocating resources as required. This creates a logical channel object appropriate for the parameters provided. Not if param is NULL, sessionID must be provided, otherwise this is taken from the fields in param.
Parameters:
connection - Owner connection for channel
dir - Direction of channel
sessionID - Session ID for RTP channel
param - Parameters for channel

ovirtual H323Codec* CreateCodec( H323Codec::Direction direction ) const
Create the codec instance, allocating resources as required.
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 is pure.

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 is pure.

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 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 IsUsable( const H323Connection & connection ) const
Validate that the capability is usable given the connection. This checks agains the negotiated protocol version number and remote application to determine if this capability should be used in TCS or OLC pdus.

The default behaviour will check for early versions and return FALSE for RFC2833 mode.


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



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