remote_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.
*/
 
/*
 * remote_service_job.h
 *
 *  Created on: 14 Feb 2016
 *      Author: billy
 */
 
#ifndef SERVICES_LIB_INCLUDE_REMOTE_SERVICE_JOB_H_
#define SERVICES_LIB_INCLUDE_REMOTE_SERVICE_JOB_H_
 
#include "jansson.h"
 
#include "service_job.h"
#include "grassroots_service_library.h"
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_REMOTE_SERVICE_JOB_TAGS
  #define REMOTE_SERVICE_JOB_PREFIX GRASSROOTS_SERVICE_API
  #define REMOTE_SERVICE_JOB_VAL(x) = x
#else
  #define REMOTE_SERVICE_JOB_PREFIX extern GRASSROOTS_SERVICE_API
  #define REMOTE_SERVICE_JOB_VAL(x)
#endif
 
#endif
 
REMOTE_SERVICE_JOB_PREFIX const char * const RSJ_TYPE_S REMOTE_SERVICE_JOB_VAL ("remote_service_job");
 
 
typedef struct RemoteServiceJob
{
  ServiceJob rsj_job;
 
  char *rsj_uri_s;
 
  char *rsj_service_name_s;
 
  uuid_t rsj_remote_job_id;
 
} RemoteServiceJob;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_API RemoteServiceJob *AllocateRemoteServiceJob (struct Service *service_p, const char *job_name_s, const char *job_description_s, const char *remote_service_s, const char *remote_uri_s, uuid_t remote_job_id);
 
 
GRASSROOTS_SERVICE_API void FreeRemoteServiceJob (ServiceJob *job_p);
 
 
GRASSROOTS_SERVICE_API RemoteServiceJob *CreateRemoteServiceJobFromResultsJSON (const char *remote_service_s, const char *remote_uri_s, const uuid_t remote_job_id, const json_t *results_p, struct Service *service_p, const char *job_name_s, const char *job_description_s, OperationStatus status);
 
 
GRASSROOTS_SERVICE_API bool IsRemoteServiceJobJSON (const json_t *job_json_p);
 
 
 
GRASSROOTS_SERVICE_API RemoteServiceJob *GetRemoteServiceJobFromJSON (const json_t *job_json_p, struct Service *service_p, GrassrootsServer *grassroots_p);
 
 
 
GRASSROOTS_SERVICE_API json_t *GetRemoteServiceJobAsJSON (RemoteServiceJob *job_p, bool omit_results_flag);
 
 
GRASSROOTS_SERVICE_API bool SetRemoteServiceJobDetails (RemoteServiceJob *remote_job_p, const char *remote_service_s, const char *remote_uri_s, const uuid_t remote_job_id);
 
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* SERVICES_LIB_INCLUDE_REMOTE_SERVICE_JOB_H_ */