/usr/include/mama/publisher.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 | /* $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_PUBLISHER_H__
#define MAMA_PUBLISHER_H__
#if defined( __cplusplus )
extern "C"
{
#endif /* defined( __cplusplus ) */
/**
* Responsible for publishing mama messages.
*/
/**
* Prototype for callback invoked when a message sent with either
* mamaPublisher_sendWithThrottle() or
* mamaPublisher_sendFromInboxWithThrottle() has been sent from
* the throttle queue.
*
* Messages sent on the throttle queue are no longer destroyed by the API. It
* is the responsibility of the application developer to manage the lifecycle
* of any messages sent on the throttle.
*
* @param publisher The publisher object used to send the message.
* @param msg The mamaMsg which has been sent from the throttle queue.
* @param status Whether the message was successfully sent from the
* throttle. A value of MAMA_STATUS_OK indicates that the
* send was successful.
* @param closure User supplied context data.
*/
typedef void (MAMACALLTYPE *mamaThrottledSendCompleteCb) (
mamaPublisher publisher,
mamaMsg msg,
mama_status status,
void* closure);
/**
* Create a mama publisher for the corresponding transport. If the transport
* is a marketdata transport, as opposed to a "basic" transport, the topic
* corresponds to the symbol. For a basic transport, the source and root get
* ignored.
*
* @param result A pointer to hold the resulting mamaPublisher.
* @param tport The transport.
* @param symbol Symbol on which to publish.
* @param source The source for market data publishers. (e.g. source.symbol)
* @param root The root for market data publishers. Used internally.
*/
MAMAExpDLL
extern mama_status
mamaPublisher_create (mamaPublisher* result,
mamaTransport tport,
const char* symbol,
const char* source,
const char* root);
/**
* Send a message from the specified publisher.
*
* @param publisher The publisher from which to send a message.
* @param msg The mamaMsg to send.
*/
MAMAExpDLL
extern mama_status
mamaPublisher_send (mamaPublisher publisher,
mamaMsg msg);
/**
* Send a message with the throttle.
* The lifecycle of the message sent is controlled by the user of the API. The
* callback indicates when the API is no longer using the message and can be
* destroyed/reused by the application.
*
* @param publisher The publish from which to send the throttled message.
* @param msg The mamaMsg to send.
* @param sendCompleteCb Callback invoked once the message has been send on
* the throttle.
* @param closure User supplied data returned in the send complete callback.
*/
MAMAExpDLL
extern mama_status
mamaPublisher_sendWithThrottle (mamaPublisher publisher,
mamaMsg msg,
mamaThrottledSendCompleteCb sendCompleteCb,
void* closure);
/*
* Send a p2p message from the specified inbox using the throttle.
* The lifecycle of the message sent is controlled by the user of the API. The
* callback indicates when the API is no longer using the message and can be
* destroyed/reused by the application.
*
* @param publisher The mamaPublisher from which to send the message.
* @param inbox The mamaInbox which will process any response to the sent message.
* @param msg The mamaMsg to send.
* @param sendCompleteCb The callback which will be invoked when the message
* is sent from the throttle queue.
* @param closure User supplied data returned when the callback is invoked.
*/
MAMAExpDLL
extern mama_status
mamaPublisher_sendFromInboxWithThrottle (mamaPublisher publisher,
mamaInbox inbox,
mamaMsg msg,
mamaThrottledSendCompleteCb sendCompleteCb,
void* closure);
/*
* Send a p2p message from the specified inbox.
*
* @param publisher The mamaPublisher from which to send the message
* @param inbox The mamaInbox which will process any response to the sent
* message.
* @param msg The mamaMsg to send.
*/
MAMAExpDLL
extern mama_status
mamaPublisher_sendFromInbox (mamaPublisher publisher,
mamaInbox inbox,
mamaMsg msg);
/**
* Send a reply in response to a request to an inbox.
*
* @param publisher The mamaPublisher from which to send the response.
* @param request The reply address to which you are responding.
* @param reply The mamaMsg to be sent as the reply.
*
*/
MAMAExpDLL
extern mama_status
mamaPublisher_sendReplyToInboxHandle (mamaPublisher publisher,
mamaMsgReply replyAddress,
mamaMsg reply);
/**
* Send a reply in response to a request to an inbox.
*
* @param publisher The mamaPublisher from which to send the response.
* @param request The mamaMsg to which you are responding.
* @param reply The mamaMsg to be sent as the reply.
*
*/
MAMAExpDLL
extern mama_status
mamaPublisher_sendReplyToInbox (mamaPublisher publisher,
mamaMsg request,
mamaMsg reply);
/**
* Destroy the publisher.
*
* @param publisher The mamaPublisher to destroy.
*/
MAMAExpDLL
extern mama_status
mamaPublisher_destroy (mamaPublisher publisher);
#if defined( __cplusplus )
}
#endif /* defined( __cplusplus ) */
#endif /* MAMA_PUBLISHER_H_*/
|