# centrifuge 0.1.0

Dart client to communicate with Centrifuge and Centrifugo from Flutter and VM over dart:io WebSocket





## Installing
```
export PUB_HOSTED_URL=https://pub.mirror.p-hatan.ir
flutter pub add 'centrifuge:0.1.0'
```
Published: 2018-09-15T12:55:03.008504Z
Expected archive SHA-256: 09f7e4de0dc85f7ea540726e410510a3b858155fc7bf5caf376f1ff5576b0b62

Available in cache; verification: upstream_checksum
## Direct dependencies
- meta: ^1.1.5
- protobuf: ^0.9.1

## Package README (untrusted upstream documentation)
[![Build Status](https://travis-ci.org/centrifugal/centrifuge-dart.svg?branch=master)](https://travis-ci.org/centrifugal/centrifuge-dart)


## Example

Examples:
* `example\flutter_app` simple chat application
* `example\console` simple console application 

## Usage

Create client:

```dart
import 'package:centrifuge/centrifuge.dart' as centrifuge;

final client = centrifuge.createClient(url);
```
Connect to server:
```dart
await client.connect();
```
Subscribe to channel:
```dart
final subscription = client.subscribe(channel);

subscription.publishStream.listen(onEvent);
subscription.joinStream.listen(onEvent);
subscription.leaveStream.listen(onEvent);

subscription.subscribeSuccessStream.listen(onEvent);
subscription.subscribeErrorStream.listen(onEvent);
subscription.unsubscribeStream.listen(onEvent);
```
Subscribe to private channel:
```dart
final privateSubscription = client.subscribe(channel, token: 'token');
```
Publish:
```dart
final output = jsonEncode({'input': message});
final data = utf8.encode(output);
await subscription.publish(data);
```


## Checklist:

- [ ] connect to server using JSON protocol format
- [x] connect to server using Protobuf protocol format
- [x] connect with JWT
- [ ] connect with custom header
- [ ] support automatic reconnect in case of errors, network problems etc
- [ ] connect and disconnect events
- [ ] handle disconnect reason
- [x] subscribe on channel and handle asynchronous Publications
- [x] handle Join and Leave messages
- [x] handle unsubscribe notifications
- [ ] handle subscribe error
- [ ] support publish, presence, presence stats and history methods
- [ ] send asynchronous messages to server
- [x] handle asynchronous messages from server
- [ ] send RPC commands
- [x] subscribe to private channels with JWT
- [ ] support connection JWT refresh
- [ ] support private channel subscription JWT refresh
- [ ] ping/pong to find broken connection
- [ ] support message recovery mechanism

## Author

German Saprykin, saprykin.h@gmail.com

## Changelog
## [0.1.0]
* Added authorization with JWT
* Added subscription to private channel with JWT

## [0.0.1]

* Initial release