/usr/include/sipxtapi/os/OsCallback.h is in libsipxtapi-dev 3.3.0~test17-1.
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 | //
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _OsCallback_h_
#define _OsCallback_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <os/OsNotification.h>
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
typedef void (*OsCallbackFunc) (const intptr_t userData, const intptr_t eventData);
// FORWARD DECLARATIONS
//:Callback function that is executed when the event is signaled.
//:Event notification method where a callback function is executed in the
//:Notifier's context when the corresponding event occurs.
// <p><b>Background</b>
// <p>First, a little bit of terminology. The task that wishes to be notified
// when an event occurs is the "Listener" task. The task that signals when
// a given event occurs is the "Notifier" task. A Notifier informs the
// Listener that a given event has occurred by sending an "Event
// Notification".<br><br>
//
// <p><b>Expected Usage</b>
// <p>When the corresponding event occurs, the designated callback routine is
// invoked in the Notifier's task context.
class OsCallback : public OsNotification
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/* ============================ CREATORS ================================== */
OsCallback(const intptr_t userData, const OsCallbackFunc func);
//:Constructor
virtual
~OsCallback();
//:Destructor
/* ============================ MANIPULATORS ============================== */
virtual OsStatus signal(const intptr_t eventData);
//:Signal the occurrence of the event by executing the callback function
// Always return OS_SUCCESS.
/* ============================ ACCESSORS ================================= */
/* ============================ INQUIRY =================================== */
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
OsCallbackFunc mFunc; // routine that will be invoked in the notifier's
// context to signal the event
intptr_t mUserData; // data specified on behalf of the user and
// not otherwise used by this class -- the user
// data is specified as an argument to the class
// constructor
OsCallback(const OsCallback& rOsCallback);
//:Copy constructor (not implemented for this class)
OsCallback& operator=(const OsCallback& rhs);
//:Assignment operator (not implemented for this class)
};
/* ============================ INLINE METHODS ============================ */
#endif // _OsCallback_h_
|