OpenMAMA
symbollist.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 MamaSymbolListH__
23 #define MamaSymbolListH__
24 
25 /* *************************************************** */
26 /* Includes. */
27 /* *************************************************** */
28 #include "mama/mama.h"
29 #include <mama/config.h>
30 #include "mama/symbollisttypes.h"
31 
32 #if defined(__cplusplus)
33 extern "C" {
34 #endif
35 
36 /* *************************************************** */
37 /* Type Defines. */
38 /* *************************************************** */
39 
48 typedef mama_status (MAMACALLTYPE *addSymbolCbType) (
49  mamaSymbolListMember symbol,
50  void* closure);
51 
56 typedef void (MAMACALLTYPE *mamaSymbolListIterateCompleteFunc) (
57  mamaSymbolList symbolList,
58  void* closure);
59 
64 typedef void (MAMACALLTYPE *mamaSymbolListIterateMemberFunc) (
65  mamaSymbolList symbolList,
66  mamaSymbolListMember member,
67  void* closure);
68 
77 typedef mama_status (MAMACALLTYPE *removeSymbolCbType) (
78  mamaSymbolListMember symbol,
79  void* closure);
80 
81 /* *************************************************** */
82 /* Public Function Prototypes. */
83 /* *************************************************** */
84 
96 MAMAExpDLL
97 extern mama_status
99  mamaSymbolList symbolList,
100  mamaSymbolListMember member);
101 
113 MAMAExpDLL
114 extern mama_status
116  mamaSymbolList *symbolList);
117 
125 MAMAExpDLL
126 extern mamaSymbolListMember
128  mamaSymbolList symbolList);
129 
140 MAMAExpDLL
141 extern mama_status
143  mamaSymbolList symbolList,
144  int membersToo);
145 
155 MAMAExpDLL
156 extern mama_status
158  mamaSymbolList symbolList);
159 
170 MAMAExpDLL
171 extern mama_status
173  mamaSymbolList symbolList,
174  mamaSymbolListMember member);
175 
186 MAMAExpDLL
187 extern mama_status
189  mamaSymbolList symbolList);
190 
205 MAMAExpDLL
206 extern mama_status
208  const mamaSymbolList symbolList,
209  const char* symbol,
210  const char * source,
211  mamaTransport transport,
212  mamaSymbolListMember* member);
213 
224 MAMAExpDLL
225 extern mama_status
227  const mamaSymbolList symbolList,
228  void** closure);
229 
240 MAMAExpDLL
241 extern mama_status
243  const mamaSymbolList symbolList,
244  unsigned long *size);
245 
259 MAMAExpDLL
260 extern mama_status
262  mamaSymbolList symbolList,
265  void* iterateClosure);
266 
283 MAMAExpDLL
284 extern mama_status
286  mamaSymbolList symbolList,
287  const char* symbol,
288  const char * source,
289  mamaTransport transport,
290  mamaSymbolListMember* member);
291 
302 MAMAExpDLL
304  mamaSymbolList symbolList,
305  mamaSymbolListMember member);
306 
320 MAMAExpDLL
321 extern mama_status
323  mamaSymbolList symbolList,
324  addSymbolCbType addCb);
325 
336 MAMAExpDLL
337 extern mama_status
339  mamaSymbolList symbolList,
340  void* closure);
341 
355 MAMAExpDLL
356 extern mama_status
358  mamaSymbolList symbolList,
359  removeSymbolCbType removeCb);
360 
361 #if defined(__cplusplus)
362 }
363 #endif
364 
365 #endif
366 
mamaSymbolList_setRemoveSymbolHandler
MAMAExpDLL mama_status mamaSymbolList_setRemoveSymbolHandler(mamaSymbolList symbolList, removeSymbolCbType removeCb)
Registers the user defined remove symbol callback with the symbolList.
mama_status
mama_status
Definition: status.h:37
mamaSymbolList_clear
MAMAExpDLL mama_status mamaSymbolList_clear(mamaSymbolList symbolList, int membersToo)
Clear the symbol list.
mamaSymbolList_removeMember
MAMAExpDLL mama_status mamaSymbolList_removeMember(mamaSymbolList symbolList, const char *symbol, const char *source, mamaTransport transport, mamaSymbolListMember *member)
Remove a symbol member from the symbol list.
mamaSymbolList_setClosure
MAMAExpDLL mama_status mamaSymbolList_setClosure(mamaSymbolList symbolList, void *closure)
Set the closure associated with the this symbolList.
mamaSymbolList_addMember
MAMAExpDLL mama_status mamaSymbolList_addMember(mamaSymbolList symbolList, mamaSymbolListMember member)
Add a symbol member to the symbol list, this will cause the add callback to be invoked if it has been...
mamaSymbolList
struct mamaSymbolList_ * mamaSymbolList
Definition: symbollisttypes.h:32
mamaSymbolList_findMember
MAMAExpDLL mama_status mamaSymbolList_findMember(const mamaSymbolList symbolList, const char *symbol, const char *source, mamaTransport transport, mamaSymbolListMember *member)
Find a symbol member in the symbol list.
mamaSymbolListIterateMemberFunc
void(MAMACALLTYPE * mamaSymbolListIterateMemberFunc)(mamaSymbolList symbolList, mamaSymbolListMember member, void *closure)
Function invoked for each member of the symbol list when iterating using mamaSymbolList_iterate().
Definition: symbollist.h:64
mamaSymbolListMember
struct mamaSymbolListMember_ * mamaSymbolListMember
Definition: symbollisttypes.h:33
mamaSymbolList_allocate
MAMAExpDLL mama_status mamaSymbolList_allocate(mamaSymbolList *symbolList)
Allocate and initialize memory for a new symbolList, mamaSymbolList_deallocate should be called on th...
mama.h
mamaSymbolListIterateCompleteFunc
void(MAMACALLTYPE * mamaSymbolListIterateCompleteFunc)(mamaSymbolList symbolList, void *closure)
Function invoked when completing the iteration over the symbol list using mamaSymbolList_iterate().
Definition: symbollist.h:56
mamaSymbolList_deallocate
MAMAExpDLL mama_status mamaSymbolList_deallocate(mamaSymbolList symbolList)
Free a symbol list created by mamaSymbolList_allocate.
symbollisttypes.h
removeSymbolCbType
mama_status(MAMACALLTYPE * removeSymbolCbType)(mamaSymbolListMember symbol, void *closure)
Prototype for remove symbol callback.
Definition: symbollist.h:77
mamaSymbolList_getClosure
MAMAExpDLL mama_status mamaSymbolList_getClosure(const mamaSymbolList symbolList, void **closure)
Get the closure associated with the this symbolList.
mamaTransport
struct mamaTransportImpl_ * mamaTransport
Definition: types.h:98
mamaSymbolList_getSize
MAMAExpDLL mama_status mamaSymbolList_getSize(const mamaSymbolList symbolList, unsigned long *size)
Get the size of the symbolList.
mamaSymbolList_setAddSymbolHandler
MAMAExpDLL mama_status mamaSymbolList_setAddSymbolHandler(mamaSymbolList symbolList, addSymbolCbType addCb)
Registers the user defined add symbol callback with the symbolList.
mamaSymbolList_iterate
MAMAExpDLL mama_status mamaSymbolList_iterate(mamaSymbolList symbolList, mamaSymbolListIterateMemberFunc memberFunc, mamaSymbolListIterateCompleteFunc completeFunc, void *iterateClosure)
Iterate over the symbol list.
mamaSymbolList_removeMemberByRef
MAMAExpDLL mama_status mamaSymbolList_removeMemberByRef(mamaSymbolList symbolList, mamaSymbolListMember member)
Remove a symbol member from the symbol list.
config.h
mamaSymbolList_allocateMember
MAMAExpDLL mamaSymbolListMember mamaSymbolList_allocateMember(mamaSymbolList symbolList)
Allocate a symbolListMember.
mamaSymbolList_deallocateWithMembers
MAMAExpDLL mama_status mamaSymbolList_deallocateWithMembers(mamaSymbolList symbolList)
Free the memory for the symbolList and all members.
addSymbolCbType
mama_status(MAMACALLTYPE * addSymbolCbType)(mamaSymbolListMember symbol, void *closure)
Prototype for add symbol callback.
Definition: symbollist.h:48
mamaSymbolList_deallocateMember
MAMAExpDLL mama_status mamaSymbolList_deallocateMember(mamaSymbolList symbolList, mamaSymbolListMember member)
Deallocate a symbolListMember.


© 2012 Linux Foundation