Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haidar0096/fsignalr
Signalr implementation for Flutter to enable integration of real-time communication in Flutter apps.
https://github.com/haidar0096/fsignalr
Last synced: about 2 months ago
JSON representation
Signalr implementation for Flutter to enable integration of real-time communication in Flutter apps.
- Host: GitHub
- URL: https://github.com/haidar0096/fsignalr
- Owner: Haidar0096
- License: bsd-3-clause
- Created: 2024-04-22T19:30:34.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-07T09:38:39.000Z (8 months ago)
- Last Synced: 2024-05-07T10:46:13.339Z (8 months ago)
- Language: Java
- Homepage: https://pub.dev/packages/fsignalr
- Size: 124 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# fsignalr
Signalr client for Flutter.
## Usage
```dart
import 'package:fsignalr/fsignalr.dart';
class HubMethodHandler {
final String methodName;
final int argsCount;
final void Function(String methodName, List? args)? handler;
const HubMethodHandler({
required this.methodName,
required this.argsCount,
required this.handler,
});
}
const appHubMethodHandlers = [
HubMethodHandler(
methodName: 'NoArgsEchoMethod',
argsCount: 0,
handler: noArgsMethodHandler,
),
HubMethodHandler(
methodName: 'OneArgEchoMethod',
argsCount: 1,
handler: oneArgMethodHandler,
),
HubMethodHandler(
methodName: 'TwoArgsEchoMethod',
argsCount: 2,
handler: twoArgsMethodHandler,
),
];
void noArgsMethodHandler(String methodName, List? args) {
print('NoArgsEchoMethod received, args: $args');
}
void oneArgMethodHandler(String methodName, List? args) {
print('OneArgEchoMethod received, args: $args');
}
void twoArgsMethodHandler(String methodName, List? args) {
print('TwoArgsEchoMethod received, args: $args');
}
Future setUpConnection() async {
try {
// Create the hub connection manager
final HubConnectionManager manager = HubConnectionManager();
// Initialize the hub connection manager, this must be done
// before calling any other method on the manager
await manager.init(
baseUrl: 'https://myserver.com/hub',
transportType: TransportType.all,
headers: {'myHeaderKey': 'myHeaderValue'},
accessToken: 'myToken',
handShakeResponseTimeout: const Duration(seconds: 10),
keepAliveInterval: const Duration(seconds: 20),
serverTimeout: const Duration(seconds: 30),
handledHubMethods: appHubMethodHandlers
.map(
(appHubMethodHandler) =>
(
methodName: appHubMethodHandler.methodName,
argCount: appHubMethodHandler.argsCount,
),
)
.toList(),
);
// Listen to the connection state
manager.onHubConnectionStateChangedCallback = (state) {
print('Connection state changed to: $state');
};
// listen to received messages from the server
// this listener will only be invoked for the hub methods with names that
// were registered in the handledHubMethods list
manager.onMessageReceivedCallback = (methodName, args) {
for (final appHubMethodHandler in appHubMethodHandlers) {
if (methodName == appHubMethodHandler.methodName) {
appHubMethodHandler.handler?.call(methodName, args);
break; // or you can not break if you want to call all
// the handlers that have the same method name
}
}
};
// listen to connection-closed callback
manager.onConnectionClosedCallback = (exception) {
print('Connection closed, exception: $exception');
};
// Start the connection
await manager.startConnection();
// invoke methods on the server
await manager.invoke(
methodName: 'MyServerMethodName',
args: ['myFirstArg', 'mySecondArg'],
);
// stop the connection
await manager.stopConnection();
// start the connection again, if you want :)
await manager.startConnection();
// dispose the hub connection manager when done (also stops the connection)
await manager.dispose();
} catch (e) {
print('Error has occurred: $e');
}
}
```
# Acknowledgements
- For android implementation, uses the
official [SignalR client for Java](https://github.com/dotnet/aspnetcore/tree/main/src/SignalR/clients/java/signalr)
by Microsoft.
# Limitations
- Currently only works on android
- Currently only supports websocket transport and long polling as per
the [official documentation](https://learn.microsoft.com/en-us/aspnet/core/signalr/java-client?view=aspnetcore-8.0#known-limitations)
- Min Android sdk supported is
20 [reason](https://learn.microsoft.com/en-us/aspnet/core/signalr/java-client?view=aspnetcore-8.0#android-development-notes)
# Future Work
- [ ] Add support for iOS
- Expose more functionality from the SignalR client for Java (if requested)