/usr/include/opal/opal/localep.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 | /*
* localep.h
*
* Local EndPoint/Connection.
*
* Open Phone Abstraction Library (OPAL)
* Formally known as the Open H323 project.
*
* Copyright (c) 2008 Vox Lucida 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 Phone Abstraction Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Contributor(s): ______________________________________.
*
* $Revision: 26069 $
* $Author: rjongbloed $
* $Date: 2011-06-23 19:56:50 -0500 (Thu, 23 Jun 2011) $
*/
#ifndef OPAL_OPAL_LOCALEP_H
#define OPAL_OPAL_LOCALEP_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#include <opal/buildopts.h>
#include <opal/endpoint.h>
class OpalLocalConnection;
/** Local EndPoint.
This class represents an endpoint on the local machine that can receive
media via virtual functions.
*/
class OpalLocalEndPoint : public OpalEndPoint
{
PCLASSINFO(OpalLocalEndPoint, OpalEndPoint);
public:
/**@name Construction */
//@{
/**Create a new endpoint.
*/
OpalLocalEndPoint(
OpalManager & manager, ///< Manager of all endpoints.
const char * prefix = "local" ///< Prefix for URL style address strings
);
/**Destroy endpoint.
*/
~OpalLocalEndPoint();
//@}
/**@name Overrides from OpalEndPoint */
//@{
/**Get the data formats this endpoint is capable of operating.
This provides a list of media data format names that may be used by an
OpalMediaStream may be created by a connection from this endpoint.
Note that a specific connection may not actually support all of the
media formats returned here, but should return no more.
The default behaviour returns the most basic media formats, PCM audio
and YUV420P video.
*/
virtual OpalMediaFormatList GetMediaFormats() const;
/**Set up a connection to a remote party.
This is called from the OpalManager::MakeConnection() function once
it has determined that this is the endpoint for the protocol.
The general form for this party parameter is:
[proto:][alias@][transport$]address[:port]
where the various fields will have meanings specific to the endpoint
type. For example, with H.323 it could be "h323:Fred@site.com" which
indicates a user Fred at gatekeeper size.com. Whereas for the PSTN
endpoint it could be "pstn:5551234" which is to call 5551234 on the
first available PSTN line.
The proto field is optional when passed to a specific endpoint. If it
is present, however, it must agree with the endpoints protocol name or
false is returned.
This function usually returns almost immediately with the connection
continuing to occur in a new background thread.
If false is returned then the connection could not be established. For
example if a PSTN endpoint is used and the assiciated line is engaged
then it may return immediately. Returning a non-NULL value does not
mean that the connection will succeed, only that an attempt is being
made.
The default behaviour is pure.
*/
virtual PSafePtr<OpalConnection> MakeConnection(
OpalCall & call, ///< Owner of connection
const PString & party, ///< Remote party to call
void * userData = NULL, ///< Arbitrary data to pass to connection
unsigned int options = 0, ///< options to pass to conneciton
OpalConnection::StringOptions * stringOptions = NULL ///< Options to pass to connection
);
//@}
/**@name Customisation call backs */
//@{
/**Find a connection that uses the specified token.
This searches the endpoint for the connection that contains the token
as provided by functions such as MakeConnection(). If not then it
attempts to use the token as a OpalCall token and find a connection
of the same class.
*/
PSafePtr<OpalLocalConnection> GetLocalConnectionWithLock(
const PString & token, ///< Token to identify connection
PSafetyMode mode = PSafeReadWrite ///< Lock mode
) { return GetConnectionWithLockAs<OpalLocalConnection>(token, mode); }
/**Create a connection for the PCSS endpoint.
The default implementation is to create a OpalLocalConnection.
*/
virtual OpalLocalConnection * CreateConnection(
OpalCall & call, ///< Owner of connection
void * userData, ///< Arbitrary data to pass to connection
unsigned options, ///< Option bit mask to pass to connection
OpalConnection::StringOptions * stringOptions ///< Options to pass to connection
);
/**Call back to indicate that remote is ringing.
If false is returned the call is aborted.
The default implementation does nothing.
*/
virtual bool OnOutgoingCall(
const OpalLocalConnection & connection ///< Connection having event
);
/**Call back to indicate that there is an incoming call.
Note this function should not block or it will impede the operation of
the stack.
The default implementation returns true;
@return false is returned the call is aborted with status of EndedByLocalBusy.
*/
virtual bool OnIncomingCall(
OpalLocalConnection & connection ///< Connection having event
);
/**Indicate alerting for the incoming connection.
Returns false if the connection token does not correspond to a valid
connection.
*/
virtual bool AlertingIncomingCall(
const PString & token ///< Token of connection to accept call
);
/**Accept the incoming connection.
Returns false if the connection token does not correspond to a valid
connection.
*/
virtual bool AcceptIncomingCall(
const PString & token ///< Token of connection to accept call
);
/**Reject the incoming connection.
Returns false if the connection token does not correspond to a valid
connection.
*/
virtual bool RejectIncomingCall(
const PString & token, ///< Token of connection to accept call
const OpalConnection::CallEndReason & reason = OpalConnection::EndedByAnswerDenied ///< Reason for rejecting the call
);
/**Call back to indicate that the remote user has indicated something.
If false is returned the call is aborted.
The default implementation does nothing.
*/
virtual bool OnUserInput(
const OpalLocalConnection & connection, ///< Connection having event
const PString & indication ///< User input received
);
/**Call back to get media data for transmission.
If false is returned then OnReadMediaData() is called.
The default implementation returns false.
*/
virtual bool OnReadMediaFrame(
const OpalLocalConnection & connection, ///< Connection for media
const OpalMediaStream & mediaStream, ///< Media stream data is required for
RTP_DataFrame & frame ///< RTP frame for data
);
/**Call back to handle received media data.
If false is returned then OnWriteMediaData() is called.
The default implementation .
The default implementation returns false.
*/
virtual bool OnWriteMediaFrame(
const OpalLocalConnection & connection, ///< Connection for media
const OpalMediaStream & mediaStream, ///< Media stream data is required for
RTP_DataFrame & frame ///< RTP frame for data
);
/**Call back to get media data for transmission.
If false is returned the media stream will be closed.
The default implementation returns false.
*/
virtual bool OnReadMediaData(
const OpalLocalConnection & connection, ///< Connection for media
const OpalMediaStream & mediaStream, ///< Media stream data is required for
void * data, ///< Data to send
PINDEX size, ///< Maximum size of data buffer
PINDEX & length ///< Number of bytes placed in buffer
);
/**Call back to handle received media data.
If false is returned the media stream will be closed.
The default implementation returns false.
*/
virtual bool OnWriteMediaData(
const OpalLocalConnection & connection, ///< Connection for media
const OpalMediaStream & mediaStream, ///< Media stream data is required for
const void * data, ///< Data received
PINDEX length, ///< Amount of data available to write
PINDEX & written ///< Amount of data written
);
/**Indicate that I/O is synchronous.
This indicates that the OnReadMediaXXX and OnWriteMediaXXX functions
will execute blocking to the correct real time synchonisation. So if
for example OnWriteMediaData() is sent 320 bytes of PCM data then it
will, on average, block for 20 milliseconds per call.
If the function returns false, then the system will try and simulate
the correct timing using the operating system sleep function. However
this is not desirable as this function is notoriously inaccurate.
Default returns true.
*/
virtual bool IsSynchronous() const;
/**Indicate OnAlerting() is be deferred or immediate.
*/
bool IsDeferredAlerting() const { return m_deferredAlerting; }
/**Indicate OnAlerting() is be deferred or immediate.
*/
void SetDeferredAlerting(bool defer) { m_deferredAlerting = defer; }
/**Indicate AcceptIncomingCall() execution is be deferred or immediate on OnIncomingCall().
*/
bool IsDeferredAnswer() const { return m_deferredAnswer; }
/**Indicate AcceptIncomingCall() execution is be deferred or immediate on OnIncomingCall().
*/
void SetDeferredAnswer(bool defer) { m_deferredAnswer = defer; }
//@}
protected:
bool m_deferredAlerting;
bool m_deferredAnswer;
private:
P_REMOVE_VIRTUAL(OpalLocalConnection *, CreateConnection(OpalCall &, void *), 0);
};
/** Local connection.
This class represents a connection on the local machine that can receive
media via virtual functions.
*/
class OpalLocalConnection : public OpalConnection
{
PCLASSINFO(OpalLocalConnection, OpalConnection);
public:
/**@name Construction */
//@{
/**Create a new connection.
*/
OpalLocalConnection(
OpalCall & call, ///< Owner call for connection
OpalLocalEndPoint & endpoint, ///< Owner endpoint for connection
void * userData, ///< Arbitrary data to pass to connection
unsigned options, ///< Option bit mask to pass to connection
OpalConnection::StringOptions * stringOptions, ///< Options to pass to connection
char tokenPrefix = 'L' ///< Prefix for token generation
);
/**Destroy connection.
*/
~OpalLocalConnection();
//@}
/**@name Overrides from OpalConnection */
//@{
/**Get indication of connection being to a "network".
This indicates the if the connection may be regarded as a "network"
connection. The distinction is about if there is a concept of a "remote"
party being connected to and is best described by example: sip, h323,
iax and pstn are all "network" connections as they connect to something
"remote". While pc, pots and ivr are not as the entity being connected
to is intrinsically local.
*/
virtual PBoolean IsNetworkConnection() const { return false; }
/**Start an outgoing connection.
This function will initiate the connection to the remote entity, for
example in H.323 it sends a SETUP, in SIP it sends an INVITE etc.
The default behaviour does.
*/
virtual PBoolean SetUpConnection();
/**Indicate to remote endpoint an alert is in progress.
If this is an incoming connection and the AnswerCallResponse is in a
AnswerCallDeferred or AnswerCallPending state, then this function is
used to indicate to that endpoint that an alert is in progress. This is
usually due to another connection which is in the call (the B party)
has received an OnAlerting() indicating that its remote endpoint is
"ringing".
The default behaviour does nothing.
*/
virtual PBoolean SetAlerting(
const PString & calleeName, ///< Name of endpoint being alerted.
PBoolean withMedia ///< Open media with alerting
);
/**Indicate to remote endpoint we are connected.
The default behaviour sets the phase to ConnectedPhase, sets the
connection start time and then checks if there is any media channels
opened and if so, moves on to the established phase, calling
OnEstablished().
In other words, this method is used to handle incoming calls,
and is an indication that we have accepted the incoming call.
*/
virtual PBoolean SetConnected();
/**Open a new media stream.
This will create a media stream of an appropriate subclass as required
by the underlying connection protocol. For instance H.323 would create
an OpalRTPStream.
The sessionID parameter may not be needed by a particular media stream
and may be ignored. In the case of an OpalRTPStream it us used.
Note that media streams may be created internally to the underlying
protocol. This function is not the only way a stream can come into
existance.
The default behaviour is pure.
*/
virtual OpalMediaStream * CreateMediaStream(
const OpalMediaFormat & mediaFormat, ///< Media format for stream
unsigned sessionID, ///< Session number for stream
PBoolean isSource ///< Is a source stream
);
/**Open source or sink media stream for session.
*/
virtual OpalMediaStreamPtr OpenMediaStream(
const OpalMediaFormat & mediaFormat, ///< Media format to open
unsigned sessionID, ///< Session to start stream on
bool isSource ///< Stream is a source/sink
);
/**Send a user input indication to the remote endpoint.
This sends an arbitrary string as a user indication. If DTMF tones in
particular are required to be sent then the SendIndicationTone()
function should be used.
The default behaviour plays the DTMF tones on the line.
*/
virtual PBoolean SendUserInputString(
const PString & value ///< String value of indication
);
//@}
/**@name New operations */
//@{
/**Indicate alerting for the incoming connection.
*/
virtual void AlertingIncoming();
/**Accept the incoming connection.
*/
virtual void AcceptIncoming();
//@}
/**@name Member variable access */
//@{
/// Get user data pointer.
void * GetUserData() const { return userData; }
/// Set user data pointer.
void SetUserData(void * v) { userData = v; }
//@}
protected:
OpalLocalEndPoint & endpoint;
void * userData;
};
/**Local media stream.
This class represents a media stream on the local machine that can receive
media via virtual functions.
*/
class OpalLocalMediaStream : public OpalMediaStream, public OpalMediaStreamPacing
{
PCLASSINFO(OpalLocalMediaStream, OpalMediaStream);
public:
/**@name Construction */
//@{
/**Construct a new media stream for local system.
*/
OpalLocalMediaStream(
OpalLocalConnection & conn, ///< Connection for media stream
const OpalMediaFormat & mediaFormat, ///< Media format for stream
unsigned sessionID, ///< Session number for stream
bool isSource, ///< Is a source stream
bool isSynchronous ///< Can accept data and block accordingly
);
//@}
/**@name Overrides of OpalMediaStream class */
//@{
/**Read an RTP frame of data from the source media stream.
The default behaviour simply calls ReadData() on the data portion of the
RTP_DataFrame and sets the frames timestamp and marker from the internal
member variables of the media stream class.
*/
virtual PBoolean ReadPacket(
RTP_DataFrame & packet
);
/**Write an RTP frame of data to the sink media stream.
The default behaviour simply calls WriteData() on the data portion of the
RTP_DataFrame and and sets the internal timestamp and marker from the
member variables of the media stream class.
*/
virtual PBoolean WritePacket(
RTP_DataFrame & packet
);
/**Read raw media data from the source media stream.
The default behaviour reads from the OpalLine object.
*/
virtual PBoolean ReadData(
BYTE * data, ///< Data buffer to read to
PINDEX size, ///< Size of buffer
PINDEX & length ///< Length of data actually read
);
/**Write raw media data to the sink media stream.
The default behaviour writes to the OpalLine object.
*/
virtual PBoolean WriteData(
const BYTE * data, ///< Data to write
PINDEX length, ///< Length of data to read.
PINDEX & written ///< Length of data actually written
);
/**Indicate if the media stream is synchronous.
Returns true for LID streams.
*/
virtual PBoolean IsSynchronous() const;
//@}
protected:
bool m_isSynchronous;
};
#endif // OPAL_OPAL_LOCALEP_H
// End of File ///////////////////////////////////////////////////////////////
|