| | 26 | ===== Sending a message ===== |
| | 27 | All modules inherit the sendMessage(message) method from the base class. |
| | 28 | |
| | 29 | ===== Handling a message ===== |
| | 30 | If a module receives a message, its handleMessage(message, type, args) method is called |
| | 31 | |
| | 32 | ===== Message syntax ===== |
| | 33 | [prefix:]module_name:message[:optional_payload] |
| | 34 | ====== Plain messages ====== |
| | 35 | No prefix. |
| | 36 | |
| | 37 | ''Example:'' |
| | 38 | |
| | 39 | {{{ |
| | 40 | menu:reload |
| | 41 | }}} |
| | 42 | Is handled by the "menu" module (mod_menu.py). |
| | 43 | message = "reload"[[br]] |
| | 44 | type = None[[br]] |
| | 45 | args = None |
| | 46 | |
| | 47 | ====== Message string ====== |
| | 48 | Has the '''ms''' prefix. |
| | 49 | |
| | 50 | ''Example:'' |
| | 51 | |
| | 52 | {{{ |
| | 53 | ms:route:reroute:fromStart |
| | 54 | }}} |
| | 55 | Is handled the "reoute" module (mod_menu.py). |
| | 56 | message = "reroute"[[br]] |
| | 57 | type = "ms"[[br]] |
| | 58 | args = "fromStart" |
| | 59 | |
| | 60 | ====== Message list ====== |
| | 61 | Has the '''ml''' prefix. |
| | 62 | ====== Message dict ====== |
| | 63 | Has the '''md''' prefix. |
| | 64 | |