Croupier

A custom SocketCluster client implementation for Dart and Flutter, designed to closely reflect the SocketCluster JavaScript client's API.

Released under an MIT license. Feel free to use or adapt this code as you want, though if you do, please credit me your README or something.

Usage

You can install it using the package on pub.dev - by adding the latest version to your project's pubspec.yaml (instructions on the linked pub.dev page).

A simple usage example:

import 'package:croupier/croupier.dart';

void main() async {
  
  // Create the client.
  var client = SocketClusterClient(
    hostname: 'localhost',
    port: 3000,
    ackTimeout: 500,
  );
  
  // Connect to the server.
  await client.connect();
  
  // Use the client; (invokes 'myProcedure' on the server.)
  var response = await client.invoke('myProcedure');
  print(response);
  
  // Close the client to clean up resources and
  // cleanly disconnect from the server.
  await client.close();
  
}

For more examples and guides, please see the project wiki.

Dart API Documentation

Auto-generated API documentation is available at: https://pub.dev/documentation/croupier/latest/

Features and bugs

Please file feature requests and bugs at the issue tracker.

Test

Unit tests are included.
Run dart pub run test to execute the unit tests.