jobs_manager.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.
*/
 
/*
 * running_services_table.h
 *
 *  Created on: 17 Apr 2015
 *      Author: tyrrells
 */
 
#ifndef JOBS_MANAGER_H
#define JOBS_MANAGER_H
 
#include "hash_table.h"
#include "service.h"
#include "service_job.h"
#include "grassroots_service_manager_library.h"
#include "uuid_defs.h"
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_JOBS_MANAGER_TAGS
  #define JOBS_MANAGER_PREFIX GRASSROOTS_SERVICE_MANAGER_API
  #define JOBS_MANAGER_VAL(x) = x
#else
  #define JOBS_MANAGER_PREFIX extern GRASSROOTS_SERVICE_MANAGER_API
  #define JOBS_MANAGER_VAL(x)
#endif
 
#endif
 
 
 
/* forward declaration */
struct JobsManager;
struct Plugin;
struct GrassrootsServer;
 
 
typedef unsigned char *(*ServiceJobSerialiser) (ServiceJob *job_p, uint32 *length_p);
 
 
typedef ServiceJob *(*ServiceJobDeserialiser) (unsigned char *input_data_p, void *config_p);
 
 
typedef struct JobsManager
{
  struct Plugin *jm_plugin_p;
 
  bool (*jm_add_job_fn) (struct JobsManager *manager_p, uuid_t job_key, ServiceJob *job_p);
 
  ServiceJob *(*jm_get_job_fn) (struct JobsManager *manager_p, const uuid_t key);
 
 
  ServiceJob *(*jm_remove_job_fn) (struct JobsManager *manager_p, const uuid_t key, bool get_job_flag);
 
 
 
  LinkedList *(*jm_get_all_jobs_fn) (struct JobsManager *manager_p);
 
  bool (*jm_delete_manager_fn) (struct JobsManager *manager_p);
 
} JobsManager;
 
 
#ifdef __cplusplus
  extern "C" {
#endif
 
 
 
 
GRASSROOTS_SERVICE_MANAGER_API void InitJobsManager (JobsManager *manager_p,
                      bool (*add_job_fn) (JobsManager *manager_p, uuid_t job_key, ServiceJob *job_p),
                      ServiceJob *(*get_job_fn)  (JobsManager *manager_p, const uuid_t key),
                      ServiceJob *(*remove_job_fn) (JobsManager *manager_p, const uuid_t key, bool get_job_flag),
                      LinkedList *(*get_all_jobs_fn) (struct JobsManager *manager_p),
                      bool (*delete_manager_fn) (struct JobsManager *manager_p));
 
 
 
GRASSROOTS_SERVICE_MANAGER_API bool FreeJobsManager (JobsManager *manager_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API bool AddServiceJobToJobsManager (JobsManager *manager_p, uuid_t job_key, ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API ServiceJob *GetServiceJobFromJobsManager (JobsManager *manager_p, const uuid_t key);
 
 
GRASSROOTS_SERVICE_MANAGER_API ServiceJob *RemoveServiceJobFromJobsManager (JobsManager *manager_p, const uuid_t key, bool get_job_flag);
 
 
GRASSROOTS_SERVICE_MANAGER_API LinkedList *GetAllServiceJobsFromJobsManager (struct JobsManager *manager_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API JobsManager *LoadJobsManager (const char *jobs_manager_s, struct GrassrootsServer *server_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API struct GrassrootsServer *GetGrassrootsServerFromJobsManager (const JobsManager * const manager_p);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* JOBS_MANAGER_H */