class H323Gatekeeper

This class embodies the H2250 RAS protocol to gatekeepers

Inheritance:


Public Methods

[more] Construction
[more] Protocol operations
[more] Member variable access


Inherited from H225_RAS:

Public Methods

Overrides from PObject

Overrides from H323Transactor

Protocol callbacks


Documentation

This class embodies the H2250 RAS protocol to gatekeepers
o Construction

o H323Gatekeeper( H323EndPoint & endpoint, H323Transport* transport )
Create a new gatekeeper.
Parameters:
endpoint - Endpoint gatekeeper is associated with.
transport - Transport over which gatekeepers communicates.

o ~H323Gatekeeper()
Destroy gatekeeper

o Overrides from H225_RAS

o Protocol operations

oBOOL DiscoverAny()
Discover a gatekeeper on the local network

oBOOL DiscoverByName( const PString & identifier )
Discover a gatekeeper on the local network. If the identifier string is empty then the first gatekeeper to respond to a broadcast is used.
Parameters:
identifier - Gatekeeper identifier to find

oBOOL DiscoverByAddress( const H323TransportAddress & address )
Discover a gatekeeper on the local network. If the address string is empty then the first gatekeeper to respond to a broadcast is used.
Parameters:
address - Address of gatekeeper.

oBOOL DiscoverByNameAndAddress( const PString & identifier, const H323TransportAddress & address )
Discover a gatekeeper on the local network. Combination of DiscoverByName() and DiscoverByAddress().

oBOOL RegistrationRequest( BOOL autoReregister = TRUE )
Register with gatekeeper.
Parameters:
autoReregister - Automatic register on unregister

oBOOL UnregistrationRequest( int reason )
Unregister with gatekeeper.
Parameters:
reason - Reason for unregistration

oBOOL LocationRequest( const PString & alias, H323TransportAddress & address )
Location request to gatekeeper.
Parameters:
alias - Alias name we wish to find.
address - Resultant transport address.

oBOOL LocationRequest( const PStringList & aliases, H323TransportAddress & address )
Location request to gatekeeper.
Parameters:
aliases - Alias names we wish to find.
address - Resultant transport address.

oBOOL AdmissionRequest( H323Connection & connection, AdmissionResponse & response, BOOL ignorePreGrantedARQ = FALSE )
Admission request to gatekeeper.
Parameters:
connection - Connection we wish to change.
response - Response parameters to ARQ
ignorePreGrantedARQ - Flag to force ARQ to be sent

oBOOL DisengageRequest( const H323Connection & connection, unsigned reason )
Disengage request to gatekeeper.
Parameters:
connection - Connection we wish admitted.
reason - Reason code for disengage

oBOOL BandwidthRequest( H323Connection & connection, unsigned requestedBandwidth )
Bandwidth request to gatekeeper.
Parameters:
connection - Connection we wish to change.
requestedBandwidth - New bandwidth wanted in 0.1kbps

ovoid InfoRequestResponse()
Send an unsolicited info response to the gatekeeper

ovoid InfoRequestResponse( const H323Connection & connection )
Send an unsolicited info response to the gatekeeper.
Parameters:
connection - Connection to send info about

ovoid InfoRequestResponse( const H323Connection & connection, const H225_H323_UU_PDU & pdu, BOOL sent )
Send an unsolicited info response to the gatekeeper.
Parameters:
connection - Connection to send info about
pdu - PDU that was sent or received
sent - Flag for PDU was sent or received

ovirtual void OnServiceControlSessions( const H225_ArrayOf_ServiceControlSession & serviceControl, H323Connection* connection )
Handle incoming service control session information

o Member variable access

oBOOL IsDiscoveryComplete() const
Determine if the endpoint has discovered the gatekeeper

oBOOL IsRegistered() const
Determine if the endpoint is registered with the gatekeeper

oRegistrationFailReasons GetRegistrationFailReason() const
Get the registration fail reason

oPString GetName() const
Get the gatekeeper name. The gets the name of the gatekeeper. It will be of the form id@address where id is the gatekeeperIdentifier and address is the transport address used. If the gatekeeperIdentifier is empty the '@' is not included and only the transport is shown. The transport is minimised also, with the type removed if IP is used and the :port removed if the default port is used.

oconst PString& GetEndpointIdentifier() const
Get the endpoint identifier

ovoid SetPassword( const PString & password, const PString & username = PString() )
Set the H235 password in the gatekeeper. If no username is present then it will default to the endpoint local user name (ie first alias).
Parameters:
password - New password
username - Username for password


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



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