Skip to content

Commit c6e5135

Browse files
committed
updated deprecation warning text
1 parent 24be1dc commit c6e5135

File tree

2 files changed

+35
-31
lines changed

2 files changed

+35
-31
lines changed

include/aws/crt/mqtt/MqttClient.h

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,32 +35,36 @@ namespace Aws
3535
namespace Mqtt
3636
{
3737
/**
38+
* @deprecated We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans to
39+
* fully deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client
40+
* to access a more robust feature set, clearer error handling, and lifetime management. More details can be
41+
* found here: <URL>
42+
*
3843
* An MQTT client. This is a move-only type. Unless otherwise specified,
3944
* all function arguments need only to live through the duration of the
4045
* function call.
4146
*/
4247
class AWS_CRT_CPP_API AWS_CRT_SOFT_DEPRECATED(
43-
"Please use Aws::Crt::Mqtt5::Mqtt5Client for new code. There are "
44-
"no current plans to fully deprecate the MQTT 3.1.1 client but it is highly recommended customers "
45-
"migrate "
46-
"to the MQTT5 client to have access to a more robust feature set, clearer error handling, and lifetime "
47-
"management. More details can be found here: <URL>") MqttClient final
48+
"We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans to fully "
49+
"deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to "
50+
"access a more robust feature set, clearer error handling, and lifetime management. More details can "
51+
"be found here: <URL>") MqttClient final
4852
{
4953
public:
5054
/**
51-
* @deprecated Prefer Aws::Crt::Mqtt5::Mqtt5Client for new code. There are no current plans to fully
52-
* deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to
53-
* have access to a more robust feature set, clearer error handling, and lifetime management. More
55+
* @deprecated We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans
56+
* to fully deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5
57+
* client to access a more robust feature set, clearer error handling, and lifetime management. More
5458
* details can be found here: <URL>
5559
*
5660
* Initialize an MqttClient using bootstrap and allocator
5761
*/
5862
MqttClient(Io::ClientBootstrap &bootstrap, Allocator *allocator = ApiAllocator()) noexcept;
5963

6064
/**
61-
* @deprecated Prefer Aws::Crt::Mqtt5::Mqtt5Client for new code. There are no current plans to fully
62-
* deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to
63-
* have access to a more robust feature set, clearer error handling, and lifetime management. More
65+
* @deprecated We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans
66+
* to fully deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5
67+
* client to access a more robust feature set, clearer error handling, and lifetime management. More
6468
* details can be found here: <URL>
6569
*
6670
* Initialize an MqttClient using a allocator and the default ClientBootstrap

include/aws/iot/MqttClient.h

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ namespace Aws
101101
};
102102

103103
/**
104-
* @deprecated Please use Aws::Iot::Mqtt5ClientBuilder for new code. There are no current plans to fully
105-
* deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to have
106-
* access to a more robust feature set, clearer error handling, and lifetime management. More details can be
107-
* found here: <URL>
104+
* @deprecated We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans to fully
105+
* deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to access
106+
* a more robust feature set, clearer error handling, and lifetime management. More details can be found here:
107+
* <URL>
108108
*
109109
* Represents configuration parameters for building a MqttClientConnectionConfig object. You can use a single
110110
* instance of this class PER MqttClientConnectionConfig you want to generate. If you want to generate a config
@@ -470,29 +470,29 @@ namespace Aws
470470
};
471471

472472
/**
473-
* @deprecated Please use Aws::Crt::Mqtt5::Mqtt5Client for new code. There are no current plans to fully
474-
* deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to have
475-
* access to a more robust feature set, clearer error handling, and lifetime management. More details can be
476-
* found here: <URL>
473+
* @deprecated We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans to fully
474+
* deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to access
475+
* a more robust feature set, clearer error handling, and lifetime management. More details can be found here:
476+
* <URL>
477477
*
478478
* AWS IOT specific Mqtt Client. Sets defaults for using the AWS IOT service. You'll need an instance of
479479
* MqttClientConnectionConfig to use. Once NewConnection returns, you use it's return value identically
480480
* to how you would use Aws::Crt::Mqtt::MqttConnection
481481
*/
482482
class AWS_CRT_CPP_API AWS_CRT_SOFT_DEPRECATED(
483-
"Please use Aws::Crt::Mqtt5::Mqtt5Client for new code. There are "
484-
"no current plans to fully deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate "
485-
"to the MQTT5 client to have access to a more robust feature set, clearer error handling, and lifetime "
486-
"management. More details can be found here: <URL>") MqttClient final
483+
"We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans to fully "
484+
"deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to "
485+
"access a more robust feature set, clearer error handling, and lifetime management. More details can be "
486+
"found here: <URL>") MqttClient final
487487
{
488488
public:
489489
MqttClient(Crt::Io::ClientBootstrap &bootstrap, Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;
490490

491491
/**
492-
* @deprecated Prefer Aws::Crt::Mqtt5::Mqtt5Client for new code. There are no current plans to fully
493-
* deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to
494-
* have access to a more robust feature set, clearer error handling, and lifetime management. More details
495-
* can be found here: <URL>
492+
* @deprecated We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans to
493+
* fully deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client
494+
* to access a more robust feature set, clearer error handling, and lifetime management. More details can be
495+
* found here: <URL>
496496
*
497497
* Constructs a new Mqtt Client object using the static default ClientBootstrap.
498498
*
@@ -502,10 +502,10 @@ namespace Aws
502502
MqttClient(Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;
503503

504504
/**
505-
* @deprecated Prefer Aws::Crt::Mqtt5::Mqtt5Client for new code. There are no current plans to fully
506-
* deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client to
507-
* have access to a more robust feature set, clearer error handling, and lifetime management. More details
508-
* can be found here: <URL>
505+
* @deprecated We strongly recommend using the Aws::Crt::Mqtt5::Mqtt5Client. There are no current plans to
506+
* fully deprecate the MQTT 3.1.1 client but it is highly recommended customers migrate to the MQTT5 client
507+
* to access a more robust feature set, clearer error handling, and lifetime management. More details can be
508+
* found here: <URL>
509509
*
510510
* Creates a new mqtt connection from a connection configuration object
511511
* @param config mqtt connection configuration

0 commit comments

Comments
 (0)