jobs.c File Reference

Implementation of the APIs from jobs.h. More...

#include <assert.h>
#include "jobs.h"

Functions
JobsStatus_t	Jobs_GetTopic (char *buffer, size_t length, const char *thingName, uint16_t thingNameLength, JobsTopic_t api, size_t *outLength)
	Populate a topic string for a subscription request. More...
JobsStatus_t	Jobs_MatchTopic (char *topic, size_t length, const char *thingName, uint16_t thingNameLength, JobsTopic_t *outApi, char **outJobId, uint16_t *outJobIdLength)
	Output a topic value if a Jobs API topic string is present. More...
JobsStatus_t	Jobs_GetPending (char *buffer, size_t length, const char *thingName, uint16_t thingNameLength, size_t *outLength)
	Populate a topic string for a GetPendingJobExecutions request. More...
JobsStatus_t	Jobs_StartNext (char *buffer, size_t length, const char *thingName, uint16_t thingNameLength, size_t *outLength)
	Populate a topic string for a StartNextPendingJobExecution request. More...
JobsStatus_t	Jobs_Describe (char *buffer, size_t length, const char *thingName, uint16_t thingNameLength, const char *jobId, uint16_t jobIdLength, size_t *outLength)
	Populate a topic string for a DescribeJobExecution request. More...
JobsStatus_t	Jobs_Update (char *buffer, size_t length, const char *thingName, uint16_t thingNameLength, const char *jobId, uint16_t jobIdLength, size_t *outLength)
	Populate a topic string for an UpdateJobExecution request. More...

Detailed Description

Implementation of the APIs from jobs.h.

Function Documentation

Jobs_GetTopic()

JobsStatus_t Jobs_GetTopic	(	char *	buffer,
		size_t	length,
		const char *	thingName,
		uint16_t	thingNameLength,
		JobsTopic_t	api,
		size_t *	outLength
	)

Populate a topic string for a subscription request.

See jobs.h for docs.

Jobs_MatchTopic()

JobsStatus_t Jobs_MatchTopic	(	char *	topic,
		size_t	length,
		const char *	thingName,
		uint16_t	thingNameLength,
		JobsTopic_t *	outApi,
		char **	outJobId,
		uint16_t *	outJobIdLength
	)

Output a topic value if a Jobs API topic string is present.

Output a topic value if a Jobs API topic string is present. Optionally, output a pointer to a jobID within the topic and its length.

See jobs.h for docs.

Jobs_GetPending()

JobsStatus_t Jobs_GetPending	(	char *	buffer,
		size_t	length,
		const char *	thingName,
		uint16_t	thingNameLength,
		size_t *	outLength
	)

Populate a topic string for a GetPendingJobExecutions request.

See jobs.h for docs.

Jobs_StartNext()

JobsStatus_t Jobs_StartNext	(	char *	buffer,
		size_t	length,
		const char *	thingName,
		uint16_t	thingNameLength,
		size_t *	outLength
	)

Populate a topic string for a StartNextPendingJobExecution request.

See jobs.h for docs.

Jobs_Describe()

JobsStatus_t Jobs_Describe	(	char *	buffer,
		size_t	length,
		const char *	thingName,
		uint16_t	thingNameLength,
		const char *	jobId,
		uint16_t	jobIdLength,
		size_t *	outLength
	)

Populate a topic string for a DescribeJobExecution request.

See jobs.h for docs.

Jobs_Update()

JobsStatus_t Jobs_Update	(	char *	buffer,
		size_t	length,
		const char *	thingName,
		uint16_t	thingNameLength,
		const char *	jobId,
		uint16_t	jobIdLength,
		size_t *	outLength
	)

Populate a topic string for an UpdateJobExecution request.

See jobs.h for docs.