Pusher Client Socket

A Dart library for connecting to a Pusher server using WebSockets. This library provides an easy-to-use API for subscribing to channels, binding event listeners, and sending events to the server.

Features

• Connect to a Pusher server using WebSockets.
• Available for all platforms (Android, IOS, MacOS, WindowsOS, LinuxOS, Web).
• Subscribe to public, private, private encrypted, and presence channels.
• Bind event listeners to handle custom and Pusher-specific events.
• Automatic reconnection logic for handling connection interruptions.
• Activity check mechanism to ensure the connection remains active.

Installation

Add the following dependency to your pubspec.yaml file:

dependencies:
  pusher_client_socket: ^0.0.2+6

Then run:

flutter pub get

or using pub add:

flutter pub add pusher_client_socket

Usage

2. Import

/// Import the pusher client
import 'package:pusher_client_socket/pusher_client_socket.dart';

/// Importing the channels
import 'package:pusher_client_socket/channels/channel.dart';
import 'package:pusher_client_socket/channels/private_channel.dart';
import 'package:pusher_client_socket/channels/private_encrypted_channel.dart';
import 'package:pusher_client_socket/channels/presence_channel.dart';

2. Initialize the connection options

1. Pusher default server:

   final options = PusherOptions(
     key: 'PUSHER-KEY',
     cluster: 'mt1',
     wsPort: 80,
     wssPort: 443,
     authOptions: PusherAuthOptions(
       endpoint: 'http://localhost/broadcasting/auth',
       headers: {
         'Accept': 'application/json',
         'Authorization': 'Bearer AUTH-TOKEN'
       }
     ),
     autoConnect: false,
   );
   

2. Specify server (e.g: Laravel/Reverb):

   final options = PusherOptions(
     key: 'REVERB_APP_KEY',
     host: 'localhost', // REVERB_HOST
     wsPort: 6001, // REVERB_PORT
     encrypted: false, // (Note: enable it if you'r using wss connection)
     authOptions: PusherAuthOptions(
       endpoint: 'http://localhost/broadcasting/auth',
       headers: {
         'Accept': 'application/json',
         'Authorization': 'Bearer AUTH-TOKEN'
       }
     ),
     autoConnect: false,
   );
   

3. Initialize the client and connect

final pusherClient = PusherClient(options);
pusherClient.onConnectionEstablished((data) {
  print("Connection established - socket-id: ${pusherClient.socketId}");
});
pusherClient.onConnectionError((error) {
  print("Connection error - $error");
});
pusherClient.onError((error) {
  print("Error - $error");
});
pusherClient.onDisconnected((data) {
  print("Disconnected - $data");
});
pusherClient.connect();

4. Subscribe to channels

/// Subscribe to public channel
final publicChannel = pusherClient.channel('channel-1');

/// Subscribe to private channel
final privateChannel = pusherClient.channel('private-channel-2');
// or
final privateChannel = pusherClient.private('channel-2');

/// Subscribe to private encrypted channel
final privateEncryptedChannel = pusherClient.channel('private-encrypted-channel-3');
// or
final privateEncryptedChannel = pusherClient.privateEncrypted('channel-3');

/// Subscribe to presence channel
final presenceChannel = pusherClient.channel("presence-channel-4");
// or
final presenceChannel = pusherClient.presence("channel-4");

5. Listening to event

channel.bind('EventName', (data) {
  print('event received - EventName - $data');
});

6. Send trigger (in private or presence channel)

privateChannel.trigger('client-EventName', data);
// or
privateChannel.trigger('EventName', data);
// or
presenceChannel.trigger('client-EventName', data);
// or
presenceChannel.trigger('EventName', data);

7. Unsubscribing from channel

channel.unsubscribe();

Pusher Client Options

Pusher Auth Options

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.