webcli2 0.0.2

Tool to build CLI like web application

Index

• Concepts
  • Async Action

Concepts

Async Action

An async action, like the name implies, prepresent an async action.

• When an async action is created, request field stores the context on what is action is about. It is a JSON object.
• When an async action is completed -- either successfully or failed, the response field store the action result. It is a JSON object
• Once an async 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

CLIHandler

Name	Async	Description
async_start_async_action	YES	Create an async action. It returns a tuple of status and async action being created. status type is AsyncActionOpStatus. If async action is created successfully, status will be AsyncActionOpStatus.OK, and an async action will be returned, the returned async action has already been saved to database. CLIHandler rely on a list of customer defined handlers to handle the request. handler's can_handle method looks at the action's request and judge if it can handle it or not. Once an async action is created, the handler's handle method has been scheduled in a threadpool. The handler's handle method is suppose to take care of the execution of the async action Here is a list of possible status based on status Status Reason OK The async action has been created, the AsyncAction 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 async actions. NO_HANDLER Cannot find a handler that can handle this async action. You need to make sure when you create CLIHandler, action_handlers is set properly DB_FAILED Cannot save the async action to database, probably check your DB configuration and connectivity
async_update_progress_async_action	YES	Update an async ation's progress, wake up all monitoring client against this async action. Here is a list of possible status based on status Status Reason OK The async action has been updated, all monitoring client against this async action has been woken up NOT_FOUND The async action is not found based on the action ID caller provided. ACTION_COMPLETED The async 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_async_action	YES	Complete an async ation and set it's result, wake up all monitoring client against this async action. Here is a list of possible status based on status Status Reason OK The async action has been completed, all monitoring client against this async action has been woken up NOT_FOUND The async action is not found based on the action ID caller provided. ACTION_COMPLETED The async action has already been completed DB_FAILED Cannot save the progress for the action to database, probably check your DB configuration and connectivity