/usr/include/opal/h323/svcctrl.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 | /*
* svcctrl.h
*
* H.225 Service Control protocol 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_SVCCTRL_H
#define OPAL_H323_SVCCTRL_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#include <opal/buildopts.h>
#if OPAL_H323
class H225_ServiceControlDescriptor;
class H225_ServiceControlIndication;
class H225_ServiceControlResponse;
class H248_SignalsDescriptor;
class H248_SignalRequest;
class H323EndPoint;
class H323Connection;
///////////////////////////////////////////////////////////////////////////////
/**This is a base class for H.323 Service Control Session handling.
This implements the service class session management as per Annex K/H.323.
*/
class H323ServiceControlSession : public PObject
{
PCLASSINFO(H323ServiceControlSession, PObject);
public:
/**@name Construction */
//@{
/**Create a new handler for a Service Control.
*/
H323ServiceControlSession();
//@}
/**@name Operations */
//@{
/**Determine of the session is valid.
That is has all of the data it needs to correctly encode a PDU.
Default behaviour is pure.
*/
virtual PBoolean IsValid() const = 0;
/**Get identification name for the Control Service.
This function separates the dynamic data from the fundamental type of
the control service which will cause a new session ID to be generated
by the gatekeeper server.
Default behaviour returns the class name.
*/
virtual PString GetServiceControlType() const;
/**Handle a received PDU.
Update in the internal state from the received PDU.
Returns false is PDU is not sutiable for the class type.
Default behaviour is pure.
*/
virtual PBoolean OnReceivedPDU(
const H225_ServiceControlDescriptor & descriptor
) = 0;
/**Handle a sent PDU.
Set the PDU fields from in the internal state.
Returns false is PDU cannot be created.
Default behaviour is pure.
*/
virtual PBoolean OnSendingPDU(
H225_ServiceControlDescriptor & descriptor
) const = 0;
enum ChangeType {
OpenSession, // H225_ServiceControlSession_reason::e_open
RefreshSession, // H225_ServiceControlSession_reason::e_refresh
CloseSession // H225_ServiceControlSession_reason::e_close
};
/**Handle a change of the state of the Service Control Session.
Default behaviour is pure.
*/
virtual void OnChange(
unsigned type,
unsigned sessionId,
H323EndPoint & endpoint,
H323Connection * connection
) const = 0;
//@}
};
/**This class is for H.323 Service Control Session handling for HTTP.
This implements the HTTP channel management as per Annex K/H.323.
*/
class H323HTTPServiceControl : public H323ServiceControlSession
{
PCLASSINFO(H323HTTPServiceControl, H323ServiceControlSession);
public:
/**@name Construction */
//@{
/**Create a new handler for a Service Control.
*/
H323HTTPServiceControl(
const PString & url
);
/**Create a new handler for a Service Control, initialise to PDU.
*/
H323HTTPServiceControl(
const H225_ServiceControlDescriptor & contents
);
//@}
/**@name Operations */
//@{
/**Determine of the session is valid.
That is has all of the data it needs to correctly encode a PDU.
Default behaviour returns true if url is not an empty string.
*/
virtual PBoolean IsValid() const;
/**Get identification name for the Control Service.
This function separates the dynamic data from the fundamental type of
the control service which will cause a new session ID to be generated
by the gatekeeper server.
Default behaviour returns the class name.
*/
virtual PString GetServiceControlType() const;
/**Handle a received PDU.
Update in the internal state from the received PDU.
Default behaviour gets the contents for an e_url.
*/
virtual PBoolean OnReceivedPDU(
const H225_ServiceControlDescriptor & contents
);
/**Handle a sent PDU.
Set the PDU fields from in the internal state.
Default behaviour sets the contents to an e_url.
*/
virtual PBoolean OnSendingPDU(
H225_ServiceControlDescriptor & contents
) const;
/**Handle a change of the state of the Service Control Session.
Default behaviour calls endpoint.OnHTTPServiceControl().
*/
virtual void OnChange(
unsigned type,
unsigned sessionId,
H323EndPoint & endpoint,
H323Connection * connection
) const;
//@}
protected:
PString url;
};
/**This is a base class for H.323 Service Control Session handling for H.248.
*/
class H323H248ServiceControl : public H323ServiceControlSession
{
PCLASSINFO(H323H248ServiceControl, H323ServiceControlSession);
public:
/**@name Construction */
//@{
/**Create a new handler for a Service Control.
*/
H323H248ServiceControl();
/**Create a new handler for a Service Control, initialise to PDU.
*/
H323H248ServiceControl(
const H225_ServiceControlDescriptor & contents
);
//@}
/**@name Operations */
//@{
/**Handle a received PDU.
Update in the internal state from the received PDU.
Default behaviour converts to pdu to H248_SignalsDescriptor and calls
that version of OnReceivedPDU().
*/
virtual PBoolean OnReceivedPDU(
const H225_ServiceControlDescriptor & contents
);
/**Handle a sent PDU.
Set the PDU fields from in the internal state.
Default behaviour calls the H248_SignalsDescriptor version of
OnSendingPDU() and converts that to the contents pdu.
*/
virtual PBoolean OnSendingPDU(
H225_ServiceControlDescriptor & contents
) const;
/**Handle a received PDU.
Update in the internal state from the received PDU.
Default behaviour calls the H248_SignalRequest version of
OnReceivedPDU() for every element in H248_SignalsDescriptor.
*/
virtual PBoolean OnReceivedPDU(
const H248_SignalsDescriptor & descriptor
);
/**Handle a sent PDU.
Set the PDU fields from in the internal state.
Default behaviour calls the H248_SignalRequest version of
OnSendingPDU() and appends it to the H248_SignalsDescriptor.
*/
virtual PBoolean OnSendingPDU(
H248_SignalsDescriptor & descriptor
) const;
/**Handle a received PDU.
Update in the internal state from the received PDU.
Default behaviour is pure.
*/
virtual PBoolean OnReceivedPDU(
const H248_SignalRequest & request
) = 0;
/**Handle a sent PDU.
Set the PDU fields from in the internal state.
Default behaviour is pure.
*/
virtual PBoolean OnSendingPDU(
H248_SignalRequest & request
) const = 0;
//@}
};
/**This class is for H.323 Service Control Session handling for call credit.
*/
class H323CallCreditServiceControl : public H323ServiceControlSession
{
PCLASSINFO(H323CallCreditServiceControl, H323ServiceControlSession);
public:
/**@name Construction */
//@{
/**Create a new handler for a Service Control.
*/
H323CallCreditServiceControl(
const PString & amount,
PBoolean mode,
unsigned duration = 0
);
/**Create a new handler for a Service Control, initialise to PDU.
*/
H323CallCreditServiceControl(
const H225_ServiceControlDescriptor & contents
);
//@}
/**@name Operations */
//@{
/**Determine of the session is valid.
That is has all of the data it needs to correctly encode a PDU.
Default behaviour returns true if amount or duration is set.
*/
virtual PBoolean IsValid() const;
/**Handle a received PDU.
Update in the internal state from the received PDU.
Default behaviour gets the contents for an e_callCreditServiceControl.
*/
virtual PBoolean OnReceivedPDU(
const H225_ServiceControlDescriptor & contents
);
/**Handle a sent PDU.
Set the PDU fields from in the internal state.
Default behaviour sets the contents to an e_callCreditServiceControl.
*/
virtual PBoolean OnSendingPDU(
H225_ServiceControlDescriptor & contents
) const;
/**Handle a change of the state of the Service Control Session.
Default behaviour calls endpoint.OnCallCreditServiceControl() and
optionally connection->SetEnforceDurationLimit().
*/
virtual void OnChange(
unsigned type,
unsigned sessionId,
H323EndPoint & endpoint,
H323Connection * connection
) const;
//@}
/**@name Member access */
//@{
/// Return the amount string
const PString & GetAmount() const { return amount; }
/// Return the mode of operation
bool GetMode() const { return mode; }
/// Return the duration limit
unsigned GetDurationLimit() const { return durationLimit; }
//@}
protected:
PString amount;
bool mode;
unsigned durationLimit;
};
#endif // OPAL_H323
#endif // OPAL_H323_SVCCTRL_H
/////////////////////////////////////////////////////////////////////////////
|