/usr/include/opal/h323/h323trans.h is in libopal-dev 3.10.2~dfsg-0ubuntu1.
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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 | /*
* h323trans.h
*
* H.323 Transactor handler
*
* Open H323 Library
*
* Copyright (c) 2003 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: 24178 $
* $Author: rjongbloed $
* $Date: 2010-04-05 19:10:56 -0500 (Mon, 05 Apr 2010) $
*/
#ifndef OPAL_H323_H323TRANS_H
#define OPAL_H323_H323TRANS_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#include <opal/buildopts.h>
#if OPAL_H323
#include <h323/transaddr.h>
#include <h323/h235auth.h>
#include <ptclib/asner.h>
class H323EndPoint;
class H323TransactionPDU {
public:
H323TransactionPDU();
H323TransactionPDU(const H235Authenticators & auth);
virtual ~H323TransactionPDU() { }
virtual PBoolean Read(H323Transport & transport);
virtual PBoolean Write(H323Transport & transport);
virtual PASN_Object & GetPDU() = 0;
virtual PASN_Choice & GetChoice() = 0;
virtual const PASN_Object & GetPDU() const = 0;
virtual const PASN_Choice & GetChoice() const = 0;
virtual unsigned GetSequenceNumber() const = 0;
virtual unsigned GetRequestInProgressDelay() const = 0;
#if PTRACING
virtual const char * GetProtocolName() const = 0;
#endif
virtual H323TransactionPDU * ClonePDU() const = 0;
virtual void DeletePDU() = 0;
const H235Authenticators & GetAuthenticators() const { return authenticators; }
H235Authenticators & GetAuthenticators() { return authenticators; }
void SetAuthenticators(
const H235Authenticators & auth
) { authenticators = auth; }
H235Authenticator::ValidationResult Validate(
const PASN_Array & clearTokens,
unsigned clearOptionalField,
const PASN_Array & cryptoTokens,
unsigned cryptoOptionalField
) const { return authenticators.ValidatePDU(*this, clearTokens, clearOptionalField, cryptoTokens, cryptoOptionalField, rawPDU); }
void Prepare(
PASN_Array & clearTokens,
unsigned clearOptionalField,
PASN_Array & cryptoTokens,
unsigned cryptoOptionalField
) { authenticators.PreparePDU(*this, clearTokens, clearOptionalField, cryptoTokens, cryptoOptionalField); }
protected:
mutable H235Authenticators authenticators;
PPER_Stream rawPDU;
};
///////////////////////////////////////////////////////////
class H323Transactor : public PObject
{
PCLASSINFO(H323Transactor, PObject);
public:
/**@name Construction */
//@{
/**Create a new protocol handler.
*/
H323Transactor(
H323EndPoint & endpoint, ///< Endpoint gatekeeper is associated with.
H323Transport * transport, ///< Transport over which to communicate.
WORD localPort, ///< Local port to listen on
WORD remotePort ///< Remote port to connect on
);
H323Transactor(
H323EndPoint & endpoint, ///< Endpoint gatekeeper is associated with.
const H323TransportAddress & iface, ///< Local interface over which to communicate.
WORD localPort, ///< Local port to listen on
WORD remotePort ///< Remote port to connect on
);
/**Destroy protocol handler.
*/
~H323Transactor();
//@}
/**@name Overrides from PObject */
//@{
/**Print the name of the gatekeeper.
*/
void PrintOn(
ostream & strm ///< Stream to print to.
) const;
//@}
/**@name new operations */
//@{
/**Set a new transport for use by the transactor.
*/
PBoolean SetTransport(
const H323TransportAddress & iface ///< Local interface for transport
);
/**Return the list of addresses used for this peer element
*/
H323TransportAddressArray GetInterfaceAddresses(
bool excludeLocalHost = true ///< Flag to exclude 127.0.0.1
);
/**Start the channel processing transactions
*/
virtual PBoolean StartChannel();
/**Stop the channel processing transactions.
Must be called in each descendants destructor.
*/
virtual void StopChannel();
/**Create the transaction PDU for reading.
*/
virtual H323TransactionPDU * CreateTransactionPDU() const = 0;
/**Handle and dispatch a transaction PDU
*/
virtual PBoolean HandleTransaction(
const PASN_Object & rawPDU
) = 0;
/**Allow for modifications to PDU on send.
*/
virtual void OnSendingPDU(
PASN_Object & rawPDU
) = 0;
/**Write PDU to transport after executing callback.
*/
virtual PBoolean WritePDU(
H323TransactionPDU & pdu
);
/**Write PDU to transport after executing callback.
*/
virtual PBoolean WriteTo(
H323TransactionPDU & pdu,
const H323TransportAddressArray & addresses,
PBoolean callback = true
);
//@}
/**@name Member variable access */
//@{
/**Get the gatekeepers associated endpoint.
*/
H323EndPoint & GetEndPoint() const { return endpoint; }
/**Get the gatekeepers transport channel.
*/
H323Transport & GetTransport() const { return *transport; }
/**Set flag to check all crypto tokens on responses.
*/
void SetCheckResponseCryptoTokens(
PBoolean value ///< New value for checking crypto tokens.
) { checkResponseCryptoTokens = value; }
/**Get flag to check all crypto tokens on responses.
*/
PBoolean GetCheckResponseCryptoTokens() { return checkResponseCryptoTokens; }
//@}
protected:
void Construct();
unsigned GetNextSequenceNumber();
PBoolean SetUpCallSignalAddresses(
H225_ArrayOf_TransportAddress & addresses
);
//Background thread handler.
PDECLARE_NOTIFIER(PThread, H323Transactor, HandleTransactions);
class Request : public PObject
{
PCLASSINFO(Request, PObject);
public:
Request(
unsigned seqNum,
H323TransactionPDU & pdu
);
Request(
unsigned seqNum,
H323TransactionPDU & pdu,
const H323TransportAddressArray & addresses
);
PBoolean Poll(H323Transactor &,
unsigned numRetries = 0,
PTimeInterval timeout = 0);
void CheckResponse(unsigned, const PASN_Choice *);
void OnReceiveRIP(unsigned milliseconds);
// Inter-thread transfer variables
unsigned rejectReason;
void * responseInfo;
H323TransportAddressArray requestAddresses;
unsigned sequenceNumber;
H323TransactionPDU & requestPDU;
PTimeInterval whenResponseExpected;
PSyncPoint responseHandled;
PMutex responseMutex;
enum {
AwaitingResponse,
ConfirmReceived,
RejectReceived,
TryAlternate,
BadCryptoTokens,
RequestInProgress,
NoResponseReceived
} responseResult;
};
virtual PBoolean MakeRequest(
Request & request
);
PBoolean CheckForResponse(
unsigned,
unsigned,
const PASN_Choice * = NULL
);
PBoolean HandleRequestInProgress(
const H323TransactionPDU & pdu,
unsigned delay
);
PBoolean CheckCryptoTokens(
const H323TransactionPDU & pdu,
const PASN_Array & clearTokens,
unsigned clearOptionalField,
const PASN_Array & cryptoTokens,
unsigned cryptoOptionalField
);
void AgeResponses();
PBoolean SendCachedResponse(
const H323TransactionPDU & pdu
);
class Response : public PString
{
PCLASSINFO(Response, PString);
public:
Response(const H323TransportAddress & addr, unsigned seqNum);
~Response();
void SetPDU(const H323TransactionPDU & pdu);
PBoolean SendCachedResponse(H323Transport & transport);
PTime lastUsedTime;
PTimeInterval retirementAge;
H323TransactionPDU * replyPDU;
};
// Configuration variables
H323EndPoint & endpoint;
WORD defaultLocalPort;
WORD defaultRemotePort;
H323Transport * transport;
PBoolean checkResponseCryptoTokens;
unsigned nextSequenceNumber;
PMutex nextSequenceNumberMutex;
PDictionary<POrdinalKey, Request> requests;
PMutex requestsMutex;
Request * lastRequest;
PMutex pduWriteMutex;
PSortedList<Response> responses;
};
////////////////////////////////////////////////////////////////////////////////////
class H323Transaction : public PObject
{
PCLASSINFO(H323Transaction, PObject);
public:
/**@name Construction */
//@{
/**Create a new transaction handler.
*/
H323Transaction(
H323Transactor & transactor,
const H323TransactionPDU & requestToCopy,
H323TransactionPDU * confirm,
H323TransactionPDU * reject
);
~H323Transaction();
//@}
enum Response {
Ignore = -2,
Reject = -1,
Confirm = 0
};
inline static Response InProgress(unsigned time) { return (Response)(time&0xffff); }
virtual H323TransactionPDU * CreateRIP(
unsigned sequenceNumber,
unsigned delay
) const = 0;
PBoolean HandlePDU();
virtual PBoolean WritePDU(
H323TransactionPDU & pdu
);
PBoolean CheckCryptoTokens(
const H235Authenticators & authenticators
);
#if PTRACING
virtual const char * GetName() const = 0;
#endif
virtual H235Authenticator::ValidationResult ValidatePDU() const = 0;
virtual void SetRejectReason(
unsigned reasonCode
) = 0;
PBoolean IsFastResponseRequired() const { return fastResponseRequired && canSendRIP; }
PBoolean CanSendRIP() const { return canSendRIP; }
H323TransportAddress GetReplyAddress() const { return replyAddresses[0]; }
const H323TransportAddressArray & GetReplyAddresses() const { return replyAddresses; }
PBoolean IsBehindNAT() const { return isBehindNAT; }
H323Transactor & GetTransactor() const { return transactor; }
H235Authenticator::ValidationResult GetAuthenticatorResult() const { return authenticatorResult; }
protected:
virtual Response OnHandlePDU() = 0;
PDECLARE_NOTIFIER(PThread, H323Transaction, SlowHandler);
H323Transactor & transactor;
unsigned requestSequenceNumber;
H323TransportAddressArray replyAddresses;
PBoolean fastResponseRequired;
H323TransactionPDU * request;
H323TransactionPDU * confirm;
H323TransactionPDU * reject;
H235Authenticators authenticators;
H235Authenticator::ValidationResult authenticatorResult;
PBoolean isBehindNAT;
PBoolean canSendRIP;
};
///////////////////////////////////////////////////////////
class H323TransactionServer : public PObject
{
PCLASSINFO(H323TransactionServer, PObject);
public:
/**@name Construction */
//@{
/**Create a new gatekeeper.
*/
H323TransactionServer(
H323EndPoint & endpoint
);
/**Destroy gatekeeper.
*/
~H323TransactionServer();
//@}
virtual WORD GetDefaultUdpPort() = 0;
/**@name Access functions */
//@{
/**Get the owner endpoint.
*/
H323EndPoint & GetOwnerEndPoint() const { return ownerEndPoint; }
/**@name Protocol Handler Operations */
//@{
/**Add listeners to the transaction server.
If a listener already exists on the interface specified in the list
then it is ignored. If a listener does not yet exist a new one is
created and if a listener is running that is not in the list then it
is stopped and removed.
If the array is empty then the string "*" is assumed which will listen
on the standard UDP port on INADDR_ANY.
Returns true if at least one interface was successfully started.
*/
PBoolean AddListeners(
const H323TransportAddressArray & ifaces ///< Interfaces to listen on.
);
/**Add a gatekeeper listener to this gatekeeper server given the
transport address for the local interface.
*/
PBoolean AddListener(
const H323TransportAddress & interfaceName
);
/**Add a gatekeeper listener to this gatekeeper server given the transport.
Note that the transport is then owned by the listener and will be
deleted automatically when the listener is destroyed. Note also the
transport is deleted if this function returns false and no listener was
created.
*/
PBoolean AddListener(
H323Transport * transport
);
/**Add a gatekeeper listener to this gatekeeper server.
Note that the gatekeeper listener is then owned by the gatekeeper
server and will be deleted automatically when the listener is removed.
Note also the listener is deleted if this function returns false and
the listener was not used.
*/
PBoolean AddListener(
H323Transactor * listener
);
/**Create a new H323GatkeeperListener.
The user woiuld not usually use this function as it is used internally
by the server when new listeners are added by H323TransportAddress.
However, a user may override this function to create objects that are
user defined descendants of H323GatekeeperListener so the user can
maintain extra information on a interface by interface basis.
*/
virtual H323Transactor * CreateListener(
H323Transport * transport ///< Transport for listener
) = 0;
/**Remove a gatekeeper listener from this gatekeeper server.
The gatekeeper listener is automatically deleted.
*/
PBoolean RemoveListener(
H323Transactor * listener
);
PBoolean SetUpCallSignalAddresses(H225_ArrayOf_TransportAddress & addresses);
//@}
protected:
H323EndPoint & ownerEndPoint;
PThread * monitorThread;
PSyncPoint monitorExit;
PMutex mutex;
PLIST(ListenerList, H323Transactor);
ListenerList listeners;
};
#endif // OPAL_H323
#endif // OPAL_H323_H323TRANS_H
/////////////////////////////////////////////////////////////////////////////
|