lib_jobs.h File Reference

AWS Jobs library header file. More...

Go to the source code of this file.

Data Structures
struct	job_st
	Represents the structure used to handle AWS Jobs. More...

Typedefs
typedef jobsStatus_et(*	jobCallBack_t) (job_st *ps_job)
	Job callback handler type. The application should provide this handler to perform actions based on the Job created on AWS IoT.

Enumerations
enum	jobsStatus_et

Functions
bool	JOBS_register (char *pJobActionStr, uint8_t timeoutMin_u8, jobCallBack_t callbackHandler)
	Register an AWS IoT Job handler. More...
void	JOBS_updateStatus (char *pJobIdStr, jobsStatus_et status_e)
	Update the status of Job to AWS IoT. More...

Detailed Description

AWS Jobs library header file.

Enumeration Type Documentation

jobsStatus_et

enum jobsStatus_et

An enum to represent all possible Status of AWS Jobs.

Function Documentation

JOBS_register()

bool JOBS_register	(	char *	pJobActionStr,
		uint8_t	timeoutMin_u8,
		jobCallBack_t	callbackHandler
	)

Register an AWS IoT Job handler.

Parameters

[in]	pJobActionStr	A string to represent Job action
[in]	timeoutMin_u8	The minimum timeout value when Job is running
[in]	callbackHandler	The callback handler for performing Job action

JOBS_updateStatus()

void JOBS_updateStatus	(	char *	pJobIdStr,
		jobsStatus_et	status_e
	)

Update the status of Job to AWS IoT.

Parameters

[in]	pJobIdStr	Job ID as string
[in]	status_e	Status of the Job

Returns

none