Skip to content

Reduce public API by turning connect/disconnect into protected methods. #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 20, 2020
Merged

Reduce public API by turning connect/disconnect into protected methods. #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f675a81
Turning connect/disconnect into protected functions because there is …
aentinger Apr 8, 2020
7a3f27a
Changing return type of disconnect from bool to void since the operat…
aentinger Apr 8, 2020
3142ff5
Reformatting ArduinoIoTCloudTCP::connect for better readability
aentinger Apr 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/ArduinoIoTCloud.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,6 @@ class ArduinoIoTCloudClass
virtual ~ArduinoIoTCloudClass() { }


virtual int connect () = 0;
virtual bool disconnect () = 0;
virtual void update () = 0;
virtual int connected () = 0;
virtual void printDebugInfo() = 0;
Expand Down Expand Up @@ -134,6 +132,9 @@ class ArduinoIoTCloudClass

protected:

virtual int connect () = 0;
virtual void disconnect() = 0;

inline ArduinoIoTConnectionStatus getIoTStatus() { return _iot_status; }

ConnectionHandler * _connection = nullptr;
Expand Down
27 changes: 15 additions & 12 deletions src/ArduinoIoTCloudLPWAN.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,6 @@ ArduinoIoTCloudLPWAN::ArduinoIoTCloudLPWAN()
* PUBLIC MEMBER FUNCTIONS
******************************************************************************/

int ArduinoIoTCloudLPWAN::connect()
{
_connection->connect();
return 1;
}

bool ArduinoIoTCloudLPWAN::disconnect()
{
_connection->disconnect();
return true;
}

int ArduinoIoTCloudLPWAN::connected()
{
return (_connection->getStatus() == NetworkConnectionState::CONNECTED) ? 1 : 0;
Expand Down Expand Up @@ -116,6 +104,21 @@ void ArduinoIoTCloudLPWAN::printDebugInfo()
Debug.print(DBG_INFO, "Thing ID: %s", getThingId().c_str());
}

/******************************************************************************
* PROTECTED MEMBER FUNCTIONS
******************************************************************************/

int ArduinoIoTCloudLPWAN::connect()
{
_connection->connect();
return 1;
}

void ArduinoIoTCloudLPWAN::disconnect()
{
_connection->disconnect();
}

/******************************************************************************
* PRIVATE MEMBER FUNCTIONS
******************************************************************************/
Expand Down
8 changes: 6 additions & 2 deletions src/ArduinoIoTCloudLPWAN.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ class ArduinoIoTCloudLPWAN : public ArduinoIoTCloudClass
ArduinoIoTCloudLPWAN();
virtual ~ArduinoIoTCloudLPWAN() { }

virtual int connect () override;
virtual bool disconnect () override;
virtual void update () override;
virtual int connected () override;
virtual void printDebugInfo() override;
Expand All @@ -52,6 +50,12 @@ class ArduinoIoTCloudLPWAN : public ArduinoIoTCloudClass
inline void setIntervalRetry(long val) { _intervalRetry = val; }


protected:

virtual int connect () override;
virtual void disconnect () override;


private:

bool _retryEnable;
Expand Down
57 changes: 26 additions & 31 deletions src/ArduinoIoTCloudTCP.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,35 +141,6 @@ int ArduinoIoTCloudTCP::begin(String brokerAddress, uint16_t brokerPort)
return 1;
}

int ArduinoIoTCloudTCP::connect()
{
if (!_mqttClient->connect(_brokerAddress.c_str(), _brokerPort)) {
return CONNECT_FAILURE;
}
if (_mqttClient->subscribe(_stdinTopic) == 0) {
return CONNECT_FAILURE_SUBSCRIBE;
}
if (_mqttClient->subscribe(_dataTopicIn) == 0) {
return CONNECT_FAILURE_SUBSCRIBE;
}
if (_shadowTopicIn != "") {
if (_mqttClient->subscribe(_shadowTopicIn) == 0) {
return CONNECT_FAILURE_SUBSCRIBE;
}
_syncStatus = ArduinoIoTSynchronizationStatus::SYNC_STATUS_WAIT_FOR_CLOUD_VALUES;
_lastSyncRequestTickTime = 0;
}

return CONNECT_SUCCESS;
}


bool ArduinoIoTCloudTCP::disconnect()
{
_mqttClient->stop();
return true;
}

void ArduinoIoTCloudTCP::update()
{
// Check if a primitive property wrapper is locally changed
Expand Down Expand Up @@ -209,6 +180,11 @@ void ArduinoIoTCloudTCP::update()
}
}

int ArduinoIoTCloudTCP::connected()
{
return _mqttClient->connected();
}

void ArduinoIoTCloudTCP::printDebugInfo()
{
Debug.print(DBG_INFO, "***** Arduino IoT Cloud - configuration info *****");
Expand All @@ -225,10 +201,29 @@ int ArduinoIoTCloudTCP::reconnect()
return connect();
}

/******************************************************************************
* PROTECTED MEMBER FUNCTIONS
******************************************************************************/

int ArduinoIoTCloudTCP::connected()
int ArduinoIoTCloudTCP::connect()
{
return _mqttClient->connected();
if (!_mqttClient->connect(_brokerAddress.c_str(), _brokerPort)) return CONNECT_FAILURE;
if (_mqttClient->subscribe(_stdinTopic) == 0) return CONNECT_FAILURE_SUBSCRIBE;
if (_mqttClient->subscribe(_dataTopicIn) == 0) return CONNECT_FAILURE_SUBSCRIBE;

if (_shadowTopicIn != "")
{
if (_mqttClient->subscribe(_shadowTopicIn) == 0) return CONNECT_FAILURE_SUBSCRIBE;
_syncStatus = ArduinoIoTSynchronizationStatus::SYNC_STATUS_WAIT_FOR_CLOUD_VALUES;
_lastSyncRequestTickTime = 0;
}

return CONNECT_SUCCESS;
}

void ArduinoIoTCloudTCP::disconnect()
{
_mqttClient->stop();
}

/******************************************************************************
Expand Down
10 changes: 8 additions & 2 deletions src/ArduinoIoTCloudTCP.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
ArduinoIoTCloudTCP();
virtual ~ArduinoIoTCloudTCP();

virtual int connect () override;
virtual bool disconnect () override;

virtual void update () override;
virtual int connected () override;
virtual void printDebugInfo() override;
Expand All @@ -79,6 +78,13 @@ class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass

friend class CloudSerialClass;


protected:

virtual int connect () override;
virtual void disconnect () override;


private:
static const int MQTT_TRANSMIT_BUFFER_SIZE = 256;

Expand Down