https://github.com/ctatu/ws-wrapper-dart2

Websocket event based wrapper for flutter
https://github.com/ctatu/ws-wrapper-dart2

based channels dart events flutter socket websocket wrapper

Last synced: about 2 months ago
JSON representation

Websocket event based wrapper for flutter

• Host: GitHub
• URL: https://github.com/ctatu/ws-wrapper-dart2
• Owner: cTatu
• License: bsd-2-clause
• Created: 2019-07-29T14:40:06.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-10T17:24:31.000Z (over 5 years ago)
• Last Synced: 2024-05-06T13:50:11.387Z (9 months ago)
• Topics: based, channels, dart, events, flutter, socket, websocket, wrapper
• Language: Dart
• Homepage: https://pub.dev/packages/websocket_channel_wrapper
• Size: 15.6 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Wrapper for web_socket_channel package lightweight and isomorphic lib with socket.io-like event handling, Future-based requests. This wrapper implements the protocol for [this ws node wrapper](https://github.com/bminer/ws-wrapper).

**WARNING: server -> client requests are not sopported. If someone needs them open a PR**

## Usage

A simple usage example:

**Client side:**

```dart

import 'dart:async';

import 'dart:io';

import 'package:websocket_channel_wrapper/websocket_channel_wrapper.dart';

const PORT = 42069;

main() {

  WebSocketChannelWrapper socket = WebSocketChannelWrapper('ws://192.168.0.18:$PORT',

                                              headers: {'id': '1234567890qwertyuiop'});

  print('Connecting...');

  var onReady = socket.onConnect.first;

  onReady.timeout(Duration(seconds: 5), onTimeout: () => print('Server could not be reach, trying to re-connect'));

  socket.onConnect.skip(1).listen((_) => print('Successful re-connection to server'));

  socket.onDone.listen((_) => print(socket.autoReconnect ? 'Connection lost, trying to re-connect!' : 'Connection ended!'));

  onReady.then((_) async { // [onConnect] It's called every time the WebSocket reconnect

    print('Connected!');

    socket.emit('msg', ['DART_WEBSOCKET_WRAPPER', 'Hello, World!']);

    socket.on('serverTime').listen((time) => print('Time: $time'));  // Time: 2019-07-29T14:00:32.635Z

    socket.request('userCount').then((n) => print('# users: $n'));   // # users: 1

    socket.request('checkError').catchError((e) => print(e));        // Yep, errors work

    var filename = '/path/to/file/image.jpg';

    sendFile(filename, socket);   // Send binary file over socket

    Timer(Duration(seconds: 10), () {    // Close the socket after 1 minute

      var reason = 'break time';

      print('Close reason: $reason');

      socket.close(closeReason: reason);

    });

  });

}

sendFile(String filename, socket) async {

  var image = File(filename);

  var contents = await image.readAsBytes();

  final stopwatch = Stopwatch()..start();   // Start timer to measure speed

  

  socket.request('transferFile', [filename, contents]).then((_) { // Send first file name then the bytes

    final speed = contents.length / stopwatch.elapsedMicroseconds;

    print('File sended in ${stopwatch.elapsed} at $speed MB/s');  // File sended in 0:00:00.058191 at 1.63 MB/s

  }).catchError((e) => print(e));

}

```

**Server side:**

```js

const WebSocketServer = require("ws").Server

  , WebSocketWrapper = require("ws-wrapper")

const fs = require('fs')

const PORT = 42069

var wss = new WebSocketServer({port: PORT});

var sockets = new Set();

wss.on("connection", (sckt, req) => {

  const socket = new WebSocketWrapper(sckt)

  sockets.add(socket)

  console.log('New socket connected')

  socket.emit('serverTime', new Date())  // Send data to client on connect

  

  socket.on("msg", function(from, msg) {

      console.log(`Received message from ${from}: ${msg}`) // Received message from DART_WEBSOCKET_WRAPPER: Hello, World!

  });

  socket.on("userCount", () => {  // Request

  return sockets.size;

  });

  

  socket.on("checkError", () => { // Request rejecting the Promise

      throw 'Yep, errors work'

  })

  socket.on("transferFile", (filename, buffer) => {

    return new Promise((resolve, reject) => {

      fs.writeFile(filename, Buffer.from(buffer), function(err) { // Save binary data recieved to file

        if(err)

          reject(err)

        else{

          resolve(true)

          console.log('File received and saved!')

        }

      })

    })

  })

  socket.on("disconnect", (event) => {

      console.log(`REASON: ${event.reason} CODE: ${event.code}`) // REASON: break time    CODE: 1007

      sockets.delete(socket);

  });

})

console.log('Listening on port: ' + PORT)

```