Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skyost/bonsoir
A Zeroconf library that allows you to discover network services and to broadcast your own. Based on Apple Bonjour and Android NSD.
https://github.com/skyost/bonsoir
android-nsd bonjour broadcast dart discover flutter mdns network nsd package zeroconf zeroconf-library
Last synced: 1 day ago
JSON representation
A Zeroconf library that allows you to discover network services and to broadcast your own. Based on Apple Bonjour and Android NSD.
- Host: GitHub
- URL: https://github.com/skyost/bonsoir
- Owner: Skyost
- License: other
- Created: 2020-08-04T20:07:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T18:37:00.000Z (6 months ago)
- Last Synced: 2024-10-22T20:16:29.369Z (4 months ago)
- Topics: android-nsd, bonjour, broadcast, dart, discover, flutter, mdns, network, nsd, package, zeroconf, zeroconf-library
- Language: Dart
- Homepage: http://bonsoir.skyost.eu/
- Size: 3.82 MB
- Stars: 110
- Watchers: 7
- Forks: 48
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
_Bonsoir_ is a Zeroconf library that allows you to discover network services and to broadcast your own.
It's based on [Android NSD](https://developer.android.com/training/connect-devices-wirelessly/nsd)
and on Apple's popular framework [Bonjour](https://developer.apple.com/documentation/foundation/bonjour).
In fact, Bonsoir can be translated into Good evening (and Bonjour into Good morning
or Good afternoon depending on the current moment of the day).
[](https://pub.dev/packages/bonsoir/score)
[](https://pub.dev/packages/bonsoir/score)
[](https://pub.dev/packages/bonsoir/score)
[](https://github.com/invertase/melos)
## Preview
## Installation
See [how to install](https://bonsoir.skyost.eu/docs#installation) on the Bonsoir website.
## Code snippet
Here is how you can broadcast your service using _Bonsoir_ :
```dart
// Let's create our service !
BonsoirService service = BonsoirService(
name: 'My wonderful service', // Put your service name here.
type: '_wonderful-service._tcp', // Put your service type here. Syntax : _ServiceType._TransportProtocolName. (see http://wiki.ros.org/zeroconf/Tutorials/Understanding%20Zeroconf%20Service%20Types).
port: 3030, // Put your service port here.
);
// And now we can broadcast it :
BonsoirBroadcast broadcast = BonsoirBroadcast(service: service);
await broadcast.ready;
await broadcast.start();
// ...
// Then if you want to stop the broadcast :
await broadcast.stop();
```
And here is how you can search for a broadcasted service :
```dart
// This is the type of service we're looking for :
String type = '_wonderful-service._tcp';
// Once defined, we can start the discovery :
BonsoirDiscovery discovery = BonsoirDiscovery(type: type);
await discovery.ready;
// If you want to listen to the discovery :
discovery.eventStream!.listen((event) { // `eventStream` is not null as the discovery instance is "ready" !
if (event.type == BonsoirDiscoveryEventType.discoveryServiceFound) {
print('Service found : ${event.service.toJson()}')
event.service!.resolve(discovery.serviceResolver); // Should be called when the user wants to connect to this service.
} else if (event.type == BonsoirDiscoveryEventType.discoveryServiceResolved) {
print('Service resolved : ${event.service.toJson()}')
} else if (event.type == BonsoirDiscoveryEventType.discoveryServiceLost) {
print('Service lost : ${event.service.toJson()}')
}
});
// Start the discovery **after** listening to discovery events :
await discovery.start();
// Then if you want to stop the discovery :
await discovery.stop();
```
If you want a full example, don't hesitate to check [this one](https://github.com/Skyost/Bonsoir/tree/master/packages/bonsoir/example) on Github.
## Contributions
You have a lot of options to contribute to this project ! You can :
* [Fork it](https://github.com/Skyost/Bonsoir/fork) on Github.
* [Submit](https://github.com/Skyost/Bonsoir/issues/new/choose) a feature request or a bug report.
* [Donate](https://paypal.me/Skyost) to the developer.