service_job.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.
*/
 
/*
 * service_job.h
 *
 *  Created on: 25 Apr 2015
 *      Author: billy
 */
 
#ifndef SERVICE_JOB_H_
#define SERVICE_JOB_H_
 
#include "typedefs.h"
#include "grassroots_service_library.h"
#include "operation.h"
#include "jansson.h"
#include "linked_list.h"
#include "memory_allocations.h"
#include "linked_service.h"
 
 
#include "uuid_defs.h"
 
/* forward declarations */
struct Service;
struct ServiceJob;
struct LinkedService;
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_SERVICE_JOB_TAGS
  #define SERVICE_JOB_PREFIX GRASSROOTS_SERVICE_API
  #define SERVICE_JOB_VAL(x)  = x
#else
  #define SERVICE_JOB_PREFIX extern GRASSROOTS_SERVICE_API
  #define SERVICE_JOB_VAL(x)
#endif
 
#endif
 
 
SERVICE_JOB_PREFIX const char *SJ_DEFAULT_TYPE_S SERVICE_JOB_VAL ("default_service_job");
 
 
typedef struct ServiceJob
{
  struct Service *sj_service_p;
 
  uuid_t sj_id;
 
  enum OperationStatus sj_status;
 
  char *sj_service_name_s;
 
  char *sj_name_s;
 
  char *sj_description_s;
 
  char *sj_url_s;
 
  json_t *sj_result_p;
 
  json_t *sj_metadata_p;
 
  json_t *sj_errors_p;
 
 
  json_t *sj_linked_services_p;
 
 
  bool (*sj_update_fn) (struct ServiceJob *job_p);
 
  void (*sj_free_fn) (struct ServiceJob *job_p);
 
 
 
  bool (*sj_calculate_result_fn) (struct ServiceJob *job_p);
 
 
 
  bool sj_is_updating_flag;
 
 
  char *sj_type_s;
} ServiceJob;
 
 
typedef struct ServiceJobNode
{
  ListItem sjn_node;
 
  ServiceJob *sjn_job_p;
 
} ServiceJobNode;
 
 
typedef struct ServiceJobSet
{
  struct Service *sjs_service_p;
 
  LinkedList *sjs_jobs_p;
 
 
} ServiceJobSet;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_API void FreeServiceJob (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API void FreeBaseServiceJob (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API ServiceJob *AllocateServiceJob (struct Service *service_p, const char *job_name_s, const char *job_description_s, bool (*update_fn) (struct ServiceJob *job_p), bool (*calculate_results_fn) (struct ServiceJob *job_p), void (*free_job_fn) (struct ServiceJob *job_p), const char *job_type_s);
 
 
 
GRASSROOTS_SERVICE_API ServiceJob *CreateAndAddServiceJobToService (struct Service *service_p, const char *job_name_s, const char *job_description_s, bool (*update_fn) (struct ServiceJob *job_p), bool (*calculate_results_fn) (struct ServiceJob *job_p), void (*free_job_fn) (struct ServiceJob *job_p));
 
 
GRASSROOTS_SERVICE_API bool InitServiceJob (ServiceJob *job_p, struct Service *service_p, const char *job_name_s, const char *job_description_s, bool (*update_fn) (struct ServiceJob *job_p), bool (*calculate_results_fn) (struct ServiceJob *job_p), void (*free_job_fn) (struct ServiceJob *job_p), uuid_t *id_p, const char *job_type_s);
 
 
GRASSROOTS_SERVICE_API void ClearServiceJob (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API ServiceJob *CloneServiceJob (const ServiceJob *src_p);
 
 
GRASSROOTS_SERVICE_API bool CopyServiceJob (const ServiceJob *src_p, ServiceJob *dest_p);
 
 
GRASSROOTS_SERVICE_API struct Service *GetServiceFromServiceJob (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API ServiceJobNode *FindServiceJobNodeInServiceJobSet (const ServiceJobSet *job_set_p, const ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API bool IsServiceJobInServiceJobSet (const ServiceJobSet *job_set_p, const ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API ServiceJobNode *FindServiceJobNodeByUUIDInServiceJobSet (const ServiceJobSet *job_set_p, const uuid_t job_id);
 
 
GRASSROOTS_SERVICE_API bool RemoveServiceJobByUUIDFromServiceJobSet (ServiceJobSet *job_set_p, uuid_t job_id);
 
 
GRASSROOTS_SERVICE_API bool RemoveServiceJobFromServiceJobSet (ServiceJobSet *job_set_p, ServiceJob *job_p);
 
 
 
GRASSROOTS_SERVICE_API bool SetServiceJobDescription (ServiceJob *job_p, const char * const description_s);
 
 
 
 
GRASSROOTS_SERVICE_API bool SetServiceJobURL (ServiceJob *job_p, const char * const url_s);
 
 
GRASSROOTS_SERVICE_API bool SetServiceJobName (ServiceJob *job_p, const char * const name_s);
 
 
GRASSROOTS_SERVICE_API ServiceJobSet *AllocateServiceJobSet (struct Service *service_p);
 
 
 
GRASSROOTS_SERVICE_API ServiceJobSet *AllocateSimpleServiceJobSet (struct Service *service_p, const char *job_name_s, const char *job_description_s);
 
 
GRASSROOTS_SERVICE_API void FreeServiceJobSet (ServiceJobSet *job_set_p);
 
 
 
GRASSROOTS_SERVICE_API ServiceJobNode *AllocateServiceJobNode (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API void FreeServiceJobNode (ListItem *service_job_node_p);
 
 
GRASSROOTS_SERVICE_API ServiceJob *GetServiceJobFromServiceJobSetById (const ServiceJobSet *jobs_p, const uuid_t job_id);
 
 
GRASSROOTS_SERVICE_API json_t *GetServiceJobSetAsJSON (const ServiceJobSet *jobs_p, bool omit_results_flag);
 
 
GRASSROOTS_SERVICE_API json_t *GetServiceJobAsJSON (ServiceJob * const job_p, bool omit_results_flag);
 
 
GRASSROOTS_SERVICE_API json_t *GetServiceJobStatusAsJSON (ServiceJob *job_p, bool omit_results_flag);
 
 
GRASSROOTS_SERVICE_API bool ProcessServiceJobSet (ServiceJobSet *jobs_p, json_t *res_p);
 
 
GRASSROOTS_SERVICE_API ServiceJob *CreateServiceJobFromJSON (const json_t *job_json_p, GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_API bool InitServiceJobFromJSON (ServiceJob *job_p, const json_t *json_p, struct Service *service_p, GrassrootsServer *grassroots_p);
 
 
GRASSROOTS_SERVICE_API OperationStatus GetServiceJobStatus (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API OperationStatus GetCachedServiceJobStatus (const ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API const char *GetServiceJobName (const ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API bool CloseServiceJob (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API ServiceJob *GetServiceJobFromServiceJobSet (const ServiceJobSet *jobs_p, const uint32 index);
 
GRASSROOTS_SERVICE_API uint32 GetServiceJobSetSize (const ServiceJobSet * const jobs_p);
 
 
GRASSROOTS_SERVICE_API void ClearServiceJobResults (ServiceJob *job_p, bool free_memory_flag);
 
 
GRASSROOTS_SERVICE_API char *SerialiseServiceJobToJSON (ServiceJob * const job_p, bool omit_results_flag);
 
 
GRASSROOTS_SERVICE_API ServiceJob *CreateServiceJobFromResultsJSON (const json_t *results_p, struct Service *service_p, const char *name_s, const char *description_s, OperationStatus status, const char *job_type_s);
 
 
 
GRASSROOTS_SERVICE_API bool InitServiceJobFromResultsJSON (ServiceJob *job_p, const json_t *results_p, struct Service *service_p, const char *name_s, const char *description_s, OperationStatus status, const char *job_type_s);
 
 
GRASSROOTS_SERVICE_API bool AddParameterErrorMessageToServiceJob (ServiceJob *job_p, const char * const param_s, const ParameterType param_type, const char * const value_s);
 
 
GRASSROOTS_SERVICE_API bool AddGeneralErrorMessageToServiceJob (ServiceJob *job_p, const char * const value_s);
 
 
GRASSROOTS_SERVICE_API bool AddCompoundErrorToServiceJob (ServiceJob *job_p, const char *param_s, const ParameterType param_type, json_t *error_details_p);
 
 
GRASSROOTS_SERVICE_API bool AddTabularParameterErrorMessageToServiceJob (ServiceJob *job_p, const char * const param_s, const ParameterType param_type, const char * const value_s, const uint32 row, const char *column_s);
 
 
GRASSROOTS_SERVICE_API bool AddResultToServiceJob (ServiceJob *job_p, json_t *result_p);
 
 
 
GRASSROOTS_SERVICE_API void SetServiceJobStatus (ServiceJob *job_p, OperationStatus status);
 
 
GRASSROOTS_SERVICE_API void SetServiceJobUpdateFunction (ServiceJob *job_p, bool (*update_fn) (ServiceJob *job_p));
 
 
GRASSROOTS_SERVICE_API void SetServiceJobFreeFunction (ServiceJob *job_p, void (*free_fn) (ServiceJob *job_p));
 
 
 
GRASSROOTS_SERVICE_API void SetServiceJobCalculateResultFunction (ServiceJob *job_p, bool (*calculate_fn) (ServiceJob *job_p));
 
 
 
GRASSROOTS_SERVICE_API bool UpdateServiceJob (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API uint32 GetNumberOfServiceJobResults (const ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API bool ReplaceServiceJobResults (ServiceJob *job_p, json_t *results_p);
 
 
GRASSROOTS_SERVICE_API bool AddLinkedServiceToServiceJob (ServiceJob *job_p, struct LinkedService *linked_service_p);
 
GRASSROOTS_SERVICE_API void ProcessLinkedServices (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API bool CalculateServiceJobResult (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API void SetServiceJobUUID (ServiceJob *job_p, const uuid_t new_job_id);
 
 
 
GRASSROOTS_SERVICE_LOCAL int32 GetNumberOfLiveJobsFromServiceJobSet (const ServiceJobSet *jobs_p);
 
 
 
GRASSROOTS_SERVICE_LOCAL bool GetOperationStatusFromServiceJobJSON (const json_t *value_p, OperationStatus *status_p);
 
 
GRASSROOTS_SERVICE_API void MergeServiceJobStatus (ServiceJob *job_p, OperationStatus status);
 
 
#ifdef __cplusplus
}
#endif
 
 
 
#endif /* SERVICE_JOB_H_ */