internalConnect method

  1. @override
Future<MqttClientConnectionStatus> internalConnect(
  1. String hostname,
  2. int port,
  3. MqttConnectMessage? connectMessage
)
override

Synchronously connect to the specific Mqtt Connection.

Implementation

@override
Future<MqttClientConnectionStatus> internalConnect(
    String hostname, int port, MqttConnectMessage? connectMessage) async {
  var connectionAttempts = 0;
  MqttLogger.log(
      'SynchronousMqttServerConnectionHandler::internalConnect entered');
  do {
    // Initiate the connection
    MqttLogger.log(
        'SynchronousMqttServerConnectionHandler::internalConnect - '
        'initiating connection try $connectionAttempts, auto reconnect in progress $autoReconnectInProgress');
    connectionStatus.state = MqttConnectionState.connecting;
    connectionStatus.returnCode = MqttConnectReturnCode.noneSpecified;
    // Don't reallocate the connection if this is an auto reconnect
    if (!autoReconnectInProgress) {
      if (useWebSocket) {
        final MqttServerWsConnection connection;
        if (useAlternateWebSocketImplementation) {
          MqttLogger.log(
              'SynchronousMqttServerConnectionHandler::internalConnect - '
              'alternate websocket implementation selected');
          connection = MqttServerWs2Connection(
              securityContext, clientEventBus, socketOptions);
        } else {
          MqttLogger.log(
              'SynchronousMqttServerConnectionHandler::internalConnect - '
              'websocket selected');
          connection = MqttServerWsConnection(clientEventBus, socketOptions);
        }

        final websocketProtocols = this.websocketProtocols;
        if (websocketProtocols != null) {
          connection.protocols = websocketProtocols;
        }

        final websocketHeaders = this.websocketHeaders;
        if (websocketHeaders != null) {
          connection.headers = websocketHeaders;
        }

        this.connection = connection;
      } else if (secure) {
        MqttLogger.log(
            'SynchronousMqttServerConnectionHandler::internalConnect - '
            'secure selected');
        connection = MqttServerSecureConnection(
            securityContext, clientEventBus, onBadCertificate, socketOptions);
      } else {
        MqttLogger.log(
            'SynchronousMqttServerConnectionHandler::internalConnect - '
            'insecure TCP selected');
        connection =
            MqttServerNormalConnection(clientEventBus, socketOptions);
      }
      connection.onDisconnected = onDisconnected;
    }

    // Connect
    try {
      if (!autoReconnectInProgress) {
        MqttLogger.log(
            'SynchronousMqttServerConnectionHandler::internalConnect - calling connect');
        await connection.connect(hostname, port);
      } else {
        MqttLogger.log(
            'SynchronousMqttServerConnectionHandler::internalConnect - calling connectAuto');
        await connection.connectAuto(hostname, port);
      }
    } on Exception {
      // Ignore exceptions in an auto reconnect sequence
      if (autoReconnectInProgress) {
        MqttLogger.log(
            'SynchronousMqttServerConnectionHandler::internalConnect'
            ' exception thrown during auto reconnect - ignoring');
      } else {
        rethrow;
      }
    }
    MqttLogger.log(
        'SynchronousMqttServerConnectionHandler::internalConnect - '
        'connection complete');
    // Transmit the required connection message to the broker.
    MqttLogger.log('SynchronousMqttServerConnectionHandler::internalConnect '
        'sending connect message');
    sendMessage(connectMessage);
    MqttLogger.log(
        'SynchronousMqttServerConnectionHandler::internalConnect - '
        'pre sleep, state = $connectionStatus');
    // We're the sync connection handler so we need to wait for the
    // brokers acknowledgement of the connections
    await connectTimer.sleep();
    connectionAttempts++;
    MqttLogger.log(
        'SynchronousMqttServerConnectionHandler::internalConnect - '
        'post sleep, state = $connectionStatus');
    if (connectionStatus.state != MqttConnectionState.connected) {
      if (!autoReconnectInProgress) {
        MqttLogger.log(
            'SynchronousMqttServerConnectionHandler::internalConnect failed, attempt $connectionAttempts');
        if (onFailedConnectionAttempt != null) {
          MqttLogger.log(
              'SynchronousMqttServerConnectionHandler::calling onFailedConnectionAttempt');
          onFailedConnectionAttempt!(connectionAttempts);
        }
      }
    }
  } while (connectionStatus.state != MqttConnectionState.connected &&
      connectionAttempts < maxConnectionAttempts!);
  // If we've failed to handshake with the broker, throw an exception.
  if (connectionStatus.state != MqttConnectionState.connected) {
    if (!autoReconnectInProgress) {
      MqttLogger.log(
          'SynchronousMqttServerConnectionHandler::internalConnect failed');
      if (onFailedConnectionAttempt == null) {
        if (connectionStatus.returnCode ==
            MqttConnectReturnCode.noneSpecified) {
          throw NoConnectionException(
              'The maximum allowed connection attempts '
              '({$maxConnectionAttempts}) were exceeded. '
              'The broker is not responding to the connection request message '
              '(Missing Connection Acknowledgement?');
        } else {
          throw NoConnectionException(
              'The maximum allowed connection attempts '
              '({$maxConnectionAttempts}) were exceeded. '
              'The broker is not responding to the connection request message correctly '
              'The return code is ${connectionStatus.returnCode}');
        }
      } else {
        connectionStatus.state = MqttConnectionState.faulted;
      }
    }
  }
  MqttLogger.log('SynchronousMqttServerConnectionHandler::internalConnect '
      'exited with state $connectionStatus');
  initialConnectionComplete = true;
  return connectionStatus;
}