# H323GatekeeperListener Class Reference

`#include <gkserver.h>`

Inheritance diagram for H323GatekeeperListener:

[legend]
Collaboration diagram for H323GatekeeperListener:
[legend]

## Public Member Functions

Construction
| H323GatekeeperListener (H323EndPoint &endpoint, H323GatekeeperServer &server, const PString &gatekeeperIdentifier, H323Transport *transport=NULL)
| ~H323GatekeeperListener ()
Operations
PBoolean | UnregistrationRequest (const H323RegisteredEndPoint &ep, unsigned reason)
PBoolean | DisengageRequest (const H323GatekeeperCall &call, unsigned reason)
virtual PBoolean | InfoRequest (H323RegisteredEndPoint &ep, H323GatekeeperCall *call=NULL)
virtual PBoolean | ServiceControlIndication (H323RegisteredEndPoint &ep, const H323ServiceControlSession &session, H323GatekeeperCall *call=NULL)
Operation callbacks
virtual H323GatekeeperRequest::Response | OnDiscovery (H323GatekeeperGRQ &request)
virtual H323GatekeeperRequest::Response | OnRegistration (H323GatekeeperRRQ &request)
virtual H323GatekeeperRequest::Response | OnUnregistration (H323GatekeeperURQ &request)
virtual H323GatekeeperRequest::Response | OnAdmission (H323GatekeeperARQ &request)
virtual H323GatekeeperRequest::Response | OnDisengage (H323GatekeeperDRQ &request)
virtual H323GatekeeperRequest::Response | OnBandwidth (H323GatekeeperBRQ &request)
virtual H323GatekeeperRequest::Response | OnLocation (H323GatekeeperLRQ &request)
virtual H323GatekeeperRequest::Response | OnInfoResponse (H323GatekeeperIRR &request)
Low level protocol callbacks
virtual PBoolean | OnReceiveGatekeeperRequest (const H323RasPDU &, const H225_GatekeeperRequest &)
virtual PBoolean | OnReceiveRegistrationRequest (const H323RasPDU &, const H225_RegistrationRequest &)
virtual PBoolean | OnReceiveUnregistrationRequest (const H323RasPDU &, const H225_UnregistrationRequest &)
virtual PBoolean | OnReceiveUnregistrationConfirm (const H225_UnregistrationConfirm &)
virtual PBoolean | OnReceiveUnregistrationReject (const H225_UnregistrationReject &)
virtual PBoolean | OnReceiveAdmissionRequest (const H323RasPDU &, const H225_AdmissionRequest &)
virtual PBoolean | OnReceiveBandwidthRequest (const H323RasPDU &, const H225_BandwidthRequest &)
virtual PBoolean | OnReceiveBandwidthConfirm (const H225_BandwidthConfirm &)
virtual PBoolean | OnReceiveBandwidthReject (const H225_BandwidthReject &)
virtual PBoolean | OnReceiveDisengageRequest (const H323RasPDU &, const H225_DisengageRequest &)
virtual PBoolean | OnReceiveDisengageConfirm (const H225_DisengageConfirm &)
virtual PBoolean | OnReceiveDisengageReject (const H225_DisengageReject &)
virtual PBoolean | OnReceiveLocationRequest (const H323RasPDU &, const H225_LocationRequest &)
virtual PBoolean | OnReceiveInfoRequestResponse (const H323RasPDU &, const H225_InfoRequestResponse &)
virtual PBoolean | OnReceiveResourcesAvailableConfirm (const H225_ResourcesAvailableConfirm &)
virtual PBoolean | OnSendFeatureSet (unsigned, H225_FeatureSet &features) const
virtual void | OnReceiveFeatureSet (unsigned, const H225_FeatureSet &features) const
Member access
H323GatekeeperServer & | GetGatekeeper () const

## Protected Attributes

H323GatekeeperServer & | gatekeeper

## Detailed Description

This class embodies the low level H.225.0 RAS protocol on gatekeepers. One or more instances of this class may be used to access a single H323GatekeeperServer instance. Thus specific interfaces could be set up to receive UDP packets, all operating as the same gatekeeper.

## Constructor & Destructor Documentation

H323GatekeeperListener::H323GatekeeperListener | ( | H323EndPoint & | endpoint,
|  | H323GatekeeperServer & | server,
|  | const PString & | gatekeeperIdentifier,
|  | H323Transport * | transport = `NULL` |
| ) |  |  |

Create a new gatekeeper listener.

Parameters:

  endpoint | Local endpoint
  server | Database for gatekeeper
  gatekeeperIdentifier | Name of this gatekeeper
  transport | Transport over which gatekeepers communicates.

H323GatekeeperListener::~H323GatekeeperListener | ( |  | ) |

Destroy gatekeeper listener.

## Member Function Documentation

PBoolean H323GatekeeperListener::DisengageRequest | ( | const H323GatekeeperCall & | call,
|  | unsigned | reason |
| ) |  |  |

Send a DisengageRequest (DRQ) to endpoint.

H323GatekeeperServer& H323GatekeeperListener::GetGatekeeper | ( |  | ) | const`[inline]`

virtual PBoolean H323GatekeeperListener::InfoRequest | ( | H323RegisteredEndPoint & | ep,
|  | H323GatekeeperCall * | call = `NULL` |
| ) |  |  | `[virtual]`

Send an InfoRequest (IRQ) to endpoint.

virtual H323GatekeeperRequest::Response H323GatekeeperListener::OnAdmission | ( | H323GatekeeperARQ & | request | ) | `[virtual]`

Handle an admission ARQ PDU. The default behaviour does some checks and calls the gatekeeper server instances function of the same name.

virtual H323GatekeeperRequest::Response H323GatekeeperListener::OnBandwidth | ( | H323GatekeeperBRQ & | request | ) | `[virtual]`

Handle a bandwidth BRQ PDU. The default behaviour does some checks and calls the gatekeeper server instances function of the same name.

virtual H323GatekeeperRequest::Response H323GatekeeperListener::OnDiscovery | ( | H323GatekeeperGRQ & | request | ) | `[virtual]`

Handle a discovery GRQ PDU. The default behaviour does some checks and calls the gatekeeper server instances function of the same name.

virtual H323GatekeeperRequest::Response H323GatekeeperListener::OnDisengage | ( | H323GatekeeperDRQ & | request | ) | `[virtual]`

Handle a disengage DRQ PDU. The default behaviour does some checks and calls the gatekeeper server instances function of the same name.

virtual H323GatekeeperRequest::Response H323GatekeeperListener::OnInfoResponse | ( | H323GatekeeperIRR & | request | ) | `[virtual]`

Handle an info request response IRR PDU. The default behaviour does some checks and calls the gatekeeper server instances function of the same name.

virtual H323GatekeeperRequest::Response H323GatekeeperListener::OnLocation | ( | H323GatekeeperLRQ & | request | ) | `[virtual]`

Handle a location LRQ PDU. The default behaviour does some checks and calls the gatekeeper server instances function of the same name.

virtual PBoolean H323GatekeeperListener::OnReceiveAdmissionRequest | ( | const H323RasPDU & | ,
|  | const H225_AdmissionRequest & |  |
| ) |  |  | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveBandwidthConfirm | ( | const H225_BandwidthConfirm & |  | ) | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveBandwidthReject | ( | const H225_BandwidthReject & |  | ) | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveBandwidthRequest | ( | const H323RasPDU & | ,
|  | const H225_BandwidthRequest & |  |
| ) |  |  | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveDisengageConfirm | ( | const H225_DisengageConfirm & |  | ) | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveDisengageReject | ( | const H225_DisengageReject & |  | ) | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveDisengageRequest | ( | const H323RasPDU & | ,
|  | const H225_DisengageRequest & |  |
| ) |  |  | `[virtual]`

Reimplemented from H225_RAS.

virtual void H323GatekeeperListener::OnReceiveFeatureSet | ( | unsigned | ,
|  | const H225_FeatureSet & | features |
| ) |  |  | const`[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveGatekeeperRequest | ( | const H323RasPDU & | ,
|  | const H225_GatekeeperRequest & |  |
| ) |  |  | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveInfoRequestResponse | ( | const H323RasPDU & | ,
|  | const H225_InfoRequestResponse & |  |
| ) |  |  | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveLocationRequest | ( | const H323RasPDU & | ,
|  | const H225_LocationRequest & |  |
| ) |  |  | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveRegistrationRequest | ( | const H323RasPDU & | ,
|  | const H225_RegistrationRequest & |  |
| ) |  |  | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveResourcesAvailableConfirm | ( | const H225_ResourcesAvailableConfirm & |  | ) | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveUnregistrationConfirm | ( | const H225_UnregistrationConfirm & |  | ) | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveUnregistrationReject | ( | const H225_UnregistrationReject & |  | ) | `[virtual]`

Reimplemented from H225_RAS.

virtual PBoolean H323GatekeeperListener::OnReceiveUnregistrationRequest | ( | const H323RasPDU & | ,
|  | const H225_UnregistrationRequest & |  |
| ) |  |  | `[virtual]`

Reimplemented from H225_RAS.

virtual H323GatekeeperRequest::Response H323GatekeeperListener::OnRegistration | ( | H323GatekeeperRRQ & | request | ) | `[virtual]`

Handle a registration RRQ PDU. The default behaviour does some checks and calls the gatekeeper server instances function of the same name.

virtual PBoolean H323GatekeeperListener::OnSendFeatureSet | ( | unsigned | ,
|  | H225_FeatureSet & | features |
| ) |  |  | const`[virtual]`

Reimplemented from H225_RAS.

virtual H323GatekeeperRequest::Response H323GatekeeperListener::OnUnregistration | ( | H323GatekeeperURQ & | request | ) | `[virtual]`

Handle an unregistration URQ PDU. The default behaviour does some checks and calls the gatekeeper server instances function of the same name.

virtual PBoolean H323GatekeeperListener::ServiceControlIndication | ( | H323RegisteredEndPoint & | ep,
|  | const H323ServiceControlSession & | session,
|  | H323GatekeeperCall * | call = `NULL` |
| ) |  |  | `[virtual]`

Send an ServiceControlIndication (SCI) to endpoint.

PBoolean H323GatekeeperListener::UnregistrationRequest | ( | const H323RegisteredEndPoint & | ep,
|  | unsigned | reason |
| ) |  |  |

Send a UnregistrationRequest (URQ) to endpoint.

## Field Documentation

H323GatekeeperServer& H323GatekeeperListener::gatekeeper `[protected]`

The documentation for this class was generated from the following file:

- gkserver.h