puzzlebox
Loading...
Searching...
No Matches
Routing

Conditionally use substitute or extend the built-in message handlers. More...

Detailed Description

Functions

bool pb_hook_route_msg (pb_msg_t *msg)
 pb_route_msg() hook
 
bool pb_hook_route_cmd_prop (pb_msg_t *msg)
 pb_route_cmd_prop() hook
 
bool pb_hook_route_cmd_state (pb_msg_t *msg)
 pb_route_cmd_state() hook
 
bool pb_hook_route_cmd_magic (pb_msg_t *msg)
 pb_route_cmd_magic() hook
 

Function Documentation

◆ pb_hook_route_cmd_magic()

bool pb_hook_route_cmd_magic ( pb_msg_t * msg)

The default implementation of this function immediately returns false.

Returns
false if execution should continue to the default handler, or true if it should stop (i.e. the message was handled).
See also
pb_route_msg()
pb_route_cmd_magic()

◆ pb_hook_route_cmd_prop()

bool pb_hook_route_cmd_prop ( pb_msg_t * msg)

The default implementation of this function immediately returns false.

Returns
false if execution should continue to the default handler, or true if it should stop (i.e. the message was handled).
See also
pb_route_msg()
pb_route_cmd_prop()

◆ pb_hook_route_cmd_state()

bool pb_hook_route_cmd_state ( pb_msg_t * msg)

The default implementation of this function immediately returns false.

Returns
false if execution should continue to the default handler, or true if it should stop (i.e. the message was handled).
See also
pb_route_msg()
pb_route_cmd_state()

◆ pb_hook_route_msg()

bool pb_hook_route_msg ( pb_msg_t * msg)

The default implementation of this function immediately returns false.

Returns
false if execution should continue to the default handler, or true if it should stop (i.e. the message was handled).
See also
pb_route_msg()