codebase_echo

Description:

codebase echo

Laravel Echo for Flutter #
Basically, this package is port of official Laravel Echo javascript library. It helps subscribe to channels and listen for events broadcasted from your Laravel app.
API is mostly same as official Echo package, so everything in Official documentation should work.
Available connectors:

Laravel Echo Server (SocketIO)


Getting started #
Laravel Echo Server Socket.IO #
To use with socket.io, you need to install socket_io_client for your Flutter app.
In your pubspec.yaml file:
dependencies:
...
socket_io_client: ^1.0.2
copied to clipboard
import socket_io_client
import 'package:codebase_echo/codebase_echo.dart';
import 'package:socket_io_client/socket_io_client.dart' as IO;
copied to clipboard
usage
const String BEARER_TOKEN = 'YOUR_BEARER_TOKEN_HERE';

// Create socket.io client
IO.Socket socket = IO.io(
'http://localhost:6001',
IO.OptionBuilder()
.disableAutoConnect()
.setTransports(['websocket']).build(),
);

// Create echo instance
Echo echo = new Echo(
broadcaster: EchoBroadcasterType.SocketIO,
client: socket,
options: {
'auth': {
'headers': {
'Authorization': 'Bearer $BEARER_TOKEN',
}
},
},
);

// Listening public channel
echo.channel('public-channel').listen('PublicEvent', (e) {
print(e);
});

// Listening private channel
// Needs auth. See details how to authorize channel below in guides
echo.private('private-channel').listen('PrivateEvent', (e) {
print(e);
});


// Whispering to a channel
echo.private('private-channel').whisper('typing', {
'user': 1
});

// Listening to a whisper
echo.private('private-channel').listenForWhisper('typing', (e) {
print(e);
});


// Listening presence channel
// Needs auth. See details how to authorize channel below in guides
echo.join('presence-channel')
.here((users) {
print(users);
}).joining((user) {
print(user);
}).leaving((user) {
print(user);
}).listen('PresenceEvent', (e) {
print(e);
});

// Accessing socket instance
echo.connector.socket.onConnect((_) => print('connected'));
echo.connector.socket.onDisconnect((_) => print('disconnected'));
copied to clipboard
Guide #
Options #



Option
Description
Default




auth




authEndpoint

/api/broadcasting/auth


broadcaster

EchoBroadcasterType.Pusher


host
Socket host
http://localhost:6001


namespace
Event namespace
App.Events


...
Any other options, passed as socket params




Sample backend #
Backend used for example app could be found at echo-server
Credits #
This package would not be existed without hard work of these awesome devs.

@chinloyal - maintainer of pusher_client
@rikolu - maintainer of socket_io_client
@heywhy - for initial Pusher intagration
@kakajansh - initial package