Issue 79

shamblett · Dec 30, 2023 · c4c05c0 · c4c05c0
1 parent 4e38644
commit c4c05c0
Show file tree

Hide file tree

Showing 120 changed files with 178 additions and 193 deletions.
diff --git a/example/mqtt5_client.dart b/example/mqtt5_client.dart
@@ -5,12 +5,12 @@
  * Copyright :  S.Hamblett
  */
 
-/// The mqtt5_client comprises a server client [MqttServerClient] and a browser
-/// client [MqttBrowserClient]. Example usage of these two clients are contained in this directory.
-///
-/// Except for connection functionality the behavior of the clients wrt MQTT is the same.
-///
-/// Note that for previous users the [MqttClient] class is now only a support class and should not
-/// be directly instantiated.
-/// See the example mqtt5_universal_client to see how instantiating a server or browser client as
-/// needed can be done automatically.
+// The mqtt5_client comprises a server client [MqttServerClient] and a browser
+// client [MqttBrowserClient]. Example usage of these two clients are contained in this directory.
+//
+// Except for connection functionality the behavior of the clients wrt MQTT is the same.
+//
+// Note that for previous users the [MqttClient] class is now only a support class and should not
+// be directly instantiated.
+// See the example mqtt5_universal_client to see how instantiating a server or browser client as
+// needed can be done automatically.
diff --git a/example/mqtt5_universal_client.dart b/example/mqtt5_universal_client.dart
@@ -5,21 +5,21 @@
  * Copyright :  S.Hamblett
  */
 
-/// The following scheme can be used conditionally import either the server or browser client
-/// automatically.
-///
-/// import 'server.dart' if (dart.library.html) 'browser.dart' as mqttsetup;
-/// ...
-/// var client = mqttsetup.setup(serverAddress, uniqueID, port);
-///
-/// where server.dart will contain such as the following
-///
-/// MqttClient setup(String serverAddress, String uniqueID, int port) {
-///   return MqttServerClient.withPort(serverAddress, uniqueID, port);
-/// }
-///
-/// and browser.dart
-///
-/// MqttClient setup(String serverAddress, String uniqueID, int port) {
-///  return MqttBrowserClient.withPort(serverAddress, uniqueID, port);
-/// }
+// The following scheme can be used conditionally import either the server or browser client
+// automatically.
+//
+// import 'server.dart' if (dart.library.html) 'browser.dart' as mqttsetup;
+// ...
+// var client = mqttsetup.setup(serverAddress, uniqueID, port);
+//
+// where server.dart will contain such as the following
+//
+// MqttClient setup(String serverAddress, String uniqueID, int port) {
+//   return MqttServerClient.withPort(serverAddress, uniqueID, port);
+// }
+//
+// and browser.dart
+//
+// MqttClient setup(String serverAddress, String uniqueID, int port) {
+//  return MqttBrowserClient.withPort(serverAddress, uniqueID, port);
+// }
diff --git a/lib/src/connectionhandling/browser/mqtt_browser_connection.dart b/lib/src/connectionhandling/browser/mqtt_browser_connection.dart
@@ -5,12 +5,12 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_browser_client;
+part of '../../../mqtt5_browser_client.dart';
 
 /// The MQTT browser connection base class
 class MqttBrowserConnection extends MqttConnectionBase {
   /// Default constructor
-  MqttBrowserConnection(clientEventBus) : super(clientEventBus);
+  MqttBrowserConnection(super.clientEventBus);
 
   /// Initializes a new instance of the MqttBrowserConnection class.
   MqttBrowserConnection.fromConnect(server, port, clientEventBus)

diff --git a/lib/src/connectionhandling/browser/mqtt_browser_connection_handler.dart b/lib/src/connectionhandling/browser/mqtt_browser_connection_handler.dart
@@ -5,13 +5,12 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_browser_client;
+part of '../../../mqtt5_browser_client.dart';
 
 ///  This class provides specific connection functionality
 ///  for browser based connection handler implementations.
 abstract class MqttBrowserConnectionHandler extends MqttConnectionHandlerBase {
   /// Initializes a new instance of the [MqttBrowserConnectionHandler] class.
-  MqttBrowserConnectionHandler(clientEventBus,
-      {required int maxConnectionAttempts})
-      : super(clientEventBus, maxConnectionAttempts: maxConnectionAttempts);
+  MqttBrowserConnectionHandler(super.clientEventBus,
+      {required int super.maxConnectionAttempts});
 }
diff --git a/lib/src/connectionhandling/browser/mqtt_browser_ws_connection.dart b/lib/src/connectionhandling/browser/mqtt_browser_ws_connection.dart
@@ -5,12 +5,12 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_browser_client;
+part of '../../../mqtt5_browser_client.dart';
 
 /// The MQTT connection class for the browser websocket interface
 class MqttBrowserWsConnection extends MqttBrowserConnection {
   /// Default constructor
-  MqttBrowserWsConnection(events.EventBus? eventBus) : super(eventBus);
+  MqttBrowserWsConnection(super.eventBus);
 
   /// Initializes a new instance of the MqttConnection class.
   MqttBrowserWsConnection.fromConnect(

diff --git a/lib/src/connectionhandling/browser/mqtt_synchronous_browser_connection_handler.dart b/lib/src/connectionhandling/browser/mqtt_synchronous_browser_connection_handler.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_browser_client;
+part of '../../../mqtt5_browser_client.dart';
 
 /// Connection handler that performs connections and disconnections
 /// to the hostname in a synchronous manner.

diff --git a/lib/src/connectionhandling/mqtt_connection_base.dart b/lib/src/connectionhandling/mqtt_connection_base.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// The MQTT client connection base class
 class MqttConnectionBase {

diff --git a/lib/src/connectionhandling/mqtt_connection_handler_base.dart b/lib/src/connectionhandling/mqtt_connection_handler_base.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 ///  This class provides shared connection functionality
 ///  to serverand browser connection handler implementations.

diff --git a/lib/src/connectionhandling/mqtt_connection_keep_alive.dart b/lib/src/connectionhandling/mqtt_connection_keep_alive.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Ping response received callback
 typedef PongCallback = void Function();

diff --git a/lib/src/connectionhandling/mqtt_connection_state.dart b/lib/src/connectionhandling/mqtt_connection_state.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Enumeration that indicates the origin of a client disconnection
 enum MqttDisconnectionOrigin {

diff --git a/lib/src/connectionhandling/mqtt_iconnection_handler.dart b/lib/src/connectionhandling/mqtt_iconnection_handler.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Callback function definitions
 typedef MessageCallbackFunction = bool Function(MqttMessage message);

diff --git a/lib/src/connectionhandling/mqtt_read_wrapper.dart b/lib/src/connectionhandling/mqtt_read_wrapper.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// State and logic used to read from the underlying network stream.
 class MqttReadWrapper {

diff --git a/lib/src/connectionhandling/server/mqtt_server_connection.dart b/lib/src/connectionhandling/server/mqtt_server_connection.dart
@@ -5,13 +5,12 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_server_client;
+part of '../../../mqtt5_server_client.dart';
 
 /// The MQTT client server connection base class
 class MqttServerConnection extends MqttConnectionBase {
   /// Default constructor
-  MqttServerConnection(clientEventBus, this.socketOptions)
-      : super(clientEventBus);
+  MqttServerConnection(super.clientEventBus, this.socketOptions);
 
   /// Initializes a new instance of the MqttConnection class.
   MqttServerConnection.fromConnect(

diff --git a/lib/src/connectionhandling/server/mqtt_server_connection_handler.dart b/lib/src/connectionhandling/server/mqtt_server_connection_handler.dart
@@ -5,15 +5,14 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_server_client;
+part of '../../../mqtt5_server_client.dart';
 
 ///  This class provides specific connection functionality
 ///  for server based connections.
 abstract class MqttServerConnectionHandler extends MqttConnectionHandlerBase {
   /// Initializes a new instance of the [MqttServerConnectionHandler] class.
-  MqttServerConnectionHandler(clientEventBus,
-      {required int? maxConnectionAttempts, required this.socketOptions})
-      : super(clientEventBus, maxConnectionAttempts: maxConnectionAttempts);
+  MqttServerConnectionHandler(super.clientEventBus,
+      {required super.maxConnectionAttempts, required this.socketOptions});
 
   /// Use a websocket rather than TCP
   bool useWebSocket = false;

diff --git a/lib/src/connectionhandling/server/mqtt_server_normal_connection.dart b/lib/src/connectionhandling/server/mqtt_server_normal_connection.dart
@@ -5,14 +5,12 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_server_client;
+part of '../../../mqtt5_server_client.dart';
 
 /// The MQTT normal(insecure TCP) server connection class
 class MqttServerNormalConnection extends MqttServerConnection {
   /// Default constructor
-  MqttServerNormalConnection(
-      events.EventBus? eventBus, List<RawSocketOption> socketOptions)
-      : super(eventBus, socketOptions);
+  MqttServerNormalConnection(super.eventBus, super.socketOptions);
 
   /// Initializes a new instance of the MqttConnection class.
   MqttServerNormalConnection.fromConnect(String server, int port,

diff --git a/lib/src/connectionhandling/server/mqtt_server_secure_connection.dart b/lib/src/connectionhandling/server/mqtt_server_secure_connection.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_server_client;
+part of '../../../mqtt5_server_client.dart';
 
 /// The MQTT server secure connection class
 class MqttServerSecureConnection extends MqttServerConnection {

diff --git a/lib/src/connectionhandling/server/mqtt_server_ws2_connection.dart b/lib/src/connectionhandling/server/mqtt_server_ws2_connection.dart
@@ -6,7 +6,7 @@
  * 01/19/2019 : Don Edvalson - Added this alternate websocket class to work around AWS deficiencies.
  */
 
-part of mqtt5_server_client;
+part of '../../../mqtt5_server_client.dart';
 
 /// Detatched socket class for alternative websocket support
 class _DetachedSocket extends Stream<Uint8List> implements Socket {

diff --git a/lib/src/connectionhandling/server/mqtt_server_ws_connection.dart b/lib/src/connectionhandling/server/mqtt_server_ws_connection.dart
@@ -5,14 +5,12 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_server_client;
+part of '../../../mqtt5_server_client.dart';
 
 /// The MQTT server connection class for the websocket interface
 class MqttServerWsConnection extends MqttServerConnection {
   /// Default constructor
-  MqttServerWsConnection(
-      events.EventBus? eventBus, List<RawSocketOption> socketOptions)
-      : super(eventBus, socketOptions);
+  MqttServerWsConnection(super.eventBus, super.socketOptions);
 
   /// Initializes a new instance of the MqttConnection class.
   MqttServerWsConnection.fromConnect(String server, int port,

diff --git a/lib/src/connectionhandling/server/mqtt_synchronous_server_connection_handler.dart b/lib/src/connectionhandling/server/mqtt_synchronous_server_connection_handler.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_server_client;
+part of '../../../mqtt5_server_client.dart';
 
 /// Connection handler that performs server based connections and disconnections
 /// to the hostname in a synchronous manner.

diff --git a/lib/src/encoding/mqtt_binary_data_encoding.dart b/lib/src/encoding/mqtt_binary_data_encoding.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Binary Data is represented by a Two Byte Integer length which indicates the number of data bytes,
 /// followed by that number of bytes. Thus, the length of Binary Data is limited

diff --git a/lib/src/encoding/mqtt_string_pair.dart b/lib/src/encoding/mqtt_string_pair.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// A UTF-8 String Pair consists of two UTF-8 Encoded Strings.
 /// This data type is used to hold name-value pairs. The first string serves as the

diff --git a/lib/src/encoding/mqtt_utf8_encoding.dart b/lib/src/encoding/mqtt_utf8_encoding.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Encoding implementation that can encode and decode strings
 /// in the MQTT UTF8 string format.

diff --git a/lib/src/encoding/mqtt_variable_byte_integer_encoding.dart b/lib/src/encoding/mqtt_variable_byte_integer_encoding.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// The Variable Byte Integer is encoded using an encoding scheme which uses a single
 /// byte for values up to 127. Larger values are handled as follows. The least significant

diff --git a/lib/src/exception/mqtt_connection_exception.dart b/lib/src/exception/mqtt_connection_exception.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Exception thrown when the connection state is incorrect.
 class MqttConnectionException implements Exception {

diff --git a/lib/src/exception/mqtt_identifier_exception.dart b/lib/src/exception/mqtt_identifier_exception.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Exception thrown when a client identifier included in a message is too long.
 class MqttIdentifierException implements Exception {

diff --git a/lib/src/exception/mqtt_incorrect_instantiation_exception.dart b/lib/src/exception/mqtt_incorrect_instantiation_exception.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Exception thrown when a browser or server client is instantiated incorrectly.
 class MqttIncorrectInstantiationException implements Exception {

diff --git a/lib/src/exception/mqtt_invalid_header_exception.dart b/lib/src/exception/mqtt_invalid_header_exception.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Exception thrown when processing a header that is invalid in some way.
 class MqttInvalidHeaderException implements Exception {

diff --git a/lib/src/exception/mqtt_invalid_message_exception.dart b/lib/src/exception/mqtt_invalid_message_exception.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Exception thrown when processing a message that is invalid in some way.
 class MqttInvalidMessageException implements Exception {

diff --git a/lib/src/exception/mqtt_invalid_payload_size_exception.dart b/lib/src/exception/mqtt_invalid_payload_size_exception.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Exception that is thrown when the payload of a message
 /// is not the correct size.

diff --git a/lib/src/exception/mqtt_invalid_topic_exception.dart b/lib/src/exception/mqtt_invalid_topic_exception.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Exception thrown when the topic of a message is invalid
 class MqttInvalidTopicException implements Exception {

diff --git a/lib/src/exception/mqtt_noconnection_exception.dart b/lib/src/exception/mqtt_noconnection_exception.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// Exception thrown when the client fails to connect
 class MqttNoConnectionException implements Exception {

diff --git a/lib/src/management/mqtt_topic_filter.dart b/lib/src/management/mqtt_topic_filter.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../mqtt5_client.dart';
 
 /// This class allows specific topics to be listened for. It essentially
 /// acts as a bandpass filter for the topics you are interested in if

diff --git a/lib/src/messages/authenticate/mqtt_authenticate_message.dart b/lib/src/messages/authenticate/mqtt_authenticate_message.dart
@@ -5,7 +5,7 @@
  * Copyright :  S.Hamblett
  */
 
-part of mqtt5_client;
+part of '../../../mqtt5_client.dart';
 
 /// An authenticate message is sent from the client to the broker or the
 /// broker to the client as part of an extended authentication exchange,