/usr/include/sipxtapi/os/OsRpcMsg.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 | //
// 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 _OsRpcMsg_h_
#define _OsRpcMsg_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsMsg.h"
#include "os/OsMsgQ.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class OsEvent;
//:Message object used for synchronous (RPC-style) inter-task communication
// RPC inter-task communication works as follows:
// <p>The client task sends an RPC message to the server task. The RPC message
// includes a pointer to an OsEvent object. After sending the message, the
// client either polls or blocks while waiting for the completion event to
// be signaled. <p>When the server finishes the requested operation, it uses
// the OsEvent to specify an integer result and to signal that the operation
// has completed.
class OsRpcMsg : public OsMsg
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
enum OsRpcMsgType
{
REQUEST // message from client to server
};
//!enumcode: Request - Message from client to server
/* ============================ CREATORS ================================== */
OsRpcMsg(const unsigned char msgType, const unsigned char msgSubType,
const OsEvent& rEvent);
//:Constructor
OsRpcMsg(const OsRpcMsg& rOsRpcMsg);
//:Copy constructor
virtual OsMsg* createCopy(void) const;
//:Create a copy of this msg object (which may be of a derived type)
virtual
~OsRpcMsg();
//:Destructor
/* ============================ MANIPULATORS ============================== */
OsRpcMsg& operator=(const OsRpcMsg& rhs);
//:Assignment operator
/* ============================ ACCESSORS ================================= */
virtual int getMsgSize(void) const;
//:Return the size of the message in bytes
// This is a virtual method so that it will return the accurate size for
// the message object even if that object has been upcast to the type of
// an ancestor class.
virtual OsEvent* getEvent(void) const;
//:Return the pointer to the OsEvent object used to signal completion
/* ============================ INQUIRY =================================== */
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
OsEvent* mpEvent; // pointer to the OsEvent used to signal completion
};
/* ============================ INLINE METHODS ============================ */
#endif // _OsRpcMsg_h_
|