/usr/include/mama/MamaBasicSubscription.h is in libmama-dev 2.2.2.1-11.1ubuntu1.
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 | /* $Id$
*
* OpenMAMA: The open middleware agnostic messaging API
* Copyright (C) 2011 NYSE Technologies, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef MAMA_BASIC__SUBSCRIPTION_CPP_H__
#define MAMA_BASIC__SUBSCRIPTION_CPP_H__
#include "mama/mama.h"
namespace Wombat
{
class MamaStatus;
class MamaMsg;
class MamaQueue;
class MamaTransport;
class MamaBasicSubscriptionCallback;
struct MamaBasicSubscriptionImpl;
/**
* The <code>MamaBasicSubscription</code> interface represents a
* subscription to a topic with no market data semantics.
*
* @see Mama
* @author Michael Schonberg
* copyright 2003 Wombat Consulting Inc.
*/
class MAMACPPExpDLL MamaBasicSubscription
{
public:
/**
* The destructor will call <code>destroy()</code> if the
* subscription has not already been destroyed.
*/
virtual ~MamaBasicSubscription ();
/**
* Constructor. Call createBasic() to activate the subscription.
*/
MamaBasicSubscription (void);
/**
* Create a basic subscription without market data semantics.
*
* @param transport The transport to use. Must be a basic transport.
* @param queue The queue.
* @param callback The mamaMsgCallbacks structure containing the three
* callback methods.
*
* @param topic The topic.
* @param closure The caller supplied closure.
*
*/
virtual void createBasic (
MamaTransport* transport,
MamaQueue* queue,
MamaBasicSubscriptionCallback* callback,
const char* topic,
void* closure = NULL);
/**
* Destroy the subscription.
* <p>
* Destroys the underlying subscription. The subscription can be recreated
* via a subsequent call to create()
*/
virtual void destroy ();
/**
* This function will destroy the subscription and can be called from
* any thread.
* Note that the subscription will not be fully destroyed until the
* onDestroy callback is received from the MamaBasicSubscriptionCallback
* interface.
* To destroy from the dispatching thread the destroy function should be
* used in preference.
*/
virtual void destroyEx();
/**
* Return whether the subscription is active.
*
* @return whether the subscription is active.
*/
virtual bool isActive (void) const;
/**
* Return the symbol for this subscription.
*
* @return The topic.
*/
virtual const char* getTopic (void) const;
/**
* Return the <code>MamaTransport</code> for this subscription.
* @return the transport.
*/
virtual MamaTransport* getTransport (void) const;
/**
* Return the <code>MamaSubscriptionCallback</code> for this
* subscription.
*
* @return the callback.
*/
virtual MamaBasicSubscriptionCallback* getBasicCallback (void) const;
/**
* Return the <code>MamaQueue</code> for the subscription.
*
* @return the queue.
*/
virtual MamaQueue* getQueue (void) const;
/**
* Set the closure for the subscription.
*
*/
virtual void setClosure (void* closure);
/**
* Return the closure for the subscription.
*
* @return the closure.
*/
virtual void* getClosure (void) const;
/**
* Set the debug level for this subscription.
*
* @param level The new debug level.
*/
virtual void setDebugLevel (MamaLogLevel level);
/**
* Return the debug level for this subscription.
*
* @return the debug level for this subscription.
*/
virtual MamaLogLevel getDebugLevel () const;
/**
* Return whether the debug level for this subscription equals or
* exceeds some level.
*
* @param level The debug level to check.
* @return whether the level equals or exceeds the set level for this
* subscription.
*/
virtual bool checkDebugLevel (MamaLogLevel level) const;
/**
* This function will return the current state of the subscription, this function
* should be used in preference to the mamaSubscription_isActive or mamaSubscription_isValid
* functions.
* This function is thread-safe.
*
* @return mama_status this can be one of the mamaSubscriptionState enumeration values.
*/
virtual mamaSubscriptionState getState(void);
private:
/* Private functions. */
static void MAMACALLTYPE onSubscriptionCreate(mamaSubscription subsc, void *closure);
static void MAMACALLTYPE onSubscriptionDestroy(mamaSubscription subscription, void *closure);
static void MAMACALLTYPE onSubscriptionError(mamaSubscription subsc, mama_status status, void *platformError, const char *subject, void *closure);
static void MAMACALLTYPE onSubscriptionMessage(mamaSubscription subsc, mamaMsg msg, void *closure, void *itemClosure);
// The callback class passed to the create function
MamaBasicSubscriptionCallback *mCallback;
MamaBasicSubscriptionImpl* mImpl;
protected:
// The closure passed to the create function
void *mClosure;
// The queue passed to the create function
MamaQueue *mQueue;
// The underlying C subscription
mamaSubscription mSubscription;
// The transport passed to the create function
MamaTransport *mTransport;
};
} // namespace Wombat
#endif // MAMA_BASIC__SUBSCRIPTION_CPP_H__
|