service_job.h File Reference

#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"

Include dependency graph for service_job.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ServiceJob
	A datatype to represent a running task. More...
struct	ServiceJobNode
	A datatype used to store a ServiceJob within a ServceJobSet using a LinkedList. More...
struct	ServiceJobSet
	A datatype to represent a collection of ServiceJobs. More...

Functions
bool	IsServiceJobInServiceJobSet (const ServiceJobSet *job_set_p, const ServiceJob *job_p)
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)
void	MergeServiceJobStatus (ServiceJob *job_p, OperationStatus status)
	For a given ServiceJob that is running multiple tasks, update its status to reflect the given status from a task. More...

Variables
const SERVICE_JOB_PREFIX char *	SJ_DEFAULT_TYPE_S = "default_service_job"
	The default type id for ServiceJobs. More...

Function Documentation

IsServiceJobInServiceJobSet()

bool IsServiceJobInServiceJobSet	(	const ServiceJobSet *	job_set_p,
		const ServiceJob *	job_p
	)

AddTabularParameterErrorMessageToServiceJob()

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
	)

MergeServiceJobStatus()

void MergeServiceJobStatus	(	ServiceJob *	job_p,
		OperationStatus	status
	)

For a given ServiceJob that is running multiple tasks, update its status to reflect the given status from a task.

Parameters

job_p	The ServiceJob to update.
status	The OperationStatus from one of the tasks that the ServiceJob is running.

Variable Documentation

SJ_DEFAULT_TYPE_S

const SERVICE_JOB_PREFIX char* SJ_DEFAULT_TYPE_S = "default_service_job"

The default type id for ServiceJobs.