/usr/include/sipxtapi/ptapi/PtEventMask.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 95 96 97 98 99 | //
// 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 _PtEventMask_h_
#define _PtEventMask_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "ptapi/PtEvent.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
//:The PtEventMask is used to filter events which get passed to a
//:PtEventListener.
// To provide finer granularity on the control of events that get passed to
// a listener, the PtEventMask may be used to define the specific events
// that are to be passed. The PtEventMask may be used only to reduce the
// event types that a listener will receive. The full set of events
// a listener may receive is defined by the derived listener class. Reducing
// the events that a listener is interested in is a useful means of optimizing
// the performance of the Pingtel system. Due to the distributed nature
// of the Pingtel system, reducing the number of unnecessary events that
// get sent results in less network latency and traffic.
class PtEventMask
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/* ============================ CREATORS ================================== */
PtEventMask();
//:Default constructor
PtEventMask(const PtEventMask& rPtEventMask);
//:Copy constructor
virtual
~PtEventMask();
//:Destructor
/* ============================ MANIPULATORS ============================== */
PtEventMask& operator=(const PtEventMask& rhs);
//:Assignment operator
/* ============================ ACCESSORS ================================= */
PtStatus setEvents(PtEvent::PtEventId events[], int numEvents);
//:Sets the events of interest for this mask
//!param: (in) events - Array of event ids of interest
//!param: (in) numEvents - The number of event ids in the <i>events</i> array
//!retcode: PT_SUCCESS - Success
//!retcode: PT_INVALID_ARGUMENT - An invalid event id was contained in <i>events</i>
PtStatus addEvents(PtEvent::PtEventId events[], int numEvents);
//:Adds events of interest to this mask (Union operation)
//!param: (in) events - Array of event ids of interest
//!param: (in) numEvents - The number of event ids in the <i>events</i> array
//!retcode: PT_SUCCESS - Success
//!retcode: PT_INVALID_ARGUMENT - An invalid event id was contained in <i>events</i>
PtStatus addEvents(PtEventMask& rMask);
//:Adds events of interest to this mask (Union operation)
//!param: (in) rMask - A PtEventMask containing the set of event ids to be added to this mask's event ids.
//!retcode: PT_SUCCESS - Success
/* ============================ INQUIRY =================================== */
PtBoolean isEventEnabled(PtEvent::PtEventId eventId);
//:Inquires if the given event type is of interest to this listener
//!param: (in) eventId - The event id corresponding to the event type
//!retcode: TRUE - If the given event type is of interest to this listener
//!retcode: FALSE - If the given event type is NOT of interest to this listener
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
};
/* ============================ INLINE METHODS ============================ */
#endif // _PtEventMask_h_
|