websocket_ping_validator

Description:

websocket ping validator

sql_data_helper #

A dart package to use websockets and check the connection.
Getting Started #
Installing #
In your Flutter project, add the package to your dependencies
flutter pub add websocket_ping_validator
or
dependencies:
...
websocket_ping_validator: #last_version
...
copied to clipboard
Usage Example #
import 'package:websocket_ping_validator/utilities/properties.dart';
import 'package:websocket_ping_validator/websocket_ping_validator.dart';

void main() async {
///Type: String
///YOUR WEBSOCKET URL
const url = "ws...";

///Type: bool
///VARIABLE SPECIFICITIES IF YOU WANT TO RECONNECT WHEN A ERROR HAVE OCCURRED
const reconnectOnError = true;

///Type: bool
///VARIABLE SPECIFICITIES IF YOU WANT TO RECONNECT WHEN THE CONNECTION WAS BE INTERRUPTED
const reconnectOnConnectionLost = true;

///Type: Duration
///IS DURATION OF TIME TO MAKE A PING
const periodicDurationToMakePing = Duration(seconds: 3);

///Type: Duration
///IS DURATION OF TIME TO RECONNECT THE WEBSOCKET
const reconnectIn = Duration(seconds: 3);

///Type: bool (or a function with bool value)
///IS A CUSTOM VALIDATION TO CONNECT THE WEBSOCKET
bool validateIfCanMakeConnection() {
return true;
}

final webSocketConnection = await WebsocketPingValidator.connectWebSocket(url,
properties: WebSocketPingValidatorProperties(
onMessage: (message) async {
///MESSAGE RECEIVED FROM SERVER
},
onConnected: (dateTimeConnected) async {
///WEBSOCKET CONNECTED (YOU RECEIVE THE SPECIFIC DateTime WHEN THE CONNECTION OCCURRED)
},
onConnectionClosed: (statusCode) async {
///WEBSOCKET DISCONNECTED (YOU RECEIVE THE SPECIFIC StatusCode IN int WHEN THE DISCONNECTION OCCURRED)
},
onConnectionLost: () async {
///WEBSOCKET HAVE LOST THEIR CONNECTION
},
onError: (error) async {
///WEBSOCKET HAVE OCCURRED AN ERROR (YOU RECEIVED IT)
},
onReconnectStarted: (duration) async {
///FUNCTION BEFORE START RECONNECTION COUNT DOWN
},
periodicDurationToMakePing: periodicDurationToMakePing,
reconnectIn: reconnectIn,
reconnectOnError: reconnectOnError,
reconnectOnConnectionLost: reconnectOnConnectionLost,
validateIfCanMakeConnection: validateIfCanMakeConnection(),
onNewInstanceCreated: (newWebSocketInstance) {
///FUNCTION AFTER CHANGE THE ORIGINAL WEBSOCKET INSTANCE
}));

///YOU CAN CLOSE THE CONNECTION OR OPEN MORE
await webSocketConnection.close();
}
copied to clipboard