#include <channels.h>
Inheritance diagram for H323Channel:
Operations | |
| enum | Directions { IsBidirectional, IsTransmitter, IsReceiver, NumDirections } |
| virtual Directions | GetDirection () const=0 |
| virtual unsigned | GetSessionID () const |
| virtual BOOL | GetMediaTransportAddress (OpalTransportAddress &data, OpalTransportAddress &control) const |
| virtual BOOL | SetInitialBandwidth ()=0 |
| virtual BOOL | Open () |
| virtual BOOL | Start ()=0 |
| virtual void | Close () |
| BOOL | IsOpen () const |
| virtual OpalMediaStream * | GetMediaStream (BOOL deleted=FALSE) const=0 |
| virtual BOOL | OnSendingPDU (H245_OpenLogicalChannel &openPDU) const=0 |
| virtual void | OnSendOpenAck (const H245_OpenLogicalChannel &open, H245_OpenLogicalChannelAck &ack) const |
| virtual BOOL | OnReceivedPDU (const H245_OpenLogicalChannel &pdu, unsigned &errorCode) |
| virtual BOOL | OnReceivedAckPDU (const H245_OpenLogicalChannelAck &pdu) |
| virtual void | OnFlowControl (long bitRateRestriction) |
| virtual void | OnMiscellaneousCommand (const H245_MiscellaneousCommand_type &type) |
| virtual void | OnMiscellaneousIndication (const H245_MiscellaneousIndication_type &type) |
| virtual void | OnJitterIndication (DWORD jitter, int skippedFrameCount, int additionalBuffer) |
Public Member Functions | |
Overrides from PObject | |
| virtual void | PrintOn (ostream &strm) const |
Member variable access | |
| const H323ChannelNumber & | GetNumber () const |
| void | SetNumber (const H323ChannelNumber &num) |
| const H323ChannelNumber & | GetReverseChannel () const |
| void | SetReverseChannel (const H323ChannelNumber &num) |
| unsigned | GetBandwidthUsed () const |
| BOOL | SetBandwidthUsed (unsigned bandwidth) |
| const H323Capability & | GetCapability () const |
| BOOL | IsPaused () const |
| void | SetPause (BOOL pause) |
Protected Attributes | |
| H323EndPoint & | endpoint |
| H323Connection & | connection |
| H323Capability * | capability |
| H323ChannelNumber | number |
| H323ChannelNumber | reverseChannel |
| BOOL | opened |
| BOOL | paused |
| BOOL | terminating |
An application may create a descendent off this class and override functions as required for operating the channel protocol.
| H323Channel::H323Channel | ( | H323Connection & | connection, | |
| const H323Capability & | capability | |||
| ) |
Create a new channel.
| connection | Connection to endpoint for channel |
| capability | Capability channel is using |
| H323Channel::~H323Channel | ( | ) |
Destroy new channel. To avoid usage of deleted objects in background threads, this waits for the H323LogicalChannelThread to terminate before continuing.
| H323Channel::H323Channel | ( | H323Connection & | connection, | |
| const H323Capability & | capability | |||
| ) |
Create a new channel.
| connection | Connection to endpoint for channel |
| capability | Capability channel is using |
| H323Channel::~H323Channel | ( | ) |
Destroy new channel. To avoid usage of deleted objects in background threads, this waits for the H323LogicalChannelThread to terminate before continuing.
| virtual void H323Channel::PrintOn | ( | ostream & | strm | ) | const [virtual] |
| virtual Directions H323Channel::GetDirection | ( | ) | const [pure virtual] |
Indicate the direction of the channel. Return if the channel is bidirectional, or unidirectional, and which direction for the latter case.
Implemented in H323_H224Channel, H323UnidirectionalChannel, and H323BidirectionalChannel.
| virtual unsigned H323Channel::GetSessionID | ( | ) | const [virtual] |
Indicate the session number of the channel. Return session for channel. This is primarily for use by RTP based channels, for channels for which the concept of a session is not meaningfull, the default simply returns 0.
Reimplemented in H323_RTPChannel, H323_ExternalRTPChannel, and H323DataChannel.
| virtual BOOL H323Channel::GetMediaTransportAddress | ( | OpalTransportAddress & | data, | |
| OpalTransportAddress & | control | |||
| ) | const [virtual] |
Get the media transport address for the connection. This is primarily used to determine if media bypass is possible for the call between two connections.
The default behaviour returns FALSE.
| data | Data channel address |
| control | Control channel address |
Reimplemented in H323_ExternalRTPChannel.
| virtual BOOL H323Channel::SetInitialBandwidth | ( | ) | [pure virtual] |
Set the initial bandwidth for the channel. This calculates the initial bandwidth required by the channel and returns TRUE if the connection can support this bandwidth.
The default behaviour gets the bandwidth requirement from the codec object created by the channel.
Implemented in H323_H224Channel, and H323UnidirectionalChannel.
| virtual BOOL H323Channel::Open | ( | ) | [virtual] |
Open the channel. The default behaviour just calls connection.OnStartLogicalChannel() and if successful sets the opened member variable.
Reimplemented in H323_H224Channel, and H323UnidirectionalChannel.
| virtual BOOL H323Channel::Start | ( | ) | [pure virtual] |
This is called when the channel can start transferring data.
Implemented in H323_H224Channel, H323UnidirectionalChannel, H323BidirectionalChannel, and H323_ExternalRTPChannel.
| virtual void H323Channel::Close | ( | ) | [virtual] |
This is called to clean up any threads on connection termination.
Reimplemented in H323_H224Channel, H323UnidirectionalChannel, H323DataChannel, and H323_T38Channel.
| BOOL H323Channel::IsOpen | ( | ) | const [inline] |
Indicate if has been opened.
| virtual OpalMediaStream* H323Channel::GetMediaStream | ( | BOOL | deleted = FALSE |
) | const [pure virtual] |
Get the media stream associated with this logical channel.
If the argument is set to TRUE, the mediaStream is about to be deleted so all internal references to the mediaStream must be removed.
The default behaviour returns NULL.
Implemented in H323_H224Channel, and H323UnidirectionalChannel.
| virtual BOOL H323Channel::OnSendingPDU | ( | H245_OpenLogicalChannel & | openPDU | ) | const [pure virtual] |
Fill out the OpenLogicalChannel PDU for the particular channel type.
| openPDU | Open PDU to send. |
Implemented in H323_H224Channel, H323_RealTimeChannel, H323DataChannel, H323_T120Channel, and H323_T38Channel.
| virtual void H323Channel::OnSendOpenAck | ( | const H245_OpenLogicalChannel & | open, | |
| H245_OpenLogicalChannelAck & | ack | |||
| ) | const [virtual] |
This is called when request to create a channel is received from a remote machine and is about to be acknowledged.
The default behaviour does nothing.
| open | Open PDU |
| ack | Acknowledgement PDU |
Reimplemented in H323_H224Channel, H323_RealTimeChannel, H323DataChannel, and H323_T120Channel.
| virtual BOOL H323Channel::OnReceivedPDU | ( | const H245_OpenLogicalChannel & | pdu, | |
| unsigned & | errorCode | |||
| ) | [virtual] |
This is called after a request to create a channel occurs from the local machine via the H245LogicalChannelDict::Open() function, and the request has been acknowledged by the remote endpoint.
The default behaviour just returns TRUE.
| pdu | Open PDU |
| errorCode | Error code on failure |
Reimplemented in H323_H224Channel, H323_RealTimeChannel, H323DataChannel, H323_T120Channel, and H323_T38Channel.
| virtual BOOL H323Channel::OnReceivedAckPDU | ( | const H245_OpenLogicalChannelAck & | pdu | ) | [virtual] |
This is called after a request to create a channel occurs from the local machine via the H245LogicalChannelDict::Open() function, and the request has been acknowledged by the remote endpoint.
The default behaviour just returns TRUE.
| pdu | Acknowledgement PDU |
Reimplemented in H323_H224Channel, H323_RealTimeChannel, H323DataChannel, and H323_T120Channel.
| virtual void H323Channel::OnFlowControl | ( | long | bitRateRestriction | ) | [virtual] |
Limit bit flow for the logical channel. The default behaviour passes this on to the codec if not NULL.
| bitRateRestriction | Bit rate limitation |
| virtual void H323Channel::OnMiscellaneousCommand | ( | const H245_MiscellaneousCommand_type & | type | ) | [virtual] |
Process a miscellaneous command on the logical channel. The default behaviour passes this on to the codec if not NULL.
| type | Command to process |
Reimplemented in H323UnidirectionalChannel.
| virtual void H323Channel::OnMiscellaneousIndication | ( | const H245_MiscellaneousIndication_type & | type | ) | [virtual] |
Process a miscellaneous indication on the logical channel. The default behaviour passes this on to the codec if not NULL.
| type | Indication to process |
| virtual void H323Channel::OnJitterIndication | ( | DWORD | jitter, | |
| int | skippedFrameCount, | |||
| int | additionalBuffer | |||
| ) | [virtual] |
Limit bit flow for the logical channel. The default behaviour does nothing.
| jitter | Estimated received jitter in microseconds |
| skippedFrameCount | Frames skipped by decodec |
| additionalBuffer | Additional size of video decoder buffer |
| const H323ChannelNumber& H323Channel::GetNumber | ( | ) | const [inline] |
Get the number of the channel.
| void H323Channel::SetNumber | ( | const H323ChannelNumber & | num | ) | [inline] |
Set the number of the channel.
| const H323ChannelNumber& H323Channel::GetReverseChannel | ( | ) | const [inline] |
Get the number of the reverse channel (if present).
| void H323Channel::SetReverseChannel | ( | const H323ChannelNumber & | num | ) | [inline] |
Set the number of the reverse channel (if present).
| unsigned H323Channel::GetBandwidthUsed | ( | ) | const [inline] |
Get the bandwidth used by the channel in 100's of bits/sec.
| BOOL H323Channel::SetBandwidthUsed | ( | unsigned | bandwidth | ) |
Get the bandwidth used by the channel in 100's of bits/sec.
| bandwidth | New bandwidth |
| const H323Capability& H323Channel::GetCapability | ( | ) | const [inline] |
Get the capability that created this channel.
| BOOL H323Channel::IsPaused | ( | ) | const [inline] |
Get the "pause" flag. A paused channel is one that prevents the annunciation of the channels data. For example for audio this would mute the data, for video it would still frame.
Note that channel is not stopped, and may continue to actually receive data, it is just that nothing is done with it.
| void H323Channel::SetPause | ( | BOOL | pause | ) | [inline] |
Set the "pause" flag. A paused channel is one that prevents the annunciation of the channels data. For example for audio this would mute the data, for video it would still frame.
Note that channel is not stopped, and may continue to actually receive data, it is just that nothing is done with it.
| pause | New pause flag |
H323EndPoint& H323Channel::endpoint [protected] |
H323Connection& H323Channel::connection [protected] |
H323Capability* H323Channel::capability [protected] |
H323ChannelNumber H323Channel::number [protected] |
H323ChannelNumber H323Channel::reverseChannel [protected] |
BOOL H323Channel::opened [protected] |
BOOL H323Channel::paused [protected] |
BOOL H323Channel::terminating [protected] |
1.5.1