ooq931.h Go to the documentation of this file. /* * Copyright (C) 2004-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 _OOQ931HDR_H_ #define _OOQ931HDR_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 /* MAKE_DLL */ #endif /* EXTERN */ /* Maximum length of the Calling/Called party number number */ #define OO_MAX_NUMBER_LENGTH 50 /* Maximum value for a call token identifier */ #define OO_MAX_CALL_TOKEN 9999 /* Q.931 packet must be at least 5 bytes long */ #define Q931_E_TOOSHORT (-1001) /* callReference field must be 2 bytes long */ #define Q931_E_INVCALLREF (-1002) /* invalid length of message */ #define Q931_E_INVLENGTH (-1003) enum Q931MsgTypes { Q931NationalEscapeMsg = 0x00, Q931AlertingMsg = 0x01, Q931CallProceedingMsg = 0x02, Q931ConnectMsg = 0x07, Q931ConnectAckMsg = 0x0f, Q931ProgressMsg = 0x03, Q931SetupMsg = 0x05, Q931SetupAckMsg = 0x0d, Q931ResumeMsg = 0x26, Q931ResumeAckMsg = 0x2e, Q931ResumeRejectMsg = 0x22, Q931SuspendMsg = 0x25, Q931SuspendAckMsg = 0x2d, Q931SuspendRejectMsg = 0x21, Q931UserInformationMsg = 0x20, Q931DisconnectMsg = 0x45, Q931ReleaseMsg = 0x4d, Q931ReleaseCompleteMsg = 0x5a, Q931RestartMsg = 0x46, Q931RestartAckMsg = 0x4e, Q931SegmentMsg = 0x60, Q931CongestionCtrlMsg = 0x79, Q931InformationMsg = 0x7b, Q931NotifyMsg = 0x6e, Q931StatusMsg = 0x7d, Q931StatusEnquiryMsg = 0x75, Q931FacilityMsg = 0x62 }; enum Q931IECodes { Q931BearerCapabilityIE = 0x04, Q931CauseIE = 0x08, Q931FacilityIE = 0x1c, Q931ProgressIndicatorIE = 0x1e, Q931CallStateIE = 0x14, Q931DisplayIE = 0x28, Q931SignalIE = 0x34, Q931CallingPartyNumberIE = 0x6c, Q931CalledPartyNumberIE = 0x70, Q931RedirectingNumberIE = 0x74, Q931UserUserIE = 0x7e, Q931KeypadIE = 0x2c }; enum Q931InformationTransferCapability { Q931TransferSpeech, Q931TransferUnrestrictedDigital = 8, Q931TransferRestrictedDigital = 9, Q931Transfer3_1kHzAudio = 16, Q931TrasnferUnrestrictedDigitalWithTones = 17, Q931TransferVideo = 24 }; enum Q931CauseValues { Q931UnallocatedNumber = 0x01, Q931NoRouteToNetwork = 0x02, Q931NoRouteToDestination = 0x03, Q931ChannelUnacceptable = 0x06, Q931NormalCallClearing = 0x10, Q931UserBusy = 0x11, Q931NoResponse = 0x12, Q931NoAnswer = 0x13, Q931SubscriberAbsent = 0x14, Q931CallRejected = 0x15, Q931NumberChanged = 0x16, Q931Redirection = 0x17, Q931DestinationOutOfOrder = 0x1b, Q931InvalidNumberFormat = 0x1c, Q931NormalUnspecified = 0x1f, Q931StatusEnquiryResponse = 0x1e, Q931NoCircuitChannelAvailable = 0x22, Q931NetworkOutOfOrder = 0x26, Q931TemporaryFailure = 0x29, Q931Congestion = 0x2a, Q931RequestedCircuitUnAvailable = 0x2c, Q931ResourcesUnavailable = 0x2f, Q931IncompatibleDestination = 0x58, Q931ProtocolErrorUnspecified = 0x6f, Q931RecoveryOnTimerExpiry = 0x66, Q931InvalidCallReference = 0x51, Q931ErrorInCauseIE = 0 }; enum Q931SignalInfo { Q931SignalDialToneOn, Q931SignalRingBackToneOn, Q931SignalInterceptToneOn, Q931SignalNetworkCongestionToneOn, Q931SignalBusyToneOn, Q931SignalConfirmToneOn, Q931SignalAnswerToneOn, Q931SignalCallWaitingTone, Q931SignalOffhookWarningTone, Q931SignalPreemptionToneOn, Q931SignalTonesOff = 0x3f, Q931SignalAlertingPattern0 = 0x40, Q931SignalAlertingPattern1, Q931SignalAlertingPattern2, Q931SignalAlertingPattern3, Q931SignalAlertingPattern4, Q931SignalAlertingPattern5, Q931SignalAlertingPattern6, Q931SignalAlertingPattern7, Q931SignalAlretingOff = 0x4f, Q931SignalErrorInIE = 0x100 }; enum Q931NumberingPlanCodes { Q931UnknownPlan = 0x00, Q931ISDNPlan = 0x01, Q931DataPlan = 0x03, Q931TelexPlan = 0x04, Q931NationalStandardPlan = 0x08, Q931PrivatePlan = 0x09, Q931ReservedPlan = 0x0f }; enum Q931TypeOfNumberCodes { Q931UnknownType = 0x00, Q931InternationalType = 0x01, Q931NationalType = 0x02, Q931NetworkSpecificType = 0x03, Q931SubscriberType = 0x04, Q931AbbreviatedType = 0x06, Q931ReservedType = 0x07 }; enum Q931CodingStandard{ Q931CCITTStd = 0, Q931ReservedInternationalStd, Q931NationalStd, Q931NetworkStd }; enum Q931TransferMode { Q931TransferCircuitMode = 0, /* 00 */ Q931TransferPacketMode = 2 /* 10 */ }; enum Q931TransferRate{ Q931TransferRatePacketMode = 0x00, /* 00000 */ Q931TransferRate64Kbps = 0x10, /* 10000 */ Q931TransferRate128kbps = 0x11, /* 10001 */ Q931TransferRate384kbps = 0x13, /* 10011 */ Q931TransferRate1536kbps = 0x15, /* 10101 */ Q931TransferRate1920kbps = 0x17 /* 10111 */ }; enum Q931UserInfoLayer1Protocol{ Q931UserInfoLayer1CCITTStdRate = 1, Q931UserInfoLayer1G711ULaw, Q931UserInfoLayer1G711ALaw, Q931UserInfoLayer1G721ADPCM, Q931UserInfoLayer1G722G725, Q931UserInfoLayer1H261, Q931UserInfoLayer1NonCCITTStdRate, Q931UserInfoLayer1CCITTStdRateV120, Q931UserInfoLayer1X31 }; /* Structure to build store outgoing encoded UUIE The different fields in the structure have octet lengths as specified in the spec. */ typedef struct Q931InformationElement { int discriminator; int offset; int length; ASN1OCTET data[1]; } Q931InformationElement; typedef struct Q931Message { ASN1UINT protocolDiscriminator; ASN1UINT callReference; ASN1BOOL fromDestination; ASN1UINT messageType; /* Q931MsgTypes */ ASN1UINT tunneledMsgType; /* The H245 message this message is tunneling*/ ASN1INT logicalChannelNo; /* channel number associated with tunneled */ /* message, 0 if no channel */ DList ies; Q931InformationElement *bearerCapabilityIE; Q931InformationElement *callingPartyNumberIE; Q931InformationElement *calledPartyNumberIE; Q931InformationElement *causeIE; Q931InformationElement *keypadIE; H225H323_UserInformation *userInfo; } Q931Message; typedef struct OOAliases { int type; char *value; OOBOOL registered; struct OOAliases *next; } OOAliases; #define ooAliases OOAliases struct OOH323CallData; /* * These are message callbacks which can be used by user applications * to perform application specific things on receiving a particular * message or before sending a particular message. For ex. user application * can change values of some parameters of setup message before it is actually * sent out. */ typedef int (*cb_OnReceivedSetup) (struct OOH323CallData *call, struct Q931Message *pmsg); typedef int (*cb_OnReceivedConnect) (struct OOH323CallData *call, struct Q931Message *pmsg); typedef int (*cb_OnBuiltSetup) (struct OOH323CallData *call, struct Q931Message *pmsg); typedef int (*cb_OnBuiltConnect) (struct OOH323CallData *call, struct Q931Message *pmsg); typedef struct OOH225MsgCallbacks { cb_OnReceivedSetup onReceivedSetup; cb_OnReceivedConnect onReceivedConnect; cb_OnBuiltSetup onBuiltSetup; cb_OnBuiltConnect onBuiltConnect; } OOH225MsgCallbacks; EXTERN int ooQ931Decode (struct OOH323CallData *call, Q931Message* msg, int length, ASN1OCTET *data); EXTERN int ooDecodeUUIE(Q931Message *q931Msg); EXTERN int ooEncodeUUIE(Q931Message *q931msg); EXTERN Q931InformationElement* ooQ931GetIE (const Q931Message* q931msg, int ieCode); EXTERN void ooQ931Print (const Q931Message* q931msg); EXTERN int ooCreateQ931Message(Q931Message **msg, int msgType); EXTERN ASN1USINT ooGenerateCallReference(void); EXTERN int ooGenerateCallIdentifier(H225CallIdentifier *callid); EXTERN int ooFreeQ931Message(Q931Message *q931Msg); EXTERN int ooGetOutgoingQ931Msgbuf (struct OOH323CallData *call, ASN1OCTET * msgbuf, int* len, int *msgType); EXTERN int ooSendReleaseComplete(struct OOH323CallData *call); EXTERN int ooSendCallProceeding(struct OOH323CallData *call); EXTERN int ooSendAlerting(struct OOH323CallData *call); EXTERN int ooSendFacility(struct OOH323CallData *call); EXTERN int ooQ931SendDTMFAsKeyPadIE (struct OOH323CallData *call, const char* data); EXTERN int ooSendConnect(struct OOH323CallData *call); EXTERN int ooH323MakeCall(char *dest, char *callToken, ooCallOptions *opts); int ooH323CallAdmitted( struct OOH323CallData *call); EXTERN int ooH323HandleCallFwdRequest(struct OOH323CallData *call); EXTERN int ooH323ForwardCall(char* callToken, char *dest); EXTERN int ooH323HangCall(char * callToken, OOCallClearReason reason); EXTERN int ooAcceptCall(struct OOH323CallData *call); /* * An helper function to ooMakeCall. * @param call Pointer to the new call. * * @return OO_OK, on success. OO_FAILED, on failure. */ EXTERN int ooH323MakeCall_helper(struct OOH323CallData *call); int ooParseDestination (struct OOH323CallData *call, char *dest, char *parsedIP, unsigned len, OOAliases** aliasList); int ooGenerateCallToken (char *callToken, size_t size); EXTERN int ooSendAsTunneledMessage (struct OOH323CallData *call, ASN1OCTET* msgbuf, int h245Len, int h245MsgType, int associatedChan); int ooEncodeH225Message(struct OOH323CallData *call, Q931Message *pq931Msg, ASN1OCTET* msgbuf, size_t size); int ooCallEstbTimerExpired(void *data); EXTERN int ooQ931SetKeypadIE(Q931Message *pmsg, const char* data); EXTERN int ooSetBearerCapabilityIE (Q931Message *pmsg, enum Q931CodingStandard codingStandard, enum Q931InformationTransferCapability capability, enum Q931TransferMode transferMode, enum Q931TransferRate transferRate, enum Q931UserInfoLayer1Protocol userInfoLayer1); EXTERN int ooQ931SetCalledPartyNumberIE (Q931Message *pmsg, const char *number, unsigned plan, unsigned type); EXTERN int ooQ931SetCallingPartyNumberIE (Q931Message *pmsg, const char *number, unsigned plan, unsigned type, unsigned presentation, unsigned screening); EXTERN int ooQ931SetCauseIE (Q931Message *pmsg,enum Q931CauseValues cause, unsigned coding, unsigned location); EXTERN int ooQ931GetCauseAndReasonCodeFromCallClearReason (OOCallClearReason clearReason, enum Q931CauseValues *cause, unsigned *reasonCode); EXTERN OOCallClearReason ooGetCallClearReasonFromCauseAndReasonCode (enum Q931CauseValues cause, unsigned reasonCode); EXTERN const char* ooGetMsgTypeText (int msgType); EXTERN const char* ooGetQ931CauseValueText (int val); #ifdef __cplusplus } #endif #endif /* __Q931HDR_H */

---

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