OpenMAMA
source.h
Go to the documentation of this file.
1 /* $Id$
2  *
3  * OpenMAMA: The open middleware agnostic messaging API
4  * Copyright (C) 2011 NYSE Technologies, Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19  * 02110-1301 USA
20  */
21 
22 #ifndef MamaSourceH__
23 #define MamaSourceH__
24 
25 #include "mama/config.h"
26 #include "mama/status.h"
27 #include "mama/sourceman.h"
28 #include "mama/types.h"
29 #include "mama/quality.h"
30 
31 #if defined(__cplusplus)
32 extern "C" {
33 #endif
34 
35 typedef enum mamaSourceState_
36 {
41 
47 MAMAExpDLL
48 extern mama_status
50 
56 MAMAExpDLL
57 extern mama_status
59 
65 MAMAExpDLL
66 extern mama_status
68 
75 MAMAExpDLL
76 extern mama_status
78  const char* id);
79 
87 MAMAExpDLL
88 extern mama_status
90  const char* id);
91 
98 MAMAExpDLL
99 extern mama_status
101  const char* id);
102 
109 MAMAExpDLL
110 extern mama_status
112  mamaQuality quality);
113 
120 MAMAExpDLL
121 extern mama_status
123  mamaSourceState quality);
124 
134 MAMAExpDLL
135 extern mama_status
137  mamaSource parent);
138 
147 MAMAExpDLL
148 extern mama_status
150  const char* symbolNamespace);
151 
160 MAMAExpDLL
161 extern mama_status
163  const char* transportName);
164 
171 MAMAExpDLL
172 extern mama_status
174  mamaTransport transport);
175 
176 
183 MAMAExpDLL
184 extern mama_status
186  mamaSymbology symbology);
193 MAMAExpDLL
194 extern mama_status
196  const char** id);
197 
204 MAMAExpDLL
205 extern mama_status
207  const char** id);
208 
215 MAMAExpDLL
216 extern mama_status
218  const char** id);
219 
226 MAMAExpDLL
227 extern mama_status
229  mamaQuality* quality);
230 
237 MAMAExpDLL
238 extern mama_status
241 
242 /*
243  Get the stringified representation of the source state.
244 */
245 MAMAExpDLL
246 extern const char*
248 
255 MAMAExpDLL
256 extern mama_status
258  mamaSource* parent);
259 
266 MAMAExpDLL
267 extern mama_status
269  const char** symbolNamespace);
270 
278 MAMAExpDLL
279 extern mama_status
281  const char** transportName);
282 
289 MAMAExpDLL
290 extern mama_status
292  mamaTransport* transport);
293 
294 
301 MAMAExpDLL
302 extern mama_status
304  mamaSymbology* symbology);
305 
315 MAMAExpDLL
316 extern mama_status
318  mamaSourceManager* subSourceManager);
319 
320 #if defined(__cplusplus)
321 }
322 #endif
323 
324 #endif
struct mamaSourceManagerImpl_ * mamaSourceManager
Definition: types.h:115
MAMAExpDLL mama_status mamaSource_getSymbology(const mamaSource source, mamaSymbology *symbology)
Get the mamaSymbology associated with this source.
struct mamaSourceImpl_ * mamaSource
Definition: types.h:116
MAMAExpDLL mama_status mamaSource_clear(mamaSource source)
Clear a mamaSource object.
MAMAExpDLL mama_status mamaSource_getTransport(const mamaSource source, mamaTransport *transport)
Get the mamaTransport associated with this source.
MAMAExpDLL mama_status mamaSource_getState(const mamaSource source, mamaSourceState *state)
Get the state of a mamaSource object.
mamaSource source
Definition: sourceman.h:38
MAMAExpDLL mama_status mamaSource_create(mamaSource *source)
Create a mamaSource object.
struct mamaSymbologyImpl_ * mamaSymbology
Definition: types.h:117
MAMAExpDLL mama_status mamaSource_setTransport(mamaSource source, mamaTransport transport)
Associate a mamaTransport object with the source.
MAMAExpDLL mama_status mamaSource_getSymbolNamespace(const mamaSource source, const char **symbolNamespace)
Get the source name for the publisher which this mamaSource represents.
Definition: source.h:37
MAMAExpDLL mama_status mamaSource_setSymbology(mamaSource source, mamaSymbology symbology)
Associate a mamaSymbology object with the source.
const char mamaFtState state
Definition: ft.h:54
Definition: source.h:39
MAMAExpDLL mama_status mamaSource_getTransportName(const mamaSource source, const char **transportName)
Get the name of the mamaTransport on which this source is valid.
MAMAExpDLL mama_status mamaSource_getQuality(const mamaSource source, mamaQuality *quality)
Get the quality of a mamaSource object.
enum mamaSourceState_ mamaSourceState
MAMAExpDLL mama_status mamaSource_setId(mamaSource source, const char *id)
Set the ID of a mamaSource object.
MAMAExpDLL mama_status mamaSource_setParent(mamaSource source, mamaSource parent)
Set the parent for a mamaSource object.
MAMAExpDLL mama_status mamaSource_setSymbolNamespace(mamaSource source, const char *symbolNamespace)
Set the publisher specific source name for this source.
MAMAExpDLL mama_status mamaSource_getSubSourceManager(const mamaSource source, mamaSourceManager *subSourceManager)
A mamaSource can have sub-sources.
MAMAExpDLL const char * mamaSource_getStateAsString(const mamaSource source)
MAMAExpDLL mama_status mamaSource_setMappedId(mamaSource source, const char *id)
Set the mapped ID of a mamaSource object.
MAMAExpDLL mama_status mamaSource_setTransportName(mamaSource source, const char *transportName)
Set the name of the mamaTransport on which this describes a valid source of data. ...
MAMAExpDLL mama_status mamaSource_getDisplayId(const mamaSource source, const char **id)
Get the display ID of a mamaSource object.
MAMAExpDLL mama_status mamaSource_destroy(mamaSource source)
Destroy a mamaSource object.
MAMAExpDLL mama_status mamaSource_getParent(const mamaSource source, mamaSource *parent)
Get the parent source for a mamaSource object.
mamaSourceState_
Definition: source.h:35
MAMAExpDLL mama_status mamaSource_getId(const mamaSource source, const char **id)
Get the ID of a mamaSource object.
mama_status
Definition: status.h:37
MAMAExpDLL mama_status mamaSource_setDisplayId(mamaSource source, const char *id)
Set the display ID of a mamaSource object.
MAMAExpDLL mama_status mamaSource_setState(mamaSource source, mamaSourceState quality)
Set the state of a mamaSource object.
Definition: source.h:38
struct mamaTransportImpl_ * mamaTransport
Definition: types.h:98
MAMAExpDLL mama_status mamaSource_getMappedId(const mamaSource source, const char **id)
Get the mapped ID of a mamaSource object.
enum mamaQuality_ mamaQuality
MAMAExpDLL mama_status mamaSource_setQuality(mamaSource source, mamaQuality quality)
Set the quality of a mamaSource object.


© 2012 Linux Foundation