operation.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef OPERATION_H
#define OPERATION_H
 
#include "grassroots_util_library.h"
 
#include "jansson.h"
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_OPERATION_CONSTANTS
  #define OPERATION_PREFIX GRASSROOTS_UTIL_API
  #define OPERATION_VAL(x)  = x
#else
  #define OPERATION_PREFIX extern GRASSROOTS_UTIL_API
  #define OPERATION_VAL(x)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
typedef enum Operation {
  OP_NONE = -1,
  
  OP_LIST_ALL_SERVICES,
 
  OP_GET_SCHEMA_VERSION,
  
  OP_LIST_INTERESTED_SERVICES,
  
 
  OP_GET_NAMED_SERVICES,
 
  OP_GET_SERVICE_RESULTS,
 
  OP_GET_RESOURCE,
 
  OP_SERVER_STATUS,
 
 
  OP_GET_SERVICE_INFO,
 
  OP_NUM_OPERATIONS
} Operation;
 
 
 
typedef enum OperationStatus
{
  OS_LOWER_LIMIT = -4,
  OS_FAILED = -3,
  OS_FAILED_TO_START = -2,
  OS_ERROR = -1,
  OS_IDLE = 0,
  OS_PENDING,
  OS_STARTED,
  OS_FINISHED,
  OS_PARTIALLY_SUCCEEDED,
  OS_SUCCEEDED,
  OS_CLEANED_UP,
  OS_UPPER_LIMIT,
  OS_NUM_STATUSES = OS_UPPER_LIMIT - OS_LOWER_LIMIT + 1
} OperationStatus;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_UTIL_API const char *GetOperationAsString (const Operation op);
 
 
GRASSROOTS_UTIL_API Operation GetOperationFromString (const char *op_s);
 
 
GRASSROOTS_UTIL_API const char *GetOperationStatusAsString (const OperationStatus status);
 
 
GRASSROOTS_UTIL_API OperationStatus GetOperationStatusFromString (const char *status_s);
 
 
 
GRASSROOTS_UTIL_API Operation GetOperationFromJSON (const json_t *ops_p);
 
#ifdef __cplusplus
}
#endif
 
 
 
 
 
#endif    /* #ifndef OPERATION_H */