/usr/include/opal/h323/q931.h is in libopal-dev 3.10.10~dfsg2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | /*
* q931.h
*
* Q.931 protocol handler
*
* Open H323 Library
*
* Copyright (c) 1998-2001 Equivalence Pty. Ltd.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Open H323 Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Contributor(s): ______________________________________.
*
* $Revision: 24879 $
* $Author: rjongbloed $
* $Date: 2010-11-16 21:56:23 -0600 (Tue, 16 Nov 2010) $
*/
#ifndef OPAL_H323_Q931_H
#define OPAL_H323_Q931_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#include <opal/buildopts.h>
///////////////////////////////////////////////////////////////////////////////
/**This class embodies a Q.931 Protocol Data Unit.
*/
class Q931 : public PObject
{
PCLASSINFO(Q931, PObject)
public:
enum MsgTypes {
NationalEscapeMsg = 0x00,
AlertingMsg = 0x01,
CallProceedingMsg = 0x02,
ConnectMsg = 0x07,
ConnectAckMsg = 0x0f,
ProgressMsg = 0x03,
SetupMsg = 0x05,
SetupAckMsg = 0x0d,
ResumeMsg = 0x26,
ResumeAckMsg = 0x2e,
ResumeRejectMsg = 0x22,
SuspendMsg = 0x25,
SuspendAckMsg = 0x2d,
SuspendRejectMsg = 0x21,
UserInformationMsg = 0x20,
DisconnectMsg = 0x45,
ReleaseMsg = 0x4d,
ReleaseCompleteMsg = 0x5a,
RestartMsg = 0x46,
RestartAckMsg = 0x4e,
SegmentMsg = 0x60,
CongestionCtrlMsg = 0x79,
InformationMsg = 0x7b,
NotifyMsg = 0x6e,
StatusMsg = 0x7d,
StatusEnquiryMsg = 0x75,
FacilityMsg = 0x62
};
Q931();
Q931(const Q931 & other);
Q931 & operator=(const Q931 & other);
void BuildFacility(int callRef, PBoolean fromDest);
void BuildInformation(int callRef, PBoolean fromDest);
void BuildProgress(
int callRef,
PBoolean fromDest,
unsigned description,
unsigned codingStandard = 0,
unsigned location = 0
);
void BuildNotify(int callRef, PBoolean fromDest);
void BuildCallProceeding(int callRef);
void BuildSetupAcknowledge(int callRef);
void BuildAlerting(int callRef);
void BuildSetup(int callRef = -1);
void BuildConnect(int callRef);
void BuildStatus(int callRef, PBoolean fromDest);
void BuildStatusEnquiry(int callRef, PBoolean fromDest);
void BuildReleaseComplete(int callRef, PBoolean fromDest);
PBoolean Decode(const PBYTEArray & data);
PBoolean Encode(PBYTEArray & data) const;
void PrintOn(ostream & strm) const;
PString GetMessageTypeName() const;
static unsigned GenerateCallReference();
unsigned GetCallReference() const { return callReference; }
PBoolean IsFromDestination() const { return fromDestination; }
MsgTypes GetMessageType() const { return messageType; }
enum InformationElementCodes {
BearerCapabilityIE = 0x04,
CauseIE = 0x08,
ChannelIdentificationIE = 0x18,
FacilityIE = 0x1c,
ProgressIndicatorIE = 0x1e,
CallStateIE = 0x14,
DisplayIE = 0x28,
KeypadIE = 0x2c,
SignalIE = 0x34,
ConnectedNumberIE = 0x4c,
CallingPartyNumberIE = 0x6c,
CalledPartyNumberIE = 0x70,
RedirectingNumberIE = 0x74,
UserUserIE = 0x7e
};
friend ostream & operator<<(ostream & strm, InformationElementCodes ie);
PBoolean HasIE(InformationElementCodes ie) const;
PBYTEArray GetIE(
InformationElementCodes ie,
PINDEX idx = 0 // Index of duplicate IE entry
) const;
void SetIE(
InformationElementCodes ie,
const PBYTEArray & userData,
bool append = FALSE
);
void RemoveIE(InformationElementCodes ie);
enum InformationTransferCapability {
TransferSpeech,
TransferUnrestrictedDigital = 8,
TransferRestrictedDigital = 9,
Transfer3_1kHzAudio = 16,
TrasnferUnrestrictedDigitalWithTones = 17,
TransferVideo = 24
};
void SetBearerCapabilities(
InformationTransferCapability capability, ///< Bearer cability enum
unsigned transferRate, ///< Number of 64k B channels
unsigned codingStandard = 0, ///< 0 = ITU-T standardized coding
unsigned userInfoLayer1 = 5 ///< 5 = Recommendations H.221 and H.242
);
void SetBearerCapabilities(
const PString & caps ///< String of comma separated integers or hex for all cap bytes
);
PBoolean GetBearerCapabilities(
InformationTransferCapability & capability, ///< Bearer cability enum
unsigned & transferRate, ///< Number of 64k B channels
unsigned * codingStandard = NULL, ///< 0 = ITU-T standardized coding
unsigned * userInfoLayer1 = NULL ///< 5 = Recommendations H.221 and H.242
);
enum CauseValues {
UnknownCauseIE = 0,
UnallocatedNumber = 1,
NoRouteToNetwork = 2,
NoRouteToDestination = 3,
SendSpecialTone = 4,
MisdialledTrunkPrefix = 5,
ChannelUnacceptable = 6,
NormalCallClearing = 16,
UserBusy = 17,
NoResponse = 18,
NoAnswer = 19,
SubscriberAbsent = 20,
CallRejected = 21,
NumberChanged = 22,
Redirection = 23,
ExchangeRoutingError = 25,
NonSelectedUserClearing = 26,
DestinationOutOfOrder = 27,
InvalidNumberFormat = 28,
FacilityRejected = 29,
StatusEnquiryResponse = 30,
NormalUnspecified = 31,
NoCircuitChannelAvailable = 34,
NetworkOutOfOrder = 38,
TemporaryFailure = 41,
Congestion = 42,
RequestedCircuitNotAvailable = 44,
ResourceUnavailable = 47,
ServiceOptionNotAvailable = 63,
InvalidCallReference = 81,
ClearedRequestedCallIdentity = 86,
IncompatibleDestination = 88,
IENonExistantOrNotImplemented= 99,
TimerExpiry = 102,
ProtocolErrorUnspecified = 111,
InterworkingUnspecified = 127,
ErrorInCauseIE = 0x100
};
friend ostream & operator<<(ostream & strm, CauseValues cause);
void SetCause(
CauseValues value, ///< Cause code
unsigned standard = 0, ///< 0 = ITU-T standardized coding
unsigned location = 0 ///< 0 = User
);
CauseValues GetCause(
unsigned * standard = NULL, ///< 0 = ITU-T standardized coding
unsigned * location = NULL ///< 0 = User
) const;
enum CallStates {
CallState_Null = 0,
CallState_CallInitiated = 1,
CallState_OverlapSending = 2,
CallState_OutgoingCallProceeding= 3,
CallState_CallDelivered = 4,
CallState_CallPresent = 6,
CallState_CallReceived = 7,
CallState_ConnectRequest = 8,
CallState_IncomingCallProceeding= 9,
CallState_Active = 10,
CallState_DisconnectRequest = 11,
CallState_DisconnectIndication = 12,
CallState_SuspendRequest = 15,
CallState_ResumeRequest = 17,
CallState_ReleaseRequest = 19,
CallState_OverlapReceiving = 25,
CallState_ErrorInIE = 0x100
};
void SetCallState(
CallStates value, ///< Call state code
unsigned standard = 0 ///< 0 = ITU-T standardized coding
);
CallStates GetCallState(
unsigned * standard = NULL ///< 0 = ITU-T standardized coding
) const;
enum SignalInfo {
SignalDialToneOn,
SignalRingBackToneOn,
SignalInterceptToneOn,
SignalNetworkCongestionToneOn,
SignalBusyToneOn,
SignalConfirmToneOn,
SignalAnswerToneOn,
SignalCallWaitingTone,
SignalOffhookWarningTone,
SignalPreemptionToneOn,
SignalTonesOff = 0x3f,
SignalAlertingPattern0 = 0x40,
SignalAlertingPattern1,
SignalAlertingPattern2,
SignalAlertingPattern3,
SignalAlertingPattern4,
SignalAlertingPattern5,
SignalAlertingPattern6,
SignalAlertingPattern7,
SignalAlertingOff = 0x4f,
SignalErrorInIE = 0x100
};
void SetSignalInfo(SignalInfo value);
SignalInfo GetSignalInfo() const;
void SetKeypad(const PString & digits);
PString GetKeypad() const;
enum ProgressIndication {
ProgressNotEndToEndISDN = 1, // Call is not end-to-end ISDN;
// further call progress information may be available in-band
ProgressDestinationNonISDN = 2, // Destination address is non ISDN
ProgressOriginNotISDN = 3, // Origination address is non ISDN
ProgressReturnedToISDN = 4, // Call has returned to the ISDN
ProgressServiceChange = 5, // Interworking has occurred and has
// resulted in a telecommunication service change
ProgressInbandInformationAvailable = 8 // In-band information or an appropriate pattern is now available.
};
void SetProgressIndicator(
unsigned description,
unsigned codingStandard = 0,
unsigned location = 0
);
PBoolean GetProgressIndicator(
unsigned & description,
unsigned * codingStandard = NULL,
unsigned * location = NULL
) const;
void SetDisplayName(const PString & name);
PString GetDisplayName() const;
enum NumberingPlanCodes {
UnknownPlan = 0x00,
ISDNPlan = 0x01,
DataPlan = 0x03,
TelexPlan = 0x04,
NationalStandardPlan = 0x08,
PrivatePlan = 0x09,
ReservedPlan = 0x0f
};
enum TypeOfNumberCodes {
UnknownType = 0x00,
InternationalType = 0x01,
NationalType = 0x02,
NetworkSpecificType = 0x03,
SubscriberType = 0x04,
AbbreviatedType = 0x06,
ReservedType = 0x07
};
void SetCallingPartyNumber(
const PString & number, ///< Number string
unsigned plan = 1, ///< 1 = ISDN/Telephony numbering system, see Q.931 Table 4-11 for more
unsigned type = 0, ///< 0 = Unknown number type
int presentation = -1, ///< 0 = presentation allowed, 1 = presentation restricted, -1 = no octet3a
int screening = -1 ///< 0 = user provided, not screened, -1 = no octet3a
);
PBoolean GetCallingPartyNumber(
PString & number, ///< Number string
unsigned * plan = NULL, ///< ISDN/Telephony numbering system
unsigned * type = NULL, ///< Number type
unsigned * presentation = NULL, ///< Presentation indicator
unsigned * screening = NULL, ///< Screening indicator
unsigned defPresentation = 0, ///< Default value if octet3a not present
unsigned defScreening = 0 ///< Default value if octet3a not present
) const;
void SetCalledPartyNumber(
const PString & number, ///< Number string
unsigned plan = 1, ///< 1 = ISDN/Telephony numbering system
unsigned type = 0 ///< 0 = Unknown number type
);
PBoolean GetCalledPartyNumber(
PString & number, ///< Number string
unsigned * plan = NULL, ///< ISDN/Telephony numbering system
unsigned * type = NULL ///< Number type
) const;
void SetRedirectingNumber(
const PString & number, ///< Number string
unsigned plan = 1, ///< 1 = ISDN/Telephony numbering system
unsigned type = 0, ///< 0 = Unknown number type
int presentation = -1, ///< 0 = presentation allowed, -1 = no octet3a
int screening = -1, ///< 0 = user provided, not screened
int reason = -1 ///< 0 = Unknown reason , -1 = no octet 3b
);
PBoolean GetRedirectingNumber(
PString & number, ///< Number string
unsigned * plan = NULL, ///< ISDN/Telephony numbering system
unsigned * type = NULL, ///< Number type
unsigned * presentation = NULL, ///< Presentation indicator
unsigned * screening = NULL, ///< Screening indicator
unsigned * reason = NULL, ///< Reason for redirection
unsigned defPresentation = 0, ///< Default value if octet3a not present
unsigned defScreening = 0, ///< Default value if octet3a not present
unsigned defReason =0 ///< Default value if octet 3b not present
) const;
void SetConnectedNumber(
const PString & number, ///< Number string
unsigned plan = 1, ///< 1 = ISDN/Telephony numbering system
unsigned type = 0, ///< 0 = Unknown number type
int presentation = -1, ///< 0 = presentation allowed, -1 = no octet3a
int screening = -1, ///< 0 = user provided, not screened
int reason = -1 ///< 0 = Unknown reason , -1 = no octet 3b
);
PBoolean GetConnectedNumber(
PString & number, ///< Number string
unsigned * plan = NULL, ///< ISDN/Telephony numbering system
unsigned * type = NULL, ///< Number type
unsigned * presentation = NULL, ///< Presentation indicator
unsigned * screening = NULL, ///< Screening indicator
unsigned * reason = NULL, ///< Reason for redirection
unsigned defPresentation = 0, ///< Default value if octet3a not present
unsigned defScreening = 0, ///< Default value if octet3a not present
unsigned defReason =0 ///< Default value if octet 3b not present
) const;
/**Set the limitations to ChannelIdentification.
- the interface identifier cannot be specified
- channel in PRI can only be indicated by number and cannot be indicated by map
- one and only one channel can be indicated
- the coding standard is always ITU Q.931
*/
void SetChannelIdentification(
unsigned interfaceType = 0, ///< 0 = basic, 1 = other (e.g. primary)
unsigned preferredOrExclusive = 0, ///< 0 = preferred, 1 = exclusive
int channelNumber = 1 ///< -1 = any, 0 = none/D, 1 = channel 1/B1, etc. 1-15,17-31
);
/**Get the limitations to ChannelIdentification.
*/
PBoolean GetChannelIdentification(
unsigned * interfaceType = NULL, ///< Interface type
unsigned * preferredOrExclusive = NULL, ///< Channel negotiation preference
int * channelNumber = NULL ///< Channel number
) const;
protected:
unsigned callReference;
PBoolean fromDestination;
unsigned protocolDiscriminator;
MsgTypes messageType;
PARRAY(InternalInformationElement, PBYTEArray);
PDICTIONARY(InternalInformationElements, POrdinalKey, InternalInformationElement);
InternalInformationElements informationElements;
};
#endif // OPAL_H323_Q931_H
/////////////////////////////////////////////////////////////////////////////
|