Declaration of the Handler Chain functions, HandlerChain_SendMessage(), HandlerChain_AddWindow(), HandlerChain_RemoveWindow(), and HandlerChain_ToString(), as used in the HandlerChain Pattern. More...
#include "HandlerChain_Message.h"
Go to the source code of this file.
Macros | |
| #define | __HANDLECHAIN_HANDLERFUNCTIONS_H__ |
Functions | |
| void | HandlerChain_SendMessage (int windowId, Message *message) |
| Send a message to each of the handlers in the list, protected by a multi-threading lock. | |
| bool | HandlerChain_AddWindow (int windowId) |
| Add an instance of a MessageWindow to end of the list of windows, protected by a multi-threading lock. | |
| void | HandlerChain_RemoveWindow (int windowId) |
| Remove an instance of a MessageWindow from the list, protected by a multi-threading lock. | |
| bool | HandlerChain_ToString (DynamicString *output) |
| Convert the Handler Chain to a string, protected by a multi-threading lock. | |
Detailed Description
Declaration of the Handler Chain functions, HandlerChain_SendMessage(), HandlerChain_AddWindow(), HandlerChain_RemoveWindow(), and HandlerChain_ToString(), as used in the HandlerChain Pattern.
Definition in file HandlerChain_HandlerFunctions.h.
Macro Definition Documentation
◆ __HANDLECHAIN_HANDLERFUNCTIONS_H__
| #define __HANDLECHAIN_HANDLERFUNCTIONS_H__ |
Definition at line 10 of file HandlerChain_HandlerFunctions.h.
Function Documentation
◆ HandlerChain_AddWindow()
| bool HandlerChain_AddWindow | ( | int | windowId | ) |
Add an instance of a MessageWindow to end of the list of windows, protected by a multi-threading lock.
If a MessageWindow is already in the list, it is not added again.
- Parameters
-
windowId ID of the MessageWindow to add.
- Returns
- Returns true if the handler chain was successfully added to the list; otherwise, returns false, indicating an out of memory condition (or a NULL argument).
Definition at line 136 of file HandlerChain_HandlerFunctions.c.
References _handleList, _LockMutex(), _UnlockMutex(), UIntArray_AddInt(), and UIntArray_Find().
Referenced by MessageWindow_Create().
◆ HandlerChain_RemoveWindow()
| void HandlerChain_RemoveWindow | ( | int | windowId | ) |
Remove an instance of a MessageWindow from the list, protected by a multi-threading lock.
If the MessageWindow is not in the list, the request to remove is ignored.
- Parameters
-
windowId ID of the MessageWindow to remove.
Definition at line 162 of file HandlerChain_HandlerFunctions.c.
References _handleList, _LockMutex(), _UnlockMutex(), UIntArray_Find(), and UIntArray_RemoveInt().
Referenced by _HandleDestroyMessage().
◆ HandlerChain_SendMessage()
| void HandlerChain_SendMessage | ( | int | windowId, |
| Message * | message | ||
| ) |
Send a message to each of the handlers in the list, protected by a multi-threading lock.
- Parameters
-
windowId ID of window to target message with. -1 to target all windows. message The Message object to send to each handler.
Definition at line 105 of file HandlerChain_HandlerFunctions.c.
References _handleList, _LockMutex(), _UnlockMutex(), UIntArray::data, UIntArray::length, MessageWindow_ProcessMessage(), UIntArray_Clear(), and UIntArray_Copy().
Referenced by _HandleButtonUpMessage(), _HandleChain_DestroyWindows(), _HandleCloseMessage(), and HandlerChain_Exercise().
◆ HandlerChain_ToString()
| bool HandlerChain_ToString | ( | DynamicString * | output | ) |
Convert the Handler Chain to a string, protected by a multi-threading lock.
- Parameters
-
output Returns a string representation of the Handler Chain and all the handlers it contains.
- Returns
- Returns true if the handler chain was successfully converted to a string; otherwise, returns false, indicating an out of memory condition (or a NULL argument).
Definition at line 176 of file HandlerChain_HandlerFunctions.c.
References _handleList, _LockMutex(), _UnlockMutex(), UIntArray::data, DynamicString_Append(), DynamicString_Clear(), UIntArray::length, MessageWindow_ToString(), DynamicString::string, UIntArray_Clear(), and UIntArray_Copy().
Referenced by _ShowHandlerChain().
