Diff: include/aws_iot_mqtt_client_common_internal.h

Revision:

0:082731ede69f

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/include/aws_iot_mqtt_client_common_internal.h	Wed May 30 20:59:51 2018 +0000
@@ -0,0 +1,133 @@
+/*
+* Copyright 2015-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License").
+* You may not use this file except in compliance with the License.
+* A copy of the License is located at
+*
+* http://aws.amazon.com/apache2.0
+*
+* or in the "license" file accompanying this file. This file is distributed
+* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+* express or implied. See the License for the specific language governing
+* permissions and limitations under the License.
+*/
+
+// Based on Eclipse Paho.
+/*******************************************************************************
+ * Copyright (c) 2014 IBM Corp.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ *    http://www.eclipse.org/legal/epl-v10.html
+ * and the Eclipse Distribution License is available at
+ *   http://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * Contributors:
+ *    Ian Craggs - initial API and implementation and/or initial documentation
+ *    Xiang Rong - 442039 Add makefile to Embedded C client
+ *******************************************************************************/
+
+/**
+ * @file aws_iot_mqtt_client_common_internal.h
+ * @brief Internal MQTT functions not exposed to application
+ */
+
+#ifndef AWS_IOT_SDK_SRC_IOT_COMMON_INTERNAL_H
+#define AWS_IOT_SDK_SRC_IOT_COMMON_INTERNAL_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdint.h>
+#include <stddef.h>
+#include <string.h>
+
+#include "aws_iot_log.h"
+#include "aws_iot_mqtt_client_interface.h"
+
+/* Enum order should match the packet ids array defined in MQTTFormat.c */
+typedef enum msgTypes {
+	UNKNOWN = -1,
+	CONNECT = 1,
+	CONNACK = 2,
+	PUBLISH = 3,
+	PUBACK = 4,
+	PUBREC = 5,
+	PUBREL = 6,
+	PUBCOMP = 7,
+	SUBSCRIBE = 8,
+	SUBACK = 9,
+	UNSUBSCRIBE = 10,
+	UNSUBACK = 11,
+	PINGREQ = 12,
+	PINGRESP = 13,
+	DISCONNECT = 14
+} MessageTypes;
+
+/* Macros for parsing header fields from incoming MQTT frame. */
+#define MQTT_HEADER_FIELD_TYPE(_byte)	((_byte >> 4) & 0x0F)
+#define MQTT_HEADER_FIELD_DUP(_byte)	((_byte & (1 << 3)) >> 3)
+#define MQTT_HEADER_FIELD_QOS(_byte)	((_byte & (3 << 1)) >> 1)
+#define MQTT_HEADER_FIELD_RETAIN(_byte)	((_byte & (1 << 0)) >> 0)
+
+/**
+ * Bitfields for the MQTT header byte.
+ */
+typedef union {
+	unsigned char byte;				/**< the whole byte */
+} MQTTHeader;
+
+IoT_Error_t aws_iot_mqtt_internal_init_header(MQTTHeader *pHeader, MessageTypes message_type,
+											  QoS qos, uint8_t dup, uint8_t retained);
+
+IoT_Error_t aws_iot_mqtt_internal_serialize_ack(unsigned char *pTxBuf, size_t txBufLen,
+												MessageTypes msgType, uint8_t dup, uint16_t packetId,
+												uint32_t *pSerializedLen);
+IoT_Error_t aws_iot_mqtt_internal_deserialize_ack(unsigned char *, unsigned char *,
+												  uint16_t *, unsigned char *, size_t);
+
+uint32_t aws_iot_mqtt_internal_get_final_packet_length_from_remaining_length(uint32_t rem_len);
+
+size_t aws_iot_mqtt_internal_write_len_to_buffer(unsigned char *buf, uint32_t length);
+IoT_Error_t aws_iot_mqtt_internal_decode_remaining_length_from_buffer(unsigned char *buf, uint32_t *decodedLen,
+																	  uint32_t *readBytesLen);
+
+uint16_t aws_iot_mqtt_internal_read_uint16_t(unsigned char **pptr);
+void aws_iot_mqtt_internal_write_uint_16(unsigned char **pptr, uint16_t anInt);
+
+unsigned char aws_iot_mqtt_internal_read_char(unsigned char **pptr);
+void aws_iot_mqtt_internal_write_char(unsigned char **pptr, unsigned char c);
+void aws_iot_mqtt_internal_write_utf8_string(unsigned char **pptr, const char *string, uint16_t stringLen);
+
+IoT_Error_t aws_iot_mqtt_internal_send_packet(AWS_IoT_Client *pClient, size_t length, awsTimer *pTimer);
+IoT_Error_t aws_iot_mqtt_internal_cycle_read(AWS_IoT_Client *pClient, awsTimer *pTimer, uint8_t *pPacketType);
+IoT_Error_t aws_iot_mqtt_internal_wait_for_read(AWS_IoT_Client *pClient, uint8_t packetType, awsTimer *pTimer);
+IoT_Error_t aws_iot_mqtt_internal_serialize_zero(unsigned char *pTxBuf, size_t txBufLen,
+												 MessageTypes packetType, size_t *pSerializedLength);
+IoT_Error_t aws_iot_mqtt_internal_deserialize_publish(uint8_t *dup, QoS *qos,
+													  uint8_t *retained, uint16_t *pPacketId,
+													  char **pTopicName, uint16_t *topicNameLen,
+													  unsigned char **payload, size_t *payloadLen,
+													  unsigned char *pRxBuf, size_t rxBufLen);
+
+IoT_Error_t aws_iot_mqtt_set_client_state(AWS_IoT_Client *pClient, ClientState expectedCurrentState,
+										  ClientState newState);
+
+#ifdef _ENABLE_THREAD_SUPPORT_
+
+IoT_Error_t aws_iot_mqtt_client_lock_mutex(AWS_IoT_Client *pClient, IoT_Mutex_t *pMutex);
+
+IoT_Error_t aws_iot_mqtt_client_unlock_mutex(AWS_IoT_Client *pClient, IoT_Mutex_t *pMutex);
+
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* AWS_IOT_SDK_SRC_IOT_COMMON_INTERNAL_H */