Go to the source code of this file.
Typedefs | |
typedef void * | closure |
typedef mamaSymbolListMember | member |
Functions | |
typedef | mama_status (MAMACALLTYPE *addSymbolCbType)(mamaSymbolListMember symbol |
Prototype for add symbol callback. More... | |
typedef | void (MAMACALLTYPE *mamaSymbolListIterateCompleteFunc)(mamaSymbolList symbolList |
Function invoked when completing the iteration over the symbol list using mamaSymbolList_iterate(). More... | |
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 installed. More... | |
MAMAExpDLL mama_status | mamaSymbolList_allocate (mamaSymbolList *symbolList) |
Allocate and initialize memory for a new symbolList, mamaSymbolList_deallocate should be called on the returned symbol list. More... | |
MAMAExpDLL mamaSymbolListMember | mamaSymbolList_allocateMember (mamaSymbolList symbolList) |
Allocate a symbolListMember. More... | |
MAMAExpDLL mama_status | mamaSymbolList_clear (mamaSymbolList symbolList, int membersToo) |
Clear the symbol list. More... | |
MAMAExpDLL mama_status | mamaSymbolList_deallocate (mamaSymbolList symbolList) |
Free a symbol list created by mamaSymbolList_allocate. More... | |
MAMAExpDLL mama_status | mamaSymbolList_deallocateMember (mamaSymbolList symbolList, mamaSymbolListMember member) |
Deallocate a symbolListMember. More... | |
MAMAExpDLL mama_status | mamaSymbolList_deallocateWithMembers (mamaSymbolList symbolList) |
Free the memory for the symbolList and all members. More... | |
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. More... | |
MAMAExpDLL mama_status | mamaSymbolList_getClosure (const mamaSymbolList symbolList, void **closure) |
Get the closure associated with the this symbolList. More... | |
MAMAExpDLL mama_status | mamaSymbolList_getSize (const mamaSymbolList symbolList, unsigned long *size) |
Get the size of the symbolList. More... | |
MAMAExpDLL mama_status | mamaSymbolList_iterate (mamaSymbolList symbolList, mamaSymbolListIterateMemberFunc memberFunc, mamaSymbolListIterateCompleteFunc completeFunc, void *iterateClosure) |
Iterate over the symbol list. More... | |
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. More... | |
MAMAExpDLL mama_status | mamaSymbolList_removeMemberByRef (mamaSymbolList symbolList, mamaSymbolListMember member) |
Remove a symbol member from the symbol list. More... | |
MAMAExpDLL mama_status | mamaSymbolList_setAddSymbolHandler (mamaSymbolList symbolList, addSymbolCbType addCb) |
Registers the user defined add symbol callback with the symbolList. More... | |
MAMAExpDLL mama_status | mamaSymbolList_setClosure (mamaSymbolList symbolList, void *closure) |
Set the closure associated with the this symbolList. More... | |
MAMAExpDLL mama_status | mamaSymbolList_setRemoveSymbolHandler (mamaSymbolList symbolList, removeSymbolCbType removeCb) |
Registers the user defined remove symbol callback with the symbolList. More... | |
typedef mamaSymbolListMember member |
typedef mama_status | ( | MAMACALLTYPE * | removeSymbolCbType) |
Prototype for add symbol callback.
Prototype for remove symbol callback.
The registered add symbol callback is executed for each symbol added to the symbol list.
symbol | The symbol to be added to the list |
userData | User-data to be associated with symbol |
The registered remove symbol callback is executed just prior to a symbol being removed from the symbol list.
symbol | The symbol to be removed from the list |
userData | User-data previously associated with symbol |
typedef void | ( | MAMACALLTYPE * | mamaSymbolListIterateCompleteFunc) |
Function invoked when completing the iteration over the symbol list using mamaSymbolList_iterate().
Function invoked for each member of the symbol list when iterating using mamaSymbolList_iterate().
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 installed.
[in] | symbolList | The symbolList. |
[in] | member | The symbol member. |
MAMAExpDLL mama_status mamaSymbolList_allocate | ( | mamaSymbolList * | symbolList) |
Allocate and initialize memory for a new symbolList, mamaSymbolList_deallocate should be called on the returned symbol list.
[out] | symbolList | The address of the allocated symbolList. |
MAMAExpDLL mamaSymbolListMember mamaSymbolList_allocateMember | ( | mamaSymbolList | symbolList) |
Allocate a symbolListMember.
[in] | symbolList | The symbolList the member to be allocated in. |
MAMAExpDLL mama_status mamaSymbolList_clear | ( | mamaSymbolList | symbolList, |
int | membersToo | ||
) |
Clear the symbol list.
[in] | symbolList | The symbolList. |
[in] | membersToo | Whether to also clear all members of the list. |
MAMAExpDLL mama_status mamaSymbolList_deallocate | ( | mamaSymbolList | symbolList) |
Free a symbol list created by mamaSymbolList_allocate.
[in] | symbolList | The symbolList to be deallocated. |
MAMAExpDLL mama_status mamaSymbolList_deallocateMember | ( | mamaSymbolList | symbolList, |
mamaSymbolListMember | member | ||
) |
Deallocate a symbolListMember.
[in] | symbolList | The symbolList the member belongs to. |
[in] | member | The member of the list to deallocate. |
MAMAExpDLL mama_status mamaSymbolList_deallocateWithMembers | ( | mamaSymbolList | symbolList) |
Free the memory for the symbolList and all members.
symbolList | The symbolList to be deallocated. |
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.
[in] | symbolList | The symbolList. |
[in] | symbol | The name of the symbol to find. |
[in] | source | The source of the symbol to find. |
[in] | transport | The tport of the symbol to find. |
[out] | member | The return symbol member (set to NULL if not found). |
MAMAExpDLL mama_status mamaSymbolList_getClosure | ( | const mamaSymbolList | symbolList, |
void ** | closure | ||
) |
Get the closure associated with the this symbolList.
[in] | symbolList | The symbolList. |
[out] | closure | The closure |
MAMAExpDLL mama_status mamaSymbolList_getSize | ( | const mamaSymbolList | symbolList, |
unsigned long * | size | ||
) |
Get the size of the symbolList.
[in] | symbolList | The symbolList. |
[in] | size | The size |
MAMAExpDLL mama_status mamaSymbolList_iterate | ( | mamaSymbolList | symbolList, |
mamaSymbolListIterateMemberFunc | memberFunc, | ||
mamaSymbolListIterateCompleteFunc | completeFunc, | ||
void * | iterateClosure | ||
) |
Iterate over the symbol list.
The "handler" function will be invoked for each
[in] | symbolList | The symbolList. |
[in] | memberFunc | The function invoked for each symbol list member. |
[in] | completeFunc | The function invoked upon completion. |
[in] | iterateClosure | The closure passed to each callback |
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.
[in] | symbolList | The symbolList. |
[in] | symbol | The name of the symbol to be removed. |
[in] | source | The source of the symbol to be removed. |
[in] | transport | The tport of the symbol to be removed. |
[out] | member | The return symbol member (set to NULL if not found). Note that this will be freed by the symbol list and should be used for reference only. |
MAMAExpDLL mama_status mamaSymbolList_removeMemberByRef | ( | mamaSymbolList | symbolList, |
mamaSymbolListMember | member | ||
) |
Remove a symbol member from the symbol list.
symbolList | The symbolList. |
member | The symbol to be removed. |
MAMAExpDLL mama_status mamaSymbolList_setAddSymbolHandler | ( | mamaSymbolList | symbolList, |
addSymbolCbType | addCb | ||
) |
Registers the user defined add symbol callback with the symbolList.
The registered callback will get called each time a symbol is added to the symbol list.
[in] | symbolList | The symbolList. |
[in] | addCb | Pointer to the user defined callback. Must conform to function prototype addSymbolCbType . |
MAMAExpDLL mama_status mamaSymbolList_setClosure | ( | mamaSymbolList | symbolList, |
void * | closure | ||
) |
Set the closure associated with the this symbolList.
[in] | symbolList | The symbolList. |
[in] | closure | The closure |
MAMAExpDLL mama_status mamaSymbolList_setRemoveSymbolHandler | ( | mamaSymbolList | symbolList, |
removeSymbolCbType | removeCb | ||
) |
Registers the user defined remove symbol callback with the symbolList.
The registered callback will get called each time a symbol is deleted from the symbol list.
[in] | symbolList | The symbolList. |
[in] | removeCb | Pointer to the user defined callback. Must conform to function prototype removeSymbolCbType . |