laravel_echo_null 0.0.3

This Package is the improved version of the original package "laravel_echo", with some modifications and features.

Getting started

laravel_echo_null

Importing

import 'package:laravel_echo_null/laravel_echo_null.dart';

Initializing

• Simple initialization:

  Echo echo = Echo(Connector(ConnectorOptions(
    client, // T: Socket / PusherClient
    auth: {}, // Map?: auth options
    authEndpoint: 'http://localhost/broadcasting/auth', // String?: auth host
    host: 'http://localhost', // String?: host
    key: 'CLIENT_KEY', // String?: client key
    namespace: 'namespace', // String?: namespace
    autoConnect: false, // bool: client connection automatically
    moreOptions: {}, // Map: more echo options
  )));
  

• Initialization using connector:

  //// Socket IO ////
  import 'package:socket_io_client/socket_io_client.dart';
  
  Socket socket = io('http://localhost');
  Echo<Socket> echo = Echo<Socket>(SocketIoConnector(
    socket, // Socket: Socket client
    auth: {}, // Map?: auth options
    authEndpoint: 'http://localhost/broadcasting/auth', // String?: auth host
    host: 'http://localhost', // String?: host
    key: 'CLIENT_KEY', // String?: client key
    namespace: 'namespace', // String?: namespace
    autoConnect: false, // bool: client connection automatically
    moreOptions: {}, // Map: more echo options
  ));
  
  ///// Pusher ////
  import 'package:pusher_client/pusher_client.dart';
  
  PusherClient pusher = PusherClient(
    'PUSHER_APP_KEY',
    PusherOptions(
      host: 'http://localhost',
      wsPort: 6001,
      cluster: 'mt1',
      auth: PusherAuth(
        'http://localhost/broadcasting/auth',
        headers: {
          'Authorization': 'Bearer $token',
          'Content-Type': 'application/json',
          'Accept': 'application/json',
        },
      ),
    ),
    autoConnect: false,
    enableLogging: true,
  );
  Echo<PusherClient> echo = Echo<PusherClient>(PusherConnector(
    pusher, // PusherClient: Pusher client
    auth: {}, // Map?: auth options
    authEndpoint: 'http://localhost/broadcasting/auth', // String?: auth host
    host: 'http://localhost', // String?: host
    key: 'PUSHER_KEY', // String?: client key
    namespace: 'namespace', // String?: namespace
    autoConnect: false, // bool: client connection automatically
    moreOptions: {}, // Map: more echo options
  ));
  

• Easy initialization:

  //// Socket IO ////
  import 'package:socket_io_client/socket_io_client.dart';
  
  Echo echo = Echo.socket(
    'http://127.0.0.1:6001',
    autoConnect: false,
    auth: {
      'headers': {'Authorization': 'Bearer $token'}
    },
    moreOptions: {
      'transports': ['websocket'],
    },
  );
  
  ///// Pusher ////
  import 'package:pusher_client/pusher_client.dart';
    
  PusherOptions options = PusherOptions(
    host: 'http://localhost',
    wsPort: 6001,
    cluster: 'mt1',
    auth: PusherAuth(
      'http://localhost/broadcasting/auth',
      headers: {
        'Authorization': 'Bearer $token',
        'Content-Type': 'application/json',
        'Accept': 'application/json',
      },
    ),
  );
  
  Echo echo = Echo.pusher(
    'PUSHER_KEY',
    options,
    autoConnect: false,
    auth: options.auth?.toJson(),
    authEndpoint: options.auth?.endpoint,
    host: options.host,
    moreOptions: {
      'cluster': options.cluster,
      'encrypted': options.encrypted,
      'activityTimeout': options.activityTimeout,
      'pongTimeout': options.pongTimeout,
      'wsPort': options.wsPort,
      'wssPort': options.wssPort,
      'maxReconnectionAttempts': options.maxReconnectionAttempts,
      'maxReconnectGapInSeconds': options.maxReconnectGapInSeconds,
    },
  );
  
  

Channels

// public channel
Channel publicChannel = echo.channel('my-channel');
publicChannel.listen('MyEvent', (data) {
  print(data);
});

// private channel
Channel privateChannel = echo.private('my-channel.1')
privateChannel.listen('MyEvent', (data) {
  print(data);
});

// presence channel
PresenceChannel presenceChannel = echo.join('presence-channel');
presenceChannel.listen((data) {
  print(data);
});

Note: This Package is the improved version of the original package "laravel_echo", with some modifications and features

Powered By Abdo-Pr