Constants

Constants defined in the Jobs library. More...

Macros
#define	TOPIC_BUFFER_SIZE   256U
	Size of Topic Buffer.
#define	START_JOB_MSG_LENGTH   147U
	Size of Jobs Start Next Message Buffer.
#define	UPDATE_JOB_MSG_LENGTH   48U
	Size of Jobs Update Message Buffer.
#define	JOBS_THINGNAME_MAX_LENGTH   128U /* per AWS IoT API Reference */
	Maximum length of a thing name for the AWS IoT Jobs Service.
#define	JOBS_JOBID_MAX_LENGTH   64U /* per AWS IoT API Reference */
	Maximum length of a job ID for the AWS IoT Jobs Service.
#define	JOBS_API_SUBSCRIBE_NEXTJOBCHANGED(thingName)    JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NULL, JOBS_API_NEXTJOBCHANGED )
	Topic string for subscribing to the NextJobExecutionChanged API.
#define	JOBS_API_SUBSCRIBE_JOBSCHANGED(thingName)    JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NULL, JOBS_API_JOBSCHANGED )
	Topic string for subscribing to the JobExecutionsChanged API.
#define	JOBS_API_PUBLISH_STARTNEXT(thingName)    JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NULL, JOBS_API_STARTNEXT )
	Topic string for publishing to the StartNextPendingJobExecution API.
#define	JOBS_API_PUBLISH_GETPENDING(thingName)    JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NULL, JOBS_API_GETPENDING )
	Topic string for publishing to the GetPendingJobExecutions API.
#define	JOBS_API_PUBLISH_DESCRIBENEXTJOB(thingName)    JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NEXT JOBS_API_LEVEL_SEPARATOR, JOBS_API_DESCRIBE )
	Topic string for querying the next pending job from the DescribeJobExecution API.
#define	JOBS_API_MAX_LENGTH(thingNameLength)
	The size needed to hold the longest topic for a given thing name length.

Detailed Description

Constants defined in the Jobs library.

Macro Definition Documentation

JOBS_API_SUBSCRIBE_NEXTJOBCHANGED

#define JOBS_API_SUBSCRIBE_NEXTJOBCHANGED

(

thingName

)

JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NULL, JOBS_API_NEXTJOBCHANGED )

Topic string for subscribing to the NextJobExecutionChanged API.

This macro should be used when the thing name is known at the compile time. If the thing name is not known at compile time, the Jobs_GetTopic API should be used instead.

Parameters

thingName

The thing name as registered with AWS IoT Core.

JOBS_API_SUBSCRIBE_JOBSCHANGED

#define JOBS_API_SUBSCRIBE_JOBSCHANGED

(

thingName

)

JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NULL, JOBS_API_JOBSCHANGED )

Topic string for subscribing to the JobExecutionsChanged API.

This macro should be used when the thing name is known at the compile time. If the thing name is not known at compile time, the Jobs_GetTopic API should be used instead.

Parameters

thingName

The thing name as registered with AWS IoT Core.

JOBS_API_PUBLISH_STARTNEXT

#define JOBS_API_PUBLISH_STARTNEXT

(

thingName

)

JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NULL, JOBS_API_STARTNEXT )

Topic string for publishing to the StartNextPendingJobExecution API.

This macro should be used when the thing name is known at the compile time. If the thing name is not known at compile time, the Jobs_StartNext API should be used instead.

Parameters

thingName

The thing name as registered with AWS IoT Core.

JOBS_API_PUBLISH_GETPENDING

#define JOBS_API_PUBLISH_GETPENDING

(

thingName

)

JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NULL, JOBS_API_GETPENDING )

Topic string for publishing to the GetPendingJobExecutions API.

This macro should be used when the thing name is known at the compile time. If the thing name is not known at compile time, the Jobs_GetPending API should be used instead.

Parameters

thingName

The thing name as registered with AWS IoT Core.

JOBS_API_PUBLISH_DESCRIBENEXTJOB

#define JOBS_API_PUBLISH_DESCRIBENEXTJOB

(

thingName

)

JOBS_TOPIC_COMMON( thingName, JOBS_API_JOBID_NEXT JOBS_API_LEVEL_SEPARATOR, JOBS_API_DESCRIBE )

Topic string for querying the next pending job from the DescribeJobExecution API.

This macro should be used when the thing name and jobID are known at the compile time. If next pending job is being queried, use $next as job ID. If the thing name or job ID are not known at compile time, the Jobs_Describe API should be used instead.

Parameters

thingName

The thing name as registered with AWS IoT Core.

JOBS_API_MAX_LENGTH

#define JOBS_API_MAX_LENGTH

(

thingNameLength

)

Value:

    ( JOBS_API_COMMON_LENGTH( thingNameLength ) +                 \
      JOBID_MAX_LENGTH + sizeof( '/' ) + JOBS_API_UPDATE_LENGTH + \
      JOBS_API_SUCCESS_LENGTH + 1U )

The size needed to hold the longest topic for a given thing name length.

Note

This includes space for a terminating NUL character.