https://github.com/wangyng/better_web_socket

Advanced web socket based on web_socket_channel.
https://github.com/wangyng/better_web_socket

Last synced: about 2 months ago
JSON representation

Advanced web socket based on web_socket_channel.

• Host: GitHub
• URL: https://github.com/wangyng/better_web_socket
• Owner: WangYng
• License: bsd-3-clause
• Created: 2021-04-02T10:27:27.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-19T09:17:22.000Z (11 months ago)
• Last Synced: 2024-02-19T10:36:39.291Z (11 months ago)
• Language: Dart
• Size: 119 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# better_web_socket

Advanced web socket based on web_socket_channel.

## Install Started

1. Add this to your **pubspec.yaml** file:

```yaml

dependencies:

  better_web_socket: ^1.0.1

```

2. Install it

```bash

$ flutter packages get

```

## Normal usage

```dart

void receiveData(BuildContext context) {

  MyWebSocketController controller = context.read();

  receiveDataSubscription?.cancel();

  receiveDataSubscription = controller.receiveDataStream.listen((data) {

    int clientRequestId = parse(data).clientRequestId; // TODO  clientRequestId from server

    controller.handleSendDataResponse(clientRequestId, BetterWebSocketSendDataResponseState.SUCCESS);

  });

  sendDataResponseStateSubscription?.cancel();

  sendDataResponseStateSubscription = controller.sendDataResponseStateStream.listen((data) {

    int clientRequestId = data.item1;

    if (clientRequestIdList.contains(clientRequestId)) {

      clientRequestIdList.remove(clientRequestId);

      String result = "";

      switch (data.item2) {

        case BetterWebSocketSendDataResponseState.SUCCESS:

          result = "send data success";

          break;

        case BetterWebSocketSendDataResponseState.FAIL:

          result = "send data failure";

          break;

        case BetterWebSocketSendDataResponseState.TIMEOUT:

          result = "send data timeout";

          break;

      }

      print(result);

    }

  });

}

void connect(BuildContext context) {

  context.read().startWebSocketConnect(retryCount: double.maxFinite.toInt());

}

void disconnect(BuildContext context, Duration duration) {

  context.read().stopWebSocketConnectAfter(duration: duration);

}

void sendData() {

  context.read().sendDataAndWaitResponse(clientRequestId, data, retryCount: 3);

}

```

## Feature

- [x] reconnect

- [x] delay disconnect

- [x] simulate HTTP request

- [x] auto login when socket connected