blast_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.
*/
 
/*
 * blast_service_job.h
 *
 *  Created on: 21 Jan 2016
 *      Author: tyrrells
 */
 
#ifndef BLAST_SERVICE_JOB_H_
#define BLAST_SERVICE_JOB_H_
 
 
#include "blast_service.h"
#include "blast_service_api.h"
#include "service.h"
#include "service_job.h"
 
class BlastTool;
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_BLAST_SERVICE_JOB_TAGS
  #define BLAST_SERVICE_JOB_PREFIX BLAST_SERVICE_API
  #define BLAST_SERVICE_JOB_VAL(x)  = x
#else
  #define BLAST_SERVICE_JOB_PREFIX extern
  #define BLAST_SERVICE_JOB_VAL(x)
#endif
 
#endif
 
BLAST_SERVICE_JOB_PREFIX const char *BSJ_TYPE_S BLAST_SERVICE_JOB_VAL ("blast_service_job");
 
 
typedef struct BLAST_SERVICE_LOCAL BlastServiceJob
{
  ServiceJob bsj_job;
 
  BlastTool *bsj_tool_p;
 
} BlastServiceJob;
 
 
BLAST_SERVICE_PREFIX const char *BSJ_LINKED_SERVICE_DATABASE_S BLAST_SERVICE_VAL ("database");
 
 
BLAST_SERVICE_PREFIX const char *BSJ_LINKED_SERVICE_SCAFFOLD_S BLAST_SERVICE_VAL ("scaffold");
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
BLAST_SERVICE_LOCAL BlastServiceJob *AllocateBlastServiceJobForDatabase (Service *service_p, const DatabaseInfo *db_p, struct BlastServiceData *data_p);
 
 
BLAST_SERVICE_LOCAL BlastServiceJob *AllocateBlastServiceJob (Service *service_p, const char *job_name_s, const char *job_description_s, const char *tool_name_s, BlastServiceData *data_p);
 
 
BLAST_SERVICE_LOCAL void FreeBlastServiceJob (ServiceJob *job_p);
 
 
BLAST_SERVICE_LOCAL char *GetPreviousJobFilename (const BlastServiceData *data_p, const char *job_id_s, const char *suffix_s);
 
 
BLAST_SERVICE_LOCAL BlastServiceJob *GetBlastServiceJobFromJSON (const json_t *blast_job_json_p, BlastServiceData *config_p);
 
 
BLAST_SERVICE_LOCAL json_t *ConvertBlastServiceJobToJSON (BlastServiceJob *job_p, bool omit_results_flag);
 
 
BLAST_SERVICE_LOCAL bool AddErrorToBlastServiceJob (BlastServiceJob *job_p);
 
 
BLAST_SERVICE_LOCAL bool UpdateBlastServiceJob (ServiceJob *job_p);
 
 
BLAST_SERVICE_LOCAL bool ProcessLinkedServiceForBlastServiceJobOutput (Service *service_p, ServiceJob *job_p, LinkedService *linked_service_p);
 
 
BLAST_SERVICE_LOCAL void BlastServiceJobCompleted (ServiceJob *job_p);
 
 
BLAST_SERVICE_LOCAL ServiceJob *CloneBlastServiceJob (const ServiceJob *src_p);
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* BLAST_SERVICE_JOB_H_ */