class H323GatekeeperCall

This class describes an active call on a gatekeeper

Inheritance:


Public Methods

[more] Construction
[more] Overrides from PObject
[more] Operations


Documentation

This class describes an active call on a gatekeeper
o Construction

o H323GatekeeperCall( H323GatekeeperServer & server, const OpalGloballyUniqueID & callIdentifier, Direction direction )
Create a new gatekeeper call tracking record.
Parameters:
server - Owner gatekeeper server
callIdentifier - Unique call identifier
direction - Direction of call

o ~H323GatekeeperCall()
Destroy the call, removing itself from the endpoint

o Overrides from PObject

oComparison Compare( const PObject & obj ) const
Compare two objects.
Parameters:
obj - Other object

ovoid PrintOn( ostream & strm ) const
Print the name of the gatekeeper.
Parameters:
strm - Stream to print to.

o Operations

ovirtual H323GatekeeperRequest::Response OnAdmission( H323GatekeeperARQ & request )
Handle an admission ARQ PDU. The default behaviour sets some internal variables from the ARQ data and then calls OnResolveAdmission, if necessary, and OnReplyAdmission every time.

ovirtual BOOL Disengage( int reason = -1 )
Shut down a call. This sendsa DRQ to the endpoint(s) to close the call down.

ovirtual H323GatekeeperRequest::Response OnDisengage( H323GatekeeperDRQ & request )
Handle a disengage DRQ PDU. The default behaviour simply returns TRUE.

ovirtual H323GatekeeperRequest::Response OnBandwidth( H323GatekeeperBRQ & request )
Handle a bandwidth BRQ PDU. The default behaviour adjusts the bandwidth used by the gatekeeper and adjusts the remote endpoint according to those limits.

ovirtual H323GatekeeperRequest::Response OnInfoResponse( H323GatekeeperIRR & request, H225_InfoRequestResponse_perCallInfo_subtype & call )
Handle an info request response IRR PDU. The default behaviour resets the heartbeat time monitoring the call.

ovirtual void OnAlerting()
Call back when an info response detects an Alerting

ovirtual void OnConnected()
Call back when an info response detects an Connected

ovirtual BOOL OnHeartbeat()
Function called to do heartbeat check of the call. Monitor the state of the call and make sure everything is OK.

A return value of FALSE indicates the call is to be closed for some reason.

Default behaviour checks the time since the last received IRR and if it has been too long does an IRQ to see if the call (and endpoint!) is still there and running. If the IRQ fails, FALSE is returned.

ovirtual PString GetCallCreditAmount() const
Get the current credit for this call. This function is only called if the client indicates that it can use the information provided.

The default behaviour calls the same function on the endpoint.

ovirtual BOOL GetCallCreditMode() const
Get the call credit billing mode for this endpoint. This function is only called if the client indicates that it can use the information provided.

The default behaviour calls the same function on the endpoint.

ovirtual unsigned GetDurationLimit() const
Get the duration limit for this call. This function is only called if the client indicates that it can use the information provided.

The default behaviour returns zero which indicates there is no duration limit applicable.

ovirtual BOOL SendCallCreditServiceControl()
Send the call credit service control PDU. This will send an SCI pdu to the endpoint with the control service session information for the current call credit, if enabled.

oBOOL AddCallCreditServiceControl( H225_ArrayOf_ServiceControlSession & serviceControl ) const
Add call credit and duration information to PDU

ovirtual BOOL SendServiceControlSession( const H323ServiceControlSession & session )
Send the service control session for the PDU. This will send an SCI pdu to the endpoint with the control service session information provided.

o Access functions


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



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