Main Page
Data Structures
Files
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Pages
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
{
37
MAMA_SOURCE_STATE_OFF
= 0,
38
MAMA_SOURCE_STATE_OK
= 1,
39
MAMA_SOURCE_STATE_UNKNOWN
= 99
40
}
mamaSourceState
;
41
47
MAMAExpDLL
48
extern
mama_status
49
mamaSource_create
(
mamaSource
*
source
);
50
56
MAMAExpDLL
57
extern
mama_status
58
mamaSource_destroy
(
mamaSource
source
);
59
65
MAMAExpDLL
66
extern
mama_status
67
mamaSource_clear
(
mamaSource
source
);
68
75
MAMAExpDLL
76
extern
mama_status
77
mamaSource_setId
(
mamaSource
source
,
78
const
char
*
id
);
79
87
MAMAExpDLL
88
extern
mama_status
89
mamaSource_setMappedId
(
mamaSource
source
,
90
const
char
*
id
);
91
98
MAMAExpDLL
99
extern
mama_status
100
mamaSource_setDisplayId
(
mamaSource
source
,
101
const
char
*
id
);
102
109
MAMAExpDLL
110
extern
mama_status
111
mamaSource_setQuality
(
mamaSource
source
,
112
mamaQuality
quality);
113
120
MAMAExpDLL
121
extern
mama_status
122
mamaSource_setState
(
mamaSource
source
,
123
mamaSourceState
quality);
124
134
MAMAExpDLL
135
extern
mama_status
136
mamaSource_setParent
(
mamaSource
source
,
137
mamaSource
parent);
138
147
MAMAExpDLL
148
extern
mama_status
149
mamaSource_setSymbolNamespace
(
mamaSource
source
,
150
const
char
* symbolNamespace);
151
160
MAMAExpDLL
161
extern
mama_status
162
mamaSource_setTransportName
(
mamaSource
source
,
163
const
char
* transportName);
164
171
MAMAExpDLL
172
extern
mama_status
173
mamaSource_setTransport
(
mamaSource
source
,
174
mamaTransport
transport);
175
176
183
MAMAExpDLL
184
extern
mama_status
185
mamaSource_setSymbology
(
mamaSource
source
,
186
mamaSymbology
symbology);
193
MAMAExpDLL
194
extern
mama_status
195
mamaSource_getId
(
const
mamaSource
source
,
196
const
char
**
id
);
197
204
MAMAExpDLL
205
extern
mama_status
206
mamaSource_getMappedId
(
const
mamaSource
source
,
207
const
char
**
id
);
208
215
MAMAExpDLL
216
extern
mama_status
217
mamaSource_getDisplayId
(
const
mamaSource
source
,
218
const
char
**
id
);
219
226
MAMAExpDLL
227
extern
mama_status
228
mamaSource_getQuality
(
const
mamaSource
source
,
229
mamaQuality
* quality);
230
237
MAMAExpDLL
238
extern
mama_status
239
mamaSource_getState
(
const
mamaSource
source
,
240
mamaSourceState
*
state
);
241
242
/*
243
Get the stringified representation of the source state.
244
*/
245
MAMAExpDLL
246
extern
const
char
*
247
mamaSource_getStateAsString
(
const
mamaSource
source
);
248
255
MAMAExpDLL
256
extern
mama_status
257
mamaSource_getParent
(
const
mamaSource
source
,
258
mamaSource
* parent);
259
266
MAMAExpDLL
267
extern
mama_status
268
mamaSource_getSymbolNamespace
(
const
mamaSource
source
,
269
const
char
** symbolNamespace);
270
278
MAMAExpDLL
279
extern
mama_status
280
mamaSource_getTransportName
(
const
mamaSource
source
,
281
const
char
** transportName);
282
289
MAMAExpDLL
290
extern
mama_status
291
mamaSource_getTransport
(
const
mamaSource
source
,
292
mamaTransport
* transport);
293
294
301
MAMAExpDLL
302
extern
mama_status
303
mamaSource_getSymbology
(
const
mamaSource
source
,
304
mamaSymbology
* symbology);
305
315
MAMAExpDLL
316
extern
mama_status
317
mamaSource_getSubSourceManager
(
const
mamaSource
source
,
318
mamaSourceManager
* subSourceManager);
319
320
#if defined(__cplusplus)
321
}
322
#endif
323
324
#endif
© 2012 Linux Foundation