centrifugal/centrifuge-dart

Technical topics

# dart # flutter # centrifugo # centrifuge # websocket

Dependencies used

Dependency list 8 items

fixnum^1.0.0
meta^1.3.0
protobuf>=5.0.0 <7.0.0
web_socket_channel>=3.0.0 <4.0.0
build_runnerDevelopment^2.0.3
httpDevelopment^1.1.0
mockitoDevelopment^5.0.7
testDevelopment^1.17.4

Original README

English project snapshot. Visit GitHub for the latest content.

Expand / collapse project README

Websocket client for Centrifugo server and Centrifuge library.

Since there is no v1 release yet, patch version updates only contain backwards compatible changes, minor version updates can have backwards incompatible API changes.

Check out client SDK API specification to learn how this SDK behaves. It's recommended to read that before starting to work with this SDK as the spec covers common SDK behavior - describes client and subscription state transitions, main options and methods. Also check out examples folder.

The features implemented by this SDK can be found in SDK feature matrix.

Note that custom WebSocket connection Upgrade headers are sent natively on platforms that support dart:io and in web context headers are sent using Centrifugo v6 Headers Emulation feature.

The latest centrifuge-dart is compatible with Centrifugo server v6, v5 and v4 and Centrifuge >= 0.25.0. For Centrifugo v2, Centrifugo v3 and Centrifuge < 0.25.0 you should use centrifuge-dart v0.8.0.

Examples

example\flutter_app simple chat application
example\chat_app one more chat example
example\console simple console application

Usage in background

When a mobile application goes to the background there are OS-specific limitations for established persistent connections - which can be silently closed shortly. Thus in most cases you need to disconnect from a server when app moves to the background and connect again when app goes to the foreground.

Alternative SDK

See also PlugFox/spinify for an alternative Dart (Flutter) real-time client SDK implementation.

Run tests locally

Start test Centrifugo server:

docker compose up

Then run tests:

dart run test --reporter expanded

Instructions for maintainers/contributors

How to update protobuf definitions

Install protoc compiler
Install protoc_plugin https://pub.dev/packages/protoc_plugin (dart pub global activate protoc_plugin)
cd lib/src/proto and run protoc --dart_out=. -I . client.proto
cd to root and run dartfmt -w lib/ test/ (install dartfmt with dart pub global activate dart_style)

How to release

Update CHANGELOG.md, bump version in pubspec.yaml, push, create new tag
[ONLY IF THERE ARE ISSUES WITH CI PUBLISH] dart pub publish

Author

German Saprykin, saprykin.h@gmail.com