This file is indexed.

/usr/include/sipxtapi/mp/MpSyncFlowgraphMsg.h is in libsipxtapi-dev 3.3.0~test17-2.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
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
//  
// Copyright (C) 2009 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2009 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$
///////////////////////////////////////////////////////////////////////////////

#ifndef _MpSyncFlowgraphMsg_h_
#define _MpSyncFlowgraphMsg_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "mp/MpFlowGraphMsg.h"
#include "utl/UtlSerialized.h"
#include "os/OsEvent.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

/**
*  @brief Message used to communicate with a flowgraph with ability to wait for
*         command completion and get its result.
*
*  This message does not own the event, thus it should be managed by some
*  outside means. As a special case, you should use pointer to a static OsEvent
*  variable with the great care. In this case you must wait infinitely until
*  event fires - if you do timed wait, you leave an opportunity to leave scope
*  of the event variable before it is fired, thus signal() will be called on
*  the freed stack variable and will lead to segfault. Here is an example:
*  <code>
*     OsEvent doneEvent;
*     MpSyncFlowgraphMsg msg(MpFlowGraphMsg::FLOWGRAPH_GET_LATENCY_FOR_PATH, &doneEvent);
*
*     ...
*
*     // Send the message
*     stat = postMessage(msg);
*     if (stat != OS_SUCCESS)
*     {
*        // handle error
*        ...
*     }
*
*     // Wait for result infinitely.
*     stat = doneEvent.wait(OsTime::OS_INFINITY);
*     if (stat != OS_SUCCESS)
*     {
*        // This mustn't happen, but just in case.
*        ...
*     }
*     
*     // Retrieve result from the event.
*     intptr_t tmp;
*     doneEvent.getUserData(tmp);
*     latency = tmp;
*     doneEvent.getEventData(tmp);
*     stat = (OsStatus)tmp;
*
*     return stat;
*  </code>
*
*  If you need a timed wait on done event, you must allocate event from heap and
*  implement event hand off.
*/
class MpSyncFlowgraphMsg : public MpFlowGraphMsg
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */
///@name Creators
//@{

     /// Constructor
   MpSyncFlowgraphMsg(int msgType, OsEvent *pDoneEvent = NULL)
   : MpFlowGraphMsg(msgType)
   , mpDoneEvent(pDoneEvent)
   {
   };

     /// Copy constructor
   MpSyncFlowgraphMsg(const MpSyncFlowgraphMsg& rMsg)
   : MpFlowGraphMsg(rMsg)
   , mpDoneEvent(rMsg.mpDoneEvent)
   , mData(rMsg.mData)
   {
   };

     /// @copydoc OsMsg::createCopy()
   OsMsg* createCopy() const 
   {
      return new MpSyncFlowgraphMsg(*this);
   }

     /// Destructor
   ~MpSyncFlowgraphMsg() 
   {
   };

//@}

/* ============================ MANIPULATORS ============================== */
///@name Manipulators
//@{

     /// Assignment operator
   inline MpSyncFlowgraphMsg& operator=(const MpSyncFlowgraphMsg& rhs);

//@}

/* ============================ ACCESSORS ================================= */
///@name Accessors
//@{

     /// Get stored data.
   inline UtlSerialized &getData();

     /// Get done-event.
   inline OsEvent *getDoneEvent();

//@}

/* ============================ INQUIRY =================================== */
///@name Inquiry
//@{

//@}

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   OsEvent         *mpDoneEvent; ///< Event to signal when command is finished
                               ///< and provide waiters with the result of
                               ///< operation. Event is not owned by this object.
   UtlSerialized    mData;     ///< Packed data to be passed to the resource,
};

/* ============================ INLINE METHODS ============================ */

MpSyncFlowgraphMsg& MpSyncFlowgraphMsg::operator=(const MpSyncFlowgraphMsg& rhs)
{
   if (this == &rhs)            // handle the assignment to self case
      return *this;

   MpFlowGraphMsg::operator=(rhs);       // assign fields for parent class

   mpDoneEvent = rhs.mpDoneEvent;
   mData       = rhs.mData;

   return *this;
}

UtlSerialized &MpSyncFlowgraphMsg::getData()
{
   return mData;
}

OsEvent *MpSyncFlowgraphMsg::getDoneEvent()
{
   return mpDoneEvent;
}

#endif  // _MpSyncFlowgraphMsg_h_