webcli2 0.0.8

Tool to build CLI like web application

Index

• Concepts
  • Action
• APIs
  • ActionHandler
  • CLIHandler

Concepts

Action

Represent an action:

• When an action is created, request field stores the context on what is action is about. It is a JSON object.
• When an action is completed -- either successfully or failed, the response field store the action result. It is a JSON object
• Once an action is created, before it is completed, you can update the progress information, it is stored in progress field. It is a JSON field.

APIs

ActionHandler

• The can_handler method tells if a handler can handle an action or not
• The handle method actually handles the action

CLIHandler

Name	Async	Description
async_start_action	YES	Create an action. It returns a tuple of status and action being created. If action is created successfully, status will be CLIHandlerStatus.OK, and the newly created action will be returned, the returned action has already been saved to database. CLIHandler will find the first action handler which can handle the action to handler it, or it will fail with NO_HANDLER. Once an action is created, the handler's handle method has been scheduled in a threadpool. The action handler's handle method is suppose to take care of the execution of the action Here is a list of possible status based on status Status Reason OK The action has been created, the Action object is returned. The customer action handler's handle method has been scheduled in a thread pool SHUTDOWN_IN_PROGRESS This means the CLIHandler is in the progress of shutdown and does not serve creating new actions. NO_HANDLER Cannot find a handler that can handle this action. You need to make sure when you create CLIHandler, action_handlers is set properly DB_FAILED Cannot save the action to database, probably check your DB configuration and connectivity
async_update_action	YES	Update an ation's progress, wake up all monitoring client against this action. Here is a list of possible status based on status Status Reason OK The action has been updated, all monitoring client against this action has been woken up NOT_FOUND The action is not found based on the action ID caller provided. ACTION_COMPLETED The action has already been completed DB_FAILED Cannot save the progress for the action to database, probably check your DB configuration and connectivity
async_complete_action	YES	Complete an ation and set it's result, wake up all monitoring client against this action. Here is a list of possible status based on status Status Reason OK The action has been completed, all monitoring client against this action has been woken up NOT_FOUND The action is not found based on the action ID caller provided. ACTION_COMPLETED The action has already been completed DB_FAILED Cannot save the progress for the action to database, probably check your DB configuration and connectivity
async_wait_for_action_update	YES	wait for an action to be updated or completed Here is a list of possible status based on status Status Reason OK The action has been updated or completed NOT_FOUND The action is not found based on the action ID caller provided. ACTION_COMPLETED The action has already been completed TIMEDOUT The action has not been updated or completed within the timeout caller specified
start_action	No	non-async version of async_start_action
update_action	No	non-async version of async_update_action
complete_action	No	non-async version of async_complete_action