ooGkClient.h Go to the documentation of this file. /* * Copyright (C) 2009 by Page Iberica, S.A. * Copyright (C) 2009 by Objective Systems, Inc. * * This software is furnished under an open source license and may be * used and copied only in accordance with the terms of this license. * The text of the license may generally be found in the root * directory of this installation in the COPYING file. It * can also be viewed online at the following URL: * * http://www.obj-sys.com/open/license.html * * Any redistributions of this file including modified versions must * maintain this copyright notice. * *****************************************************************************/ #ifndef _OOGKCLIENT_H_ #define _OOGKCLIENT_H_ #include "ooasn1.h" #include "ootypes.h" #include "H323-MESSAGES.h" #ifdef __cplusplus extern "C" { #endif #ifndef EXTERN #ifdef MAKE_DLL #define EXTERN __declspec(dllexport) #else #define EXTERN #endif /* _WIN32 */ #endif /* EXTERN */ /*-------------------------------------------------------------------*/ /* Public definitions */ /*-------------------------------------------------------------------*/ #define MAX_IP_LEN 15 #define DEFAULT_GKPORT 1719 #define MULTICAST_GKADDRESS "224.0.1.41" #define MULTICAST_GKPORT 1718 #define DEFAULT_BW_REQUEST 100000 /* Various timeouts in seconds */ #define DEFAULT_REG_TTL 300 #define DEFAULT_TTL_OFFSET 20 #define DEFAULT_ARQ_TIMEOUT 5 #define DEFAULT_DRQ_TIMEOUT 5 #define DEFAULT_GRQ_TIMEOUT 15 #define DEFAULT_RRQ_TIMEOUT 10 /* Number of retries before giving up */ #define OO_MAX_GRQ_RETRIES 3 #define OO_MAX_RRQ_RETRIES 3 #define OO_MAX_ARQ_RETRIES 3 /* Gk Client timers */ #define OO_GRQ_TIMER (1<<0) #define OO_RRQ_TIMER (1<<1) #define OO_REG_TIMER (1<<2) #define OO_ARQ_TIMER (1<<3) #define OO_DRQ_TIMER (1<<4) struct OOH323CallData; struct ooGkClient; struct RasCallAdmissionInfo; typedef struct ooGkClientTimerCb{ int timerType; struct ooGkClient *pGkClient; struct RasCallAdmissionInfo *pAdmInfo; }ooGkClientTimerCb; enum RasGatekeeperMode { RasNoGatekeeper = 0, RasDiscoverGatekeeper = 1, RasUseSpecificGatekeeper = 2, }; enum RasCallType{ RasPointToPoint =0, RasOneToN, RasnToOne, RasnToN, }; enum OOGkClientState { GkClientIdle = 0, GkClientDiscovered, /* Gk Discovery is complete */ GkClientRegistered, /* registered with gk */ GkClientUnregistered, GkClientGkErr,/*Gk is not responding, in discover mode can look for new GK*/ GkClientFailed }; typedef struct RasGatekeeperInfo { ASN1BOOL willRespondToIRR; H225UUIEsRequested uuiesRequested; H225BandWidth bw; H225RegistrationConfirm_preGrantedARQ preGrantedARQ; }RasGatekeeperInfo; typedef struct RasCallAdmissionInfo { struct OOH323CallData *call; unsigned int retries; unsigned short requestSeqNum; ASN1USINT irrFrequency; } RasCallAdmissionInfo; struct OOAliases; typedef int (*cb_OnReceivedRegistrationConfirm) (H225RegistrationConfirm *rcf, struct OOAliases *aliases); typedef int (*cb_OnReceivedUnregistrationConfirm) (H225UnregistrationConfirm *ucf, struct OOAliases *aliases); typedef int (*cb_OnReceivedUnregistrationRequest) (H225UnregistrationRequest *urq, struct OOAliases *aliases); typedef struct OOGKCLIENTCALLBACKS{ cb_OnReceivedRegistrationConfirm onReceivedRegistrationConfirm; cb_OnReceivedUnregistrationConfirm onReceivedUnregistrationConfirm; cb_OnReceivedUnregistrationRequest onReceivedUnregistrationRequest; }OOGKCLIENTCALLBACKS; typedef struct ooGkClient{ ASN1BOOL discoveryComplete; OOCTXT ctxt; OOCTXT msgCtxt; OOSOCKET rasSocket; int localRASPort; char localRASIP[20]; char gkRasIP[20]; char gkCallSignallingIP[20]; RasGatekeeperInfo gkInfo; int gkRasPort; int gkCallSignallingPort; unsigned short requestSeqNum; enum RasGatekeeperMode gkMode; /* Current Gk mode */ struct timeval registrationTime; H225GatekeeperIdentifier gkId; H225EndpointIdentifier endpointId; DList callsPendingList; DList callsAdmittedList; DList timerList; OOGKCLIENTCALLBACKS callbacks; ASN1UINT grqRetries; ASN1UINT rrqRetries; ASN1UINT grqTimeout; ASN1UINT rrqTimeout; ASN1UINT regTimeout; ASN1UINT arqTimeout; ASN1UINT drqTimeout; enum OOGkClientState state; } ooGkClient; struct OOAliases; struct OOH323CallData; EXTERN int ooGkClientInit (enum RasGatekeeperMode eGkMode, char *szGkAddr, int iGkPort ); EXTERN void ooGkClientPrintConfig(ooGkClient *pGkClient); EXTERN int ooGkClientDestroy(void); EXTERN int ooGkClientStart(ooGkClient *pGkClient); EXTERN int ooGkClientSetGkMode(ooGkClient *pGkClient, enum RasGatekeeperMode eGkMode, char *szGkAddr, int iGkPort ); EXTERN int ooGkClientCreateChannel(ooGkClient *pGkClient); EXTERN int ooGkClientCloseChannel(ooGkClient *pGkClient); EXTERN void ooGkClientRasFillVendor (ooGkClient *pGkClient, H225VendorIdentifier *psVendor); EXTERN int ooGkClientReceive(ooGkClient *pGkClient); EXTERN int ooGkClientHandleRASMessage (ooGkClient *pGkClient, H225RasMessage *pRasMsg); EXTERN int ooGkClientSendMsg(ooGkClient *pGkClient, H225RasMessage *pRasMsg); EXTERN int ooGkClientSendGRQ(ooGkClient *pGkClient); EXTERN int ooGkClientHandleGatekeeperReject (ooGkClient *pGkClient, H225GatekeeperReject *pGatekeeperReject); EXTERN int ooGkClientHandleGatekeeperConfirm (ooGkClient *pGkClient, H225GatekeeperConfirm *pGatekeeperConfirm); EXTERN int ooGkClientSendRRQ(ooGkClient *pGkClient, ASN1BOOL keepAlive); EXTERN int ooGkClientHandleRegistrationConfirm (ooGkClient *pGkClient, H225RegistrationConfirm *pRegistrationConfirm); EXTERN int ooGkClientHandleRegistrationReject (ooGkClient *pGkClient, H225RegistrationReject *pRegistrationReject); EXTERN int ooGkClientSendURQ(ooGkClient *pGkClient, struct OOAliases *aliases); EXTERN int ooGkClientHandleUnregistrationRequest (ooGkClient *pGkClient, H225UnregistrationRequest *punregistrationRequest); EXTERN int ooGkClientSendUnregistrationConfirm(ooGkClient *pGkClient, unsigned reqNo); EXTERN int ooGkClientSendAdmissionRequest (ooGkClient *pGkClient, struct OOH323CallData *call, ASN1BOOL retransmit); EXTERN int ooGkClientHandleAdmissionConfirm (ooGkClient *pGkClient, H225AdmissionConfirm *pAdmissionConfirm); EXTERN int ooGkClientHandleAdmissionReject (ooGkClient *pGkClient, H225AdmissionReject *pAdmissionReject); EXTERN int ooGkClientSendDisengageRequest (ooGkClient *pGkClient, struct OOH323CallData *call); EXTERN int ooGkClientHandleDisengageConfirm (ooGkClient *pGkClient, H225DisengageConfirm *pDCF); EXTERN int ooGkClientRRQTimerExpired(void*pdata); EXTERN int ooGkClientGRQTimerExpired(void* pdata); EXTERN int ooGkClientREGTimerExpired(void *pdata); EXTERN int ooGkClientARQTimerExpired(void* pdata); EXTERN int ooGkClientCleanCall(ooGkClient *pGkClient, struct OOH323CallData *call); EXTERN int ooGkClientHandleClientOrGkFailure(ooGkClient *pGkClient); EXTERN int ooGkClientUpdateRegisteredAliases (ooGkClient *pGkClient, H225_SeqOfH225AliasAddress *pAddresses, OOBOOL registered); int ooGkClientSetCallbacks (ooGkClient *pGkClient, OOGKCLIENTCALLBACKS callbacks); #ifdef __cplusplus } #endif #endif /* __GKCLIENT_H */

---

This file was last modified on 28 May 2010.
Objective Open H.323 Stack, 0.9.1