aws_jobs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef AWS_JOBS_H__
#define AWS_JOBS_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/net/mqtt.h>
 
enum execution_status {
        AWS_JOBS_QUEUED = 0,
        AWS_JOBS_IN_PROGRESS,
        AWS_JOBS_SUCCEEDED,
        AWS_JOBS_FAILED,
        AWS_JOBS_TIMED_OUT,
        AWS_JOBS_REJECTED,
        AWS_JOBS_REMOVED,
        AWS_JOBS_CANCELED
};
 
#define SUBSCRIBE_ID_BASE (2110)
#define SUBSCRIBE_NOTIFY (SUBSCRIBE_ID_BASE + 1)
#define SUBSCRIBE_NOTIFY_NEXT (SUBSCRIBE_ID_BASE + 2)
#define SUBSCRIBE_GET (SUBSCRIBE_ID_BASE + 3)
#define SUBSCRIBE_JOB_ID_GET (SUBSCRIBE_ID_BASE + 4)
#define SUBSCRIBE_JOB_ID_UPDATE (SUBSCRIBE_ID_BASE + 5)
#define SUBSCRIBE_EXPECTED (SUBSCRIBE_ID_BASE + 10)
#define AWS "$aws/things/"
#define AWS_LEN (sizeof(AWS) - 1)
#define AWS_JOBS_JOB_ID_MAX_LEN (64 + 1)
#define AWS_JOBS_TOPIC_STATIC_LEN 20 /* '$aws/token' etc... */
#define AWS_JOBS_TOPIC_MAX_LEN (CONFIG_CLIENT_ID_MAX_LEN + \
                AWS_JOBS_TOPIC_STATIC_LEN + AWS_JOBS_JOB_ID_MAX_LEN)
 
int aws_jobs_create_topic_notify_next(struct mqtt_client *const client,
                                         uint8_t *topic_buf);
 
int aws_jobs_subscribe_topic_notify_next(struct mqtt_client *const client,
                                         uint8_t *topic_buf);
 
int aws_jobs_unsubscribe_topic_notify_next(struct mqtt_client *const client,
                                           uint8_t *topic_buf);
 
int aws_jobs_create_topic_notify(struct mqtt_client *const client,
                                 uint8_t *topic_buf);
 
int aws_jobs_subscribe_topic_notify(struct mqtt_client *const client,
                                    uint8_t *topic_buf);
 
int aws_jobs_unsubscribe_topic_notify(struct mqtt_client *const client,
                                      uint8_t *topic_buf);
 
int aws_jobs_create_topic_get(struct mqtt_client *const client,
                              const uint8_t *job_id, uint8_t *topic_buf);
 
int aws_jobs_subscribe_topic_get(struct mqtt_client *const client,
                                 const uint8_t *job_id, uint8_t *topic_buf);
 
int aws_jobs_unsubscribe_topic_get(struct mqtt_client *const client,
                                   const uint8_t *job_id, uint8_t *topic_buf);
 
int aws_jobs_subscribe_topic_update(struct mqtt_client *const client,
                                    const uint8_t *job_id, uint8_t *topic_buf);
 
int aws_jobs_unsubscribe_topic_update(struct mqtt_client *const client,
                                      const uint8_t *job_id, uint8_t *topic_buf);
 
int aws_jobs_update_job_execution(struct mqtt_client *const client,
                                  const uint8_t *job_id,
                                  enum execution_status status,
                                  const uint8_t *status_details,
                                  int expected_version,
                                  const uint8_t *client_token,
                                  uint8_t *topic_buf);
 
int aws_jobs_get_job_execution(struct mqtt_client *const client,
                               const char *job_id, uint8_t *topic_buf);
 
bool aws_jobs_cmp(const char *sub, const char *pub, size_t pub_len,
                  const uint8_t *suffix);
 
#ifdef __cplusplus
}
#endif
 
#endif /* AWS_JOBS_H__ */