Commit 9a275bdf authored by Petar's avatar Petar

Add additional parameters

parent 71129666
......@@ -21,7 +21,8 @@ public:
/*--- Structures ---*/
/**
* @brief Quality of service is an agreement between the sender of a message and the receiver of
* a message that defines the guarantee of delivery for a specific message.
* a message that defines the guarantee of delivery for a specific message. Values are defined
* as they are in the standard.
*/
enum class QualityOfService
{
......@@ -42,22 +43,32 @@ public:
* In case there are multiple devices devices with the same id then one will be disconnected
* when the other connects.
*
* @param[in] broker Address of the MQTT broker.
* @param[in] scheme Connection technology. (e.g. TCP, TLS, WebSocket), depends on the use
* case and can be implemented as an enum.
* @param[in] clientId Unique identification for a device connecting to the broker.
* @param[in] username Authentication information for connecting to the broker.
* @param[in] password Authentication information for connecting to the broker.
* @param[in] timeout Time interval during which the connection should be established.
* @param[in] broker Address of the MQTT broker.
* @param[in] scheme Connection technology that is being used for connecting to the
* broker (e.g. TCP, TLS, WebSocket), depends on the use case and
* can be implemented as an enum in the implementation.
* @param[in] clientId Unique identification for a device connecting to the broker.
* @param[in] username Authentication information for connecting to the broker.
* @param[in] password Authentication information for connecting to the broker.
* @param[in] keepAliveInterval Timeout interval (in seconds) after which the PINGREQ packet is
* sent. Packet is used to notify the server that the client is
* alive in absence of any other control packets that are being
* sent. For more information check out 3.12.chapter of MQTT
* protocol.
* @param[in] qos Quality of service that defines the reliability of receiving
* sent packets.
* @param[in] timeout Time interval during which a connection to the broker should be
* established.
*
* @return Error::None is being returned if the publishing was successful, otherwise project
* specific error codes may be returned.
*/
virtual Error::Code connectToMqttBroker(uint8_t* broker,
uint8_t scheme,
uint8_t clientId,
uint8_t* clientId,
uint8_t* username,
uint8_t* password,
uint16_t keepAliveInterval,
QualityOfService qos,
RTOS::milliseconds timeout) = 0;
/**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment