class H323Gatekeeper: public H225_RAS

This class embodies the H2250 RAS protocol to gatekeepers

Inheritance:


Public

[more] Construction
[more] Overrides from PObject
[more] Overrides from H225_RAS
[more] Protocol operations
[more] Member variable access


Inherited from H225_RAS:

Public Classes

oenum State
oenum State

Public Methods

ovoid SendReturnError(int returnError)
ovoid AddOpCode( unsigned opcode, H450xHandler * handler )
ovirtual void HandlePDU( const H323SignalPDU & pdu )
ovirtual void OnReceivedInvoke(X880_Invoke& invoke)
ovirtual void OnReceivedReturnResult(X880_ReturnResult& returnResult)
ovirtual void OnReceivedReturnError(X880_ReturnError& returnError)
ovirtual void OnReceivedReject(X880_Reject& reject)
ovoid SendReturnError(int invokeId, int returnError)
oint GetNextInvokeId() const
ovirtual void OnReceivedCallTransferIdentify( int linkedId )
ovirtual void OnReceivedCallTransferAbandon( int linkedId )
ovirtual void OnReceivedCallTransferInitiate( int linkedId, PASN_OctetString * argument )
ovirtual void OnReceivedCallTransferSetup( int linkedId, PASN_OctetString * argument )
ovirtual void OnReceivedCallTransferUpdate( int linkedId, PASN_OctetString * argument )
ovirtual void OnReceivedSubaddressTransfer( int linkedId, PASN_OctetString * argument )
ovirtual void OnReceivedCallTransferComplete( int linkedId, PASN_OctetString * argument )
ovirtual void OnReceivedCallTransferActive( int linkedId, PASN_OctetString * argument )
ovoid TransferCall( const PString & remoteParty )
oState GetState() const
ovirtual void OnReceivedLocalCallHold( int linkedId )
ovirtual void OnReceivedLocalCallRetrieve( int linkedId )
ovirtual void OnReceivedRemoteCallHold( int linkedId )
ovirtual void OnReceivedRemoteCallRetrieve( int linkedId )
ovoid HoldCall( BOOL localHold )
ovoid RetrieveCall( bool localHold )

Public

Operations

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 PObject

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

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

oH323TransportAddress* transportAddress
Reject reason if returns FALSE

oH225_ArrayOf_AliasAddress* aliasAddresses
Gatekeeper routed transport address.

oPBYTEArray* accessTokenData
DestinationInfo to use in SETUP if not empty

o
iNow Gatekeeper Access Token data

ovirtual BOOL GetAdmissionReqestAuthentication( const H225_AdmissionRequest & arq, PString & remoteId, PString & localId, PString & password )
Get separate authentication credentials for ARQ

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( const H323Connection * connection, unsigned seqNum )
Send an info response to the gatekeeper.
Parameters:
connection - Connection to send info about
seqNum - Sequence number responding to

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 H235Authenticators GetAuthenticators() const
Get the security context for this RAS connection

o Member variable access

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

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.

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

oBOOL GetSeparateAuthenticationInARQ() const
Get the flag to use the destination alias as remote ID and password in H235 authentication during ARQ

ovoid SetSeparateAuthenticationInARQ(BOOL b)
Set the flag to use the destination alias as remote ID and password in H235 authentication during ARQ


This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java



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