enum ugcs::vsm::Request_container::Request::Status

Overview

Request processing status which is returned by the handler or set internally. More…

#include <request_container.h>

enum Status
{
    PENDING,
    CANCELLATION_PENDING,
    CANCELING,
    PROCESSING,
    ABORT_PENDING,
    ABORTED,
    RESULT_CODES,
    OK                   = RESULT_CODES,
    CANCELED,
};

Detailed Documentation

Request processing status which is returned by the handler or set internally.

Enum Values

PENDING

Request is currently pending for processing.

Should never be returned from handlers.

CANCELLATION_PENDING

Request is not yet taken from processor input queue and Cancel() method was called.

CANCELING

Request was taken from processor input queue in CANCELLATION_PENDING state.

PROCESSING

Request processing handler was called and request is being processed.

Should never be returned from the handler.

ABORT_PENDING

Processing was aborted by calling Abort() method and request is submitted to the completion context for a completion handler release to be made.

This is necessary to safely release the completion handler which might induce side effects potentially blocking the Abort() method caller and also to make sure that possible side effects are happening in a user provided context and not in the context of Abort() method caller.

ABORTED

Processing was aborted by calling Abort() method and full cleanup is made.

RESULT_CODES

Result codes passed to Complete() method should start from this value.

OK

Request successfully processed.

CANCELED

Request was canceled.