Class: UserMessageEndpoint

base.UserMessageEndpoint()

This class provides a interface to transition processing for requests (JSON) being delivered by backend services implemented as applications of the message-relay-services module.

Constructor

new UserMessageEndpoint()

Source:

Methods

(async) app_message_handler(msg_obj) → {object}

This method is the override of the app_message_handler defined in the super class ServeMessageEndpoint.

This message handler implements the responses to _tx_ops 'G' (get) and 'S' (set). A 'G' message that is properly setup will result in a call to the mime handler that had to be set by the application. A 'S' message that is properly setup will result in a call to the transtion handler that had to be set by the application.

In most cases, it can be expected that the methods found in contractuals will be the handlers that are set to the parameters of this class.

Parameters:
Name Type Description
msg_obj object
Source:
Returns:
Type
object

set_mime_handler(handler)

This method gives the caller the opportunity to set the handler for handling mime data requests. (similar to GET methods)

Parameters:
Name Type Description
handler function
Source:

set_transition_handler(handler)

This method gives the caller the opportunity to set the handler for handling transtions (similar to POST methods)

Parameters:
Name Type Description
handler function
Source: