Bonsoir

https://pub.dev/documentation/bonsoir/latest
Admin
Bonsoir is a Dart/Flutter plugin that enables network service discovery and broadcasting using mDNS...
Tokens:31,858
Snippets:468
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### start()

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler-class.html

Starts the action.

```APIDOC
## start()

### Description
Starts the action.

### Method
Future<void>

### Returns
A Future that completes when the action has started.
```

--------------------------------

### start()

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcast-class.html

Starts the Bonsoir broadcast action.

```APIDOC
## start()

### Description
Starts the action.

### Returns
- Future<void>
```

--------------------------------

### start() Method

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction-class.html

Starts the required action, such as discovery or broadcast.

```APIDOC
## start()

### Description

This starts the required action (eg. discovery, or broadcast).

### Method

`Future<void>`

### Parameters

None
```

--------------------------------

### start method

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/start.html

Starts the action. This method initiates the Bonsoir action handler.

```APIDOC
## start method

### Description
Starts the action.

### Signature
Future<void> start()

### Implementation
```dart
Future<void> start() => _action.start();
```
```

--------------------------------

### Get isReady Property

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction/isReady.html

Use this property to check if the platform is ready for the action. No specific setup is required beyond having Bonsoir initialized.

```dart
bool get isReady;
```

--------------------------------

### start

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction/start.html

This starts the required action (eg. discovery, or broadcast).

```APIDOC
## start abstract method

### Description
This starts the required action (eg. discovery, or broadcast).

### Method Signature
Future<void> start()

### Implementation Example
```dart
Future<void> start();
```
```

--------------------------------

### start

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirAction/start.html

Starts the required action (e.g., discovery, or broadcast). This method should only be called after the instance has been initialized and before it has been stopped.

```APIDOC
## start

### Description
Starts the required action (eg. discovery, or broadcast).

### Method Signature
Future<void> start()

### Preconditions
- The action must not be stopped.
- The action must be initialized. Call `await ClassName.initialize()` before calling `start()`.
- If `stop()` has been called previously, a new instance must be created.

### Implementation Details
This method invokes the platform channel method '$_classType.start' with the current instance's data.
```

--------------------------------

### Start Method Implementation

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirAction/start.html

This method starts the required action. It includes assertions to ensure the action is not stopped and is ready for initialization. It invokes the 'start' method on the MethodChannel.

```dart
@override
Future<void> start() {
  assert(!isStopped, 'You should not try to start a stopped action.');
  assert(isReady, '''$runtimeType should be initialized in order to call this method.
You must wait until this instance is initialized by calling "await $runtimeType.initialize()".
If you have previously called "$runtimeType.stop()" on this instance, you have to create a new instance of this class.''');
  return _channel.invokeMethod('$_classType.start', toJson());
}
```

--------------------------------

### Discover Services with Bonsoir

Source: https://pub.dev/documentation/bonsoir/latest/index.html

This snippet demonstrates how to search for broadcasted services. It includes setting up the discovery, listening for events (found, resolved, updated, lost), and starting/stopping the discovery process. Make sure to start listening to the event stream before starting the discovery.

```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.initialize();

// If you want to listen to the discovery :
discovery.eventStream!.listen((event) { // `eventStream` is not null as the discovery instance is "ready" !
  switch (event) {
    case BonsoirDiscoveryServiceFoundEvent():
      print('Service found : ${event.service.toJson()}');
      event.service!.resolve(discovery.serviceResolver); // Should be called when the user wants to connect to this service.
      break;
    case BonsoirDiscoveryServiceResolvedEvent():
      print('Service resolved : ${event.service.toJson()}');
      break;
    case BonsoirDiscoveryServiceUpdatedEvent():
      print('Service updated : ${event.service.toJson()}');
      break;
    case BonsoirDiscoveryServiceLostEvent():
      print('Service lost : ${event.service.toJson()}');
      break;
    default:
      print('Another event occurred : $event.');
      break;
  }
});

// Start the discovery **after** listening to discovery events :
await discovery.start();

// Then if you want to stop the discovery :
await discovery.stop();

```

--------------------------------

### initialize() Method

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction-class.html

Initializes the action and prepares the platform. This method should be awaited before starting the action to ensure the plugin is ready.

```APIDOC
## initialize()

### Description

The initialize method, that should be called before starting the action. Await this method to know when the plugin will be ready.

### Method

`Future<void>`

### Parameters

None
```

--------------------------------

### initialize

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction/initialize.html

The initialize method, that should be called before starting the action. Await this method to know when the plugin will be ready.

```APIDOC
## initialize abstract method

### Description
The initialize method, that should be called before starting the action. Await this method to know when the plugin will be ready.

### Method
Future<void>

### Signature
Future<void> initialize();
```

--------------------------------

### initialize()

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler-class.html

The initialize method, that should be called before starting the action. Await this method to know when the plugin will be ready.

```APIDOC
## initialize()

### Description
The initialize method, that should be called before starting the action. Await this method to know when the plugin will be ready.

### Method
Future<void>

### Returns
A Future that completes when the plugin is ready.
```

--------------------------------

### Start Abstract Method

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction/start.html

This is an abstract method declaration. Implementations should start the required action, like discovery or broadcasting.

```dart
Future<void> start();
```

--------------------------------

### initialize()

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcast-class.html

Initializes the Bonsoir broadcast. This method should be awaited before starting the broadcast to ensure the plugin is ready.

```APIDOC
## initialize()

### Description
The initialize method, that should be called before starting the action. Await this method to know when the plugin will be ready.

### Returns
- Future<void>
```

--------------------------------

### Start Action Handler

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/start.html

Initiates the action. This method is part of the BonsoirActionHandler.

```dart
Future<void> start() => _action.start();
```

--------------------------------

### BonsoirDiscoveryStartedEvent.new

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryStartedEvent/BonsoirDiscoveryStartedEvent.html

Creates a new Bonsoir discovery started event instance.

```APIDOC
## BonsoirDiscoveryStartedEvent()

### Description
Creates a new Bonsoir discovery started event instance.

### Method
Constructor

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Implementation
```dart
const BonsoirDiscoveryStartedEvent();
```
```

--------------------------------

### initialize

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirAction/initialize.html

Initializes the Bonsoir plugin. This method should be called before starting any Bonsoir action. Awaiting this method ensures the plugin is ready.

```APIDOC
## initialize

### Description
Initializes the Bonsoir plugin. This method should be called before starting any Bonsoir action. Awaiting this method ensures the plugin is ready.

### Method Signature
Future<void> initialize()

### Implementation Notes
This method checks if an event stream is already established. If not, it invokes the 'initialize' method on the platform channel and sets up a broadcast stream for receiving platform events.
```

--------------------------------

### BonsoirDiscoveryStartedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryStartedEvent-class.html

Creates a new Bonsoir discovery started event instance.

```APIDOC
## BonsoirDiscoveryStartedEvent()

### Description
Creates a new Bonsoir discovery started event instance.

### Method
Constructor

### Parameters
None
```

--------------------------------

### Initialize Bonsoir Action Handler

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/initialize.html

Call this method before starting any actions. Await its completion to ensure the plugin is ready.

```dart
Future<void> initialize() => _action.initialize();
```

--------------------------------

### initialize

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/initialize.html

Initializes the action handler. This method should be called before starting any actions and must be awaited to ensure the plugin is ready.

```APIDOC
## initialize

### Description
Initializes the action handler. This method should be called before starting any actions and must be awaited to ensure the plugin is ready.

### Method
Future<void>

### Parameters
None

### Request Example
None

### Response
None

### Implementation
```dart
Future<void> initialize() => _action.initialize();
```
```

--------------------------------

### Initialize Bonsoir MethodChannel Action

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirAction/initialize.html

Call this method before starting any Bonsoir actions. Awaiting this method ensures the plugin is fully initialized and ready for use. It sets up the communication channel and event stream.

```dart
@override
Future<void> initialize() async {
  if (eventStream == null) {
    await _channel.invokeMethod('$_classType.initialize', toJson());
    _eventStream = EventChannel('$_channelName.$_classType.$_id').receiveBroadcastStream().map(transformPlatformEvent);
  }
}
```

--------------------------------

### BonsoirBroadcastStartedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcastStartedEvent/BonsoirBroadcastStartedEvent.html

Creates a new Bonsoir broadcast started event instance.

```APIDOC
## BonsoirBroadcastStartedEvent constructor

### Description
Creates a new Bonsoir broadcast started event instance.

### Method
constructor

### Parameters
#### Path Parameters
- **id** (String?) - Optional - The ID of the event.
- **service** (BonsoirService) - Required - The Bonsoir service instance.

### Implementation
```dart
const BonsoirBroadcastStartedEvent({
  super.id,
  required BonsoirService super.service,
});
```
```

--------------------------------

### Create BonsoirDiscoveryStartedEvent Instance

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryStartedEvent/BonsoirDiscoveryStartedEvent.html

Use this constructor to create a new instance of a Bonsoir discovery started event.

```javascript
const BonsoirDiscoveryStartedEvent();
```

--------------------------------

### Get BonsoirPlatformInterface Instance

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirPlatformInterface/instance.html

Provides a getter for the BonsoirPlatformInterface instance, allowing for better control over its access.

```APIDOC
## Get Instance

### Description
Getter for better control.

### Implementation
```dart
static BonsoirPlatformInterface get instance => _instance;
```
```

--------------------------------

### Common Service Type Examples

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/type.html

Illustrates common service type formats used in Bonsoir, including scanner, http, webdav, and tftp protocols.

```plaintext
_scanner._tcp
_http._tcp
_webdave._tcp
_tftp._udp
```

--------------------------------

### BonsoirBroadcastStartedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcastStartedEvent/BonsoirBroadcastStartedEvent.html

Creates a new Bonsoir broadcast started event instance. Requires a service and optionally accepts an ID.

```dart
const BonsoirBroadcastStartedEvent({
  super.id,
  required BonsoirService super.service,
});
```

--------------------------------

### Get BonsoirPlatformInterface Instance

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirPlatformInterface/instance.html

Use this getter to retrieve the singleton instance of BonsoirPlatformInterface for controlled access.

```dart
static BonsoirPlatformInterface get instance => _instance;
```

--------------------------------

### discoveryStarted Constant Implementation

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryStartedEvent/discoveryStarted-constant.html

This constant represents the event ID for discovery started. It is defined as a static string.

```dart
static const String discoveryStarted = 'discoveryStarted';
```

--------------------------------

### Dynamic Member Access Error Example

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/ServiceResolver/noSuchMethod.html

Demonstrates how accessing a non-existent method on a dynamic object triggers a runtime error by invoking noSuchMethod.

```dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error
```

--------------------------------

### isReady Property

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction/isReady.html

Returns whether the platform is ready for this action.

```APIDOC
## isReady Property

### Description
This returns whether the platform is ready for this action.

### Method
GET

### Endpoint
/isReady

### Response
#### Success Response (200)
- **isReady** (bool) - Indicates if the platform is ready.
```

--------------------------------

### runtimeType Property

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/ServiceResolver/runtimeType.html

Gets a representation of the runtime type of the object.

```APIDOC
## runtimeType Property

### Description
A representation of the runtime type of the object.

### Type
Type

### Implementation
```dart
external Type get runtimeType;
```
```

--------------------------------

### Constructors

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcastEvent-class.html

Information on how to create instances of BonsoirBroadcastEvent.

```APIDOC
## Constructors

### `BonsoirBroadcastEvent({String? id, BonsoirService? service})`

Creates a new Bonsoir broadcast event.

### `BonsoirBroadcastEvent.fromId({required String id, BonsoirService? service})`

Creates a BonsoirBroadcastEvent from its `id`.

### `BonsoirBroadcastEvent.fromJson(Map<String, dynamic> json)`

Creates a BonsoirBroadcastEvent from a `json` map.
```

--------------------------------

### BonsoirPlatformInterface constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirPlatformInterface/BonsoirPlatformInterface.html

Creates a new Bonsoir platform interface instance.

```APIDOC
## BonsoirPlatformInterface()

### Description
Creates a new Bonsoir platform interface instance.

### Method
constructor

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **BonsoirPlatformInterface** (object) - A new instance of the Bonsoir platform interface.

### Response Example
None
```

--------------------------------

### isReady Property

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction-class.html

Indicates whether the platform is ready for this action.

```APIDOC
## isReady

### Description

This returns whether the platform is ready for this action.

### Type

`bool`

### Access

Read-only
```

--------------------------------

### BonsoirServiceNormalizer Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirServiceNormalizer/BonsoirServiceNormalizer.html

Initializes a new instance of the BonsoirServiceNormalizer class.

```APIDOC
## BonsoirServiceNormalizer()

### Description

Initializes a new instance of the BonsoirServiceNormalizer class.

### Method

Constructor

### Parameters

None

### Request Example

```
BonsoirServiceNormalizer()
```

### Response

#### Success Response (Instance)

- **BonsoirServiceNormalizer** (object) - A new instance of the BonsoirServiceNormalizer.
```

--------------------------------

### eventStream Property

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction-class.html

Provides a stream to receive updates from this instance. Subscribe to this stream to get notified of events.

```APIDOC
## eventStream

### Description

The event stream. Subscribe to it to receive this instance updates.

### Type

`Stream<T>?`

### Access

Read-only
```

--------------------------------

### BonsoirPlatformInterfaceLogMessages()

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirPlatformInterfaceLogMessages/BonsoirPlatformInterfaceLogMessages.html

Initializes a new instance of the BonsoirPlatformInterfaceLogMessages class.

```APIDOC
## BonsoirPlatformInterfaceLogMessages()

### Description
Initializes a new instance of the BonsoirPlatformInterfaceLogMessages class.

### Method
constructor

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Get isStopped Status

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction/isStopped.html

Use this property to check if the platform has discarded the action. It returns a boolean value.

```dart
bool get isStopped;
```

--------------------------------

### BonsoirService Constructors

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService-class.html

Provides different ways to create a BonsoirService instance, including default initialization, from JSON, and ignoring normalization rules.

```APIDOC
## BonsoirService Constructors

### BonsoirService
Creates a new Bonsoir service instance.

```dart
BonsoirService({required String name, required String type, String? host, required int port, Map<String, String> attributes = defaultAttributes})
```

### BonsoirService.fromJson
Creates a new Bonsoir service instance from the given JSON map.

```dart
BonsoirService.fromJson(Map<String, dynamic> json, {String prefix = 'service.'})
```

### BonsoirService.ignoreNorms
Creates a new Bonsoir service instance ignoring the norms.

```dart
BonsoirService.ignoreNorms({required String name, required String type, String? host, required int port, Map<String, String> attributes = defaultAttributes})
```
```

--------------------------------

### MethodChannelBonsoir()

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoir/MethodChannelBonsoir.html

Initializes a new instance of the MethodChannelBonsoir class.

```APIDOC
## MethodChannelBonsoir()

### Description

This is the constructor for the `MethodChannelBonsoir` class. It is used to create a new instance of the class.

### Constructor Signature

```dart
MethodChannelBonsoir()
```

### Parameters

This constructor does not take any parameters.

### Usage Example

```dart
final bonsoir = MethodChannelBonsoir();
```
```

--------------------------------

### Get isReady Status - Dart

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/isReady.html

Retrieve the readiness status of the platform. This property is a getter that returns a boolean value.

```dart
bool get isReady => _action.isReady;
```

--------------------------------

### isReady Property

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/isReady.html

Retrieves the readiness status of the platform for an action. This is a boolean value.

```APIDOC
## isReady Property

### Description
This returns whether the platform is ready for the action.

### Type
bool

### Implementation
```dart
bool get isReady => _action.isReady;
```
```

--------------------------------

### Get isStopped Status

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/isStopped.html

Use this getter to check if the action has been stopped. It directly reflects the state of the internal action object.

```dart
bool get isStopped => _action.isStopped;
```

--------------------------------

### copyWith Method

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/copyWith.html

Creates a new BonsoirService instance with specified parameters. Allows for optional updates to name, type, port, host, and attributes. The forceUpdateHost parameter can be used to explicitly set the host to null.

```APIDOC
## copyWith Method

### Description
Copies this service instance with the given parameters.

### Method Signature
BonsoirService copyWith({
  String? name,
  String? type,
  int? port,
  String? host,
  Map<String, String>? attributes,
  bool forceUpdateHost = false,
})

### Parameters
- **name** (String?) - Optional - The new name for the service.
- **type** (String?) - Optional - The new type for the service.
- **port** (int?) - Optional - The new port for the service.
- **host** (String?) - Optional - The new host for the service. If `forceUpdateHost` is true, this will be ignored and the host will be set to null.
- **attributes** (Map<String, String>?) - Optional - The new attributes for the service.
- **forceUpdateHost** (bool) - Optional - Defaults to false. If true, the host will be set to null regardless of the `host` parameter.

### Implementation Example
```dart
BonsoirService copyWith({
  String? name,
  String? type,
  int? port,
  String? host,
  Map<String, String>? attributes,
  bool forceUpdateHost = false,
}) => BonsoirService.ignoreNorms(
  name: name ?? this.name,
  type: type ?? this.type,
  host: host ?? (forceUpdateHost ? null : this.host),
  port: port ?? this.port,
  attributes: attributes ?? this.attributes,
);
```
```

--------------------------------

### Get Event Stream Implementation

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/eventStream.html

This snippet shows how to access the event stream from the action handler. It returns a Stream of type T.

```dart
Stream<T>? get eventStream => _action.eventStream;
```

--------------------------------

### isReady

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirDiscoveryAction-class.html

A boolean property that indicates whether the platform is ready to perform the action associated with this instance.

```APIDOC
## isReady

### Description
This returns whether the platform is ready for this action.

### Returns
- bool
```

--------------------------------

### BonsoirService get service

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceResolvedEvent/service.html

This property provides access to the BonsoirService instance. It is an override of a base property and ensures that the service is correctly cast to BonsoirService.

```APIDOC
## BonsoirService get service

### Description
This property returns the BonsoirService instance. It overrides a property from a base class and asserts that the service is of type BonsoirService.

### Method
Getter

### Endpoint
N/A (This is a property access, not an HTTP endpoint)

### Parameters
None

### Request Example
```dart
BonsoirService myService = bonsoirInstance.service;
```

### Response
#### Success Response
- **service** (BonsoirService) - The BonsoirService instance.

#### Response Example
```dart
// Assuming 'bonsoirInstance' is an instance of a class that has this property
// The actual BonsoirService object would be returned here.
```
```

--------------------------------

### BonsoirPlatformInterface Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirPlatformInterface/BonsoirPlatformInterface.html

Creates a new Bonsoir platform interface instance. This is the primary way to initialize the interface.

```dart
BonsoirPlatformInterface() : super(token: _token);
```

--------------------------------

### BonsoirDiscovery Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscovery/BonsoirDiscovery.html

Creates a new Bonsoir discovery instance with optional logging and service resolution.

```APIDOC
## BonsoirDiscovery Constructor

### Description
Creates a new Bonsoir discovery instance.

### Parameters
#### Constructor Parameters
- **printLogs** (bool) - Optional - Controls whether logs are printed. Defaults to `kDebugMode`.
- **type** (String) - Required - The type of service to discover.
- **serviceResolver** (ServiceResolver?) - Optional - A custom service resolver. If not provided, a default resolver is used.
```

--------------------------------

### Methods

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcastEvent-class.html

Available methods for BonsoirBroadcastEvent instances.

```APIDOC
## Methods

### `toString()` → `String`

A string representation of this object.
```

--------------------------------

### BonsoirActionHandler Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler-class.html

Creates a new Bonsoir discovery instance.

```APIDOC
## BonsoirActionHandler

### Description
Creates a new Bonsoir discovery instance.

### Parameters
#### Path Parameters
- **action** (BonsoirAction<T>) - Required - The Bonsoir action to handle.
```

--------------------------------

### Initialize Abstract Method Signature

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction/initialize.html

This is the abstract method signature for initialize. It should be awaited before plugin actions.

```dart
Future<void> initialize();
```

--------------------------------

### isReady

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirBroadcastAction-class.html

A boolean property indicating whether the platform is ready to perform the broadcast action.

```APIDOC
## isReady

### Description
This returns whether the platform is ready for this action.

### Returns
- bool

### Remarks
No setter available. This is a read-only property.
```

--------------------------------

### Check Platform Readiness with isReady

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirAction/isReady.html

Use this getter to determine if the Bonsoir platform is ready to perform actions. It returns true only if the event stream is active and the service has not been stopped.

```dart
@override
bool get isReady => _eventStream != null && !_isStopped;
```

--------------------------------

### MethodChannelBonsoirDiscoveryAction Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirDiscoveryAction/MethodChannelBonsoirDiscoveryAction.html

Initializes a new instance of the MethodChannelBonsoirDiscoveryAction class. This constructor is used to set up the action for discovery operations, specifying the type of discovery and optionally enabling debug logging.

```APIDOC
## MethodChannelBonsoirDiscoveryAction constructor

Creates a new method channel action instance for the discovery action.

### Parameters

- **type** (String) - Required - Specifies the type of discovery action.
- **printLogs** (bool) - Optional - If true, debug logs will be printed. Defaults to `kDebugMode`.

### Example

```dart
final discoveryAction = MethodChannelBonsoirDiscoveryAction(type: 'network');
```

### Implementation Details

This constructor sets up the `type` and `printLogs` properties, and initializes the superclass with `classType: 'discovery'`.
```

--------------------------------

### BonsoirDiscoveryServiceFoundEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceFoundEvent/BonsoirDiscoveryServiceFoundEvent.html

Creates a new Bonsoir discovery service found event instance.

```APIDOC
## BonsoirDiscoveryServiceFoundEvent constructor

### Description
Creates a new Bonsoir discovery service found event instance.

### Parameters
#### Constructor Parameters
- **service** (BonsoirService) - Required - The BonsoirService instance.

### Implementation
```dart
const BonsoirDiscoveryServiceFoundEvent({
  required BonsoirService super.service,
});
```
```

--------------------------------

### BonsoirService Constructor Signature

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/BonsoirService.html

Defines the parameters required for creating a BonsoirService instance. Parameters include name, type, host, port, and optional attributes. Name, type, and attributes are normalized by default.

```dart
BonsoirService({
  1. required String name,
  2. required String type,
  3. String? host,
  4. required int port,
  5. Map<String, String> attributes = defaultAttributes,
})
```

--------------------------------

### BonsoirDiscoveryStartedEvent Methods

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryStartedEvent-class.html

Details the methods available for the BonsoirDiscoveryStartedEvent class.

```APIDOC
## Methods

### noSuchMethod
- **Signature**: noSuchMethod(Invocation invocation) → dynamic
- **Description**: Invoked when a nonexistent method or property is accessed.
- **Inheritance**: inherited

### toString
- **Signature**: toString() → String
- **Description**: A string representation of this object.
- **Inheritance**: inherited
```

--------------------------------

### MethodChannelBonsoirAction Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirAction/MethodChannelBonsoirAction.html

Initializes a new instance of the MethodChannelBonsoirAction class. This constructor requires a classType and optionally accepts a printLogs flag.

```APIDOC
## MethodChannelBonsoirAction<T extends BonsoirEvent> Constructor

### Description
Creates a new Bonsoir class instance.

### Parameters
#### Named Parameters
- **classType** (String) - Required - Specifies the type of the Bonsoir class.
- **printLogs** (bool) - Optional - If true, logs will be printed. Defaults to `kDebugMode`.
```

--------------------------------

### BonsoirDiscoveryServiceFoundEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceFoundEvent-class.html

Creates a new instance of the BonsoirDiscoveryServiceFoundEvent.

```APIDOC
## BonsoirDiscoveryServiceFoundEvent

### Description
Creates a new Bonsoir discovery service found event instance.

### Parameters
#### Path Parameters
- **service** (BonsoirService) - Required - The discovered service.
```

--------------------------------

### BonsoirDiscovery Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscovery-class.html

Creates a new Bonsoir discovery instance. It requires a type of service to find and optionally accepts a service resolver and debug log printing flag.

```APIDOC
## BonsoirDiscovery Constructor

### Description
Creates a new Bonsoir discovery instance.

### Parameters
#### Path Parameters
- **printLogs** (bool) - Optional - If true, prints debug logs. Defaults to kDebugMode.
- **type** (String) - Required - The type of service to find.
- **serviceResolver** (ServiceResolver?) - Optional - A function to resolve services.
```

--------------------------------

### BonsoirBroadcastStartedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcastStartedEvent-class.html

Creates a new instance of the BonsoirBroadcastStartedEvent. It requires an optional ID and a BonsoirService instance.

```APIDOC
## Constructor

BonsoirBroadcastStartedEvent({String? id, required BonsoirService service})

### Description
Creates a new Bonsoir broadcast started event instance.

### Parameters
- **id** (String?) - Optional - The event ID.
- **service** (BonsoirService) - Required - The Bonsoir service instance.
```

--------------------------------

### BonsoirService Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/BonsoirService.html

Creates a new Bonsoir service instance. By default, Bonsoir will normalize your `name`, `type` and `attributes` in order to conform to RFC 6335. You can ignore this behavior with the BonsoirService.ignoreNorms constructor.

```APIDOC
## BonsoirService Constructor

### Description
Creates a new Bonsoir service instance. By default, Bonsoir will normalize your `name`, `type` and `attributes` in order to conform to RFC 6335. You can ignore this behavior with the BonsoirService.ignoreNorms constructor.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **name** (String) - Required - The name of the service.
- **type** (String) - Required - The type of the service.
- **host** (String) - Optional - The host of the service.
- **port** (int) - Required - The port of the service.
- **attributes** (Map<String, String>) - Optional - A map of attributes for the service. Defaults to `defaultAttributes`.

### Request Example
```dart
final service = BonsoirService(
  name: 'my_service',
  type: '_my._tcp',
  port: 8080,
  host: 'localhost',
  attributes: {'version': '1.0'},
);
```

### Response
#### Success Response (200)
None (Constructor)

#### Response Example
None
```

--------------------------------

### BonsoirDiscovery Methods

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscovery-class.html

Provides methods to manage the lifecycle and behavior of the BonsoirDiscovery instance.

```APIDOC
## BonsoirDiscovery Methods

### initialize() → Future<void>
The initialize method, that should be called before starting the action. Await this method to know when the plugin will be ready.

### start() → Future<void>
Starts the action.

### stop() → Future<void>
Stops the action.
```

--------------------------------

### MethodChannelBonsoirBroadcastAction Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirBroadcastAction/MethodChannelBonsoirBroadcastAction.html

Creates a new method channel action instance for the broadcast action. It requires a BonsoirService and optionally accepts a boolean to print logs.

```APIDOC
## MethodChannelBonsoirBroadcastAction constructor

### Description
Creates a new method channel action instance for the broadcast action.

### Parameters
#### Positional Parameters
- **service** (BonsoirService) - Required - The BonsoirService instance to use for communication.
- **printLogs** (bool) - Optional - If true, logs will be printed. Defaults to `kDebugMode`.
```

--------------------------------

### MethodChannelBonsoirDiscoveryAction Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirDiscoveryAction/MethodChannelBonsoirDiscoveryAction.html

Creates a new method channel action instance for the discovery action. Requires a 'type' and optionally accepts 'printLogs'.

```dart
MethodChannelBonsoirDiscoveryAction({
  required this.type,
  super.printLogs,
}) : super(
       classType: 'discovery',
     );
```

--------------------------------

### Create Discovery Action Implementation

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoir/createDiscoveryAction.html

This method returns an initialized subclass of BonsoirAction holding the eventStreams and other state needed for the implementations. It takes a type string and an optional boolean for printing logs.

```dart
@override
BonsoirAction<BonsoirDiscoveryEvent> createDiscoveryAction(String type, {bool printLogs = kDebugMode}) => MethodChannelBonsoirDiscoveryAction(type: type, printLogs: printLogs);
```

--------------------------------

### BonsoirEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirEvent-class.html

Initializes a new BonsoirEvent instance. You can optionally provide an ID and the associated BonsoirService.

```APIDOC
## Constructor

### Description
Initializes a new BonsoirEvent instance.

### Parameters
- **id** (String?) - Optional - The unique identifier for the event.
- **service** (BonsoirService?) - Optional - The BonsoirService associated with this event.
```

--------------------------------

### BonsoirBroadcastStartedEvent Methods

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcastStartedEvent-class.html

Available methods for the BonsoirBroadcastStartedEvent class.

```APIDOC
## Methods

- **noSuchMethod(Invocation invocation)** → dynamic
  Invoked when a nonexistent method or property is accessed.

- **toString()** → String
  A string representation of this object.
```

--------------------------------

### Create BonsoirDiscoveryServiceResolveFailedEvent Instance

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceResolveFailedEvent/BonsoirDiscoveryServiceResolveFailedEvent.html

Use this constructor to create a new instance of the Bonsoir discovery service resolve failed event.

```javascript
const BonsoirDiscoveryServiceResolveFailedEvent();
```

--------------------------------

### MethodChannelBonsoirBroadcastAction Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirBroadcastAction-class.html

Creates a new instance of MethodChannelBonsoirBroadcastAction. This constructor is used to initialize the broadcast action with a BonsoirService and optional log printing.

```APIDOC
## MethodChannelBonsoirBroadcastAction

### Description
Creates a new method channel action instance for the broadcast action.

### Parameters
- **service** (BonsoirService) - Required - The Bonsoir service instance.
- **printLogs** (bool) - Optional - Whether to print logs. Defaults to `kDebugMode`.
```

--------------------------------

### createDiscoveryAction

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirPlatformInterface-class.html

Creates an initialized BonsoirAction for discovering services. It holds the necessary event streams and state for discovery implementations.

```APIDOC
## createDiscoveryAction

### Description
This method returns an initialized subclass of BonsoirAction holding the eventStreams and other state needed for the implementations.

### Method Signature
`createDiscoveryAction(String type, {bool printLogs = kDebugMode}) → BonsoirAction<BonsoirDiscoveryEvent>`

### Parameters
- **type** (String) - The type of service to discover.
- **printLogs** (bool, optional) - Whether to print logs. Defaults to `kDebugMode`.
```

--------------------------------

### BonsoirBroadcast Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcast/BonsoirBroadcast.html

Creates a new Bonsoir broadcast instance. You can optionally enable or disable log printing.

```APIDOC
## BonsoirBroadcast Constructor

### Description
Creates a new Bonsoir broadcast instance.

### Parameters
#### Constructor Parameters
- **printLogs** (bool) - Optional - If true, logs will be printed. Defaults to `kDebugMode`.
- **service** (BonsoirService) - Required - The BonsoirService instance to use for broadcasting.
```

--------------------------------

### BonsoirEvent Constructor Implementation

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirEvent/BonsoirEvent.html

This is the implementation of the BonsoirEvent constructor. It initializes the id and service properties.

```dart
const BonsoirEvent({
  this.id,
  this.service,
});
```

--------------------------------

### BonsoirDiscoveryServiceFoundEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceFoundEvent/BonsoirDiscoveryServiceFoundEvent.html

Creates a new Bonsoir discovery service found event instance. Requires a BonsoirService object.

```dart
const BonsoirDiscoveryServiceFoundEvent({
  required BonsoirService super.service,
});
```

--------------------------------

### BonsoirAction() Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirAction-class.html

The default constructor for the BonsoirAction class.

```APIDOC
## BonsoirAction()

### Description

The default constructor for the BonsoirAction class.

### Parameters

None
```

--------------------------------

### BonsoirService.ignoreNorms Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/BonsoirService.ignoreNorms.html

Creates a new Bonsoir service instance ignoring the norms. `name`, `type` and `attributes` will not be filtered. Be aware that some network environments might not support non-conformant service names.

```APIDOC
## BonsoirService.ignoreNorms

### Description
Creates a new Bonsoir service instance ignoring the norms. `name`, `type` and `attributes` will not be filtered. Be aware that some network environments might not support non-conformant service names.

### Parameters
#### Constructor Parameters
- **name** (String) - Required - The name of the service.
- **type** (String) - Required - The type of the service.
- **host** (String) - Optional - The host of the service.
- **port** (int) - Required - The port of the service.
- **attributes** (Map<String, String>) - Optional - A map of attributes for the service. Defaults to `defaultAttributes`.

### Implementation
```dart
const BonsoirService.ignoreNorms({
  required this.name,
  required this.type,
  this.host,
  required this.port,
  this.attributes = defaultAttributes,
});
```
```

--------------------------------

### BonsoirService Methods

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService-class.html

Available methods for the BonsoirService class, including copying service instances, resolving services, and converting to JSON.

```APIDOC
## BonsoirService Methods

### copyWith
Copies this service instance with the given parameters.

```dart
copyWith({String? name, String? type, int? port, String? host, Map<String, String>? attributes, bool forceUpdateHost = false})
```

### resolve
Tries to resolve this service.

```dart
Future<void> resolve(ServiceResolver resolver)
```

### toJson
Converts this JSON service to a JSON map.

```dart
Map<String, dynamic> toJson({String prefix = 'service.'})
```
```

--------------------------------

### BonsoirDiscoveryServiceLostEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceLostEvent/BonsoirDiscoveryServiceLostEvent.html

Creates a new Bonsoir discovery service lost event instance.

```APIDOC
## BonsoirDiscoveryServiceLostEvent constructor

### Description
Creates a new Bonsoir discovery service lost event instance.

### Parameters
#### Path Parameters
- **service** (BonsoirService) - Required - The BonsoirService instance.

### Implementation
```dart
const BonsoirDiscoveryServiceLostEvent({
  required BonsoirService super.service,
});
```
```

--------------------------------

### BonsoirDiscoveryServiceResolveFailedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceResolveFailedEvent/BonsoirDiscoveryServiceResolveFailedEvent.html

Creates a new Bonsoir discovery service resolve failed event instance.

```APIDOC
## BonsoirDiscoveryServiceResolveFailedEvent()

### Description
Creates a new Bonsoir discovery service resolve failed event instance.

### Method
const

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None

## Implementation
```dart
const BonsoirDiscoveryServiceResolveFailedEvent();
```
```

--------------------------------

### BonsoirDiscoveryServiceResolveFailedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceResolveFailedEvent-class.html

Creates a new Bonsoir discovery service resolve failed event instance.

```APIDOC
## Constructor

### BonsoirDiscoveryServiceResolveFailedEvent()

Creates a new Bonsoir discovery service resolve failed event instance.
```

--------------------------------

### BonsoirService.fromJson

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/BonsoirService.fromJson.html

Creates a new Bonsoir service instance from the given JSON map.

```APIDOC
## BonsoirService.fromJson constructor

### Description
Creates a new Bonsoir service instance from the given JSON map.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **json** (Map<String, dynamic>) - Required - The JSON map containing service data.
- **prefix** (String) - Optional - Defaults to 'service.'. A prefix for keys in the JSON map.

### Request Example
```json
{
  "service.name": "MyService",
  "service.type": "REST",
  "service.host": "localhost",
  "service.port": 8080,
  "service.attributes": {
    "timeout": "30s"
  }
}
```

### Response
#### Success Response (200)
- **BonsoirService** - An instance of BonsoirService created from the JSON data.

#### Response Example
```json
{
  "name": "MyService",
  "type": "REST",
  "host": "localhost",
  "port": 8080,
  "attributes": {
    "timeout": "30s"
  }
}
```
```

--------------------------------

### createBroadcastAction

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirPlatformInterface-class.html

Creates an initialized BonsoirAction for broadcasting services. It holds the necessary event streams and state for broadcast implementations.

```APIDOC
## createBroadcastAction

### Description
This method returns an initialized subclass of BonsoirAction holding the eventStreams and other state needed for the implementations.

### Method Signature
`createBroadcastAction(BonsoirService service, {bool printLogs = kDebugMode}) → BonsoirAction<BonsoirBroadcastEvent>`

### Parameters
- **service** (BonsoirService) - The service to broadcast.
- **printLogs** (bool, optional) - Whether to print logs. Defaults to `kDebugMode`.
```

--------------------------------

### BonsoirActionHandler Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirActionHandler/BonsoirActionHandler.html

Creates a new BonsoirActionHandler instance. It requires a BonsoirAction to be provided.

```APIDOC
## BonsoirActionHandler<T extends BonsoirEvent> constructor

### Description
Creates a new Bonsoir discovery instance.

### Parameters
#### Path Parameters
- **action** (BonsoirAction<T>) - Required - The action to be performed by the handler.
```

--------------------------------

### BonsoirDiscovery Factory Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscovery/BonsoirDiscovery.html

Use this factory constructor to create a new Bonsoir discovery instance. It handles log printing and service resolution based on the provided type and optional service resolver.

```dart
factory BonsoirDiscovery({
  bool printLogs = kDebugMode,
  required String type,
  ServiceResolver? serviceResolver,
}) {
  if (kDebugMode) {
    String normalizedType = BonsoirServiceNormalizer.normalizeType(type);
    if (type != normalizedType) {
      print(
        'It seems that you are trying to discover an invalid type using Bonsoir.',
      );
      print('Did you mean "$normalizedType" instead of "$type" ?');
    }
  }
  BonsoirAction<BonsoirDiscoveryEvent> action = BonsoirPlatformInterface.instance.createDiscoveryAction(
    type,
    printLogs: printLogs,
  );
  serviceResolver ??= action is ServiceResolver ? (action as ServiceResolver) : _NoServiceResolver();
  return BonsoirDiscovery._internal(
    type: type,
    serviceResolver: serviceResolver,
    action: action,
  );
}
```

--------------------------------

### MethodChannelBonsoirAction Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirAction/MethodChannelBonsoirAction.html

Creates a new Bonsoir class instance. Requires a class type and optionally enables debug logging.

```dart
MethodChannelBonsoirAction({
  required String classType,
  this.printLogs = kDebugMode,
}) : _id = _createRandomId(),
     _classType = classType;
```

--------------------------------

### BonsoirDiscoveryServiceUpdatedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceUpdatedEvent/BonsoirDiscoveryServiceUpdatedEvent.html

Creates a new Bonsoir discovery service updated event instance.

```APIDOC
## BonsoirDiscoveryServiceUpdatedEvent constructor

### Description
Creates a new Bonsoir discovery service updated event instance.

### Parameters
#### Path Parameters
- **service** (BonsoirService) - Required - The BonsoirService instance.

### Implementation
```dart
const BonsoirDiscoveryServiceUpdatedEvent({
  required BonsoirService super.service,
});
```
```

--------------------------------

### BonsoirService Constructor Implementation

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/BonsoirService.html

The implementation of the BonsoirService constructor. It normalizes the provided name, type, and attributes using BonsoirServiceNormalizer before assigning them to the instance properties.

```dart
BonsoirService({
  required String name,
  required String type,
  this.host,
  required this.port,
  Map<String, String> attributes = defaultAttributes,
}) : name = BonsoirServiceNormalizer.normalizeName(name),
     type = BonsoirServiceNormalizer.normalizeType(type),
     attributes = BonsoirServiceNormalizer.normalizeAttributes(attributes);
```

--------------------------------

### BonsoirDiscoveryServiceLostEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceLostEvent/BonsoirDiscoveryServiceLostEvent.html

Use this constructor to create a new BonsoirDiscoveryServiceLostEvent instance. It requires a BonsoirService object.

```dart
const BonsoirDiscoveryServiceLostEvent({
  required BonsoirService super.service,
});
```

--------------------------------

### BonsoirBroadcast Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcast-class.html

Creates a new Bonsoir broadcast instance. It requires a BonsoirService and optionally accepts a boolean to enable or disable debug logging.

```APIDOC
## BonsoirBroadcast Constructor

### Description
Creates a new Bonsoir broadcast instance.

### Parameters
- **printLogs** (bool) - Optional - If true, logs will be printed to the console. Defaults to `kDebugMode`.
- **service** (BonsoirService) - Required - The BonsoirService instance to broadcast.
```

--------------------------------

### BonsoirDiscoveryUnknownEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryUnknownEvent-class.html

Creates a new Bonsoir discovery unknown event instance.

```APIDOC
## BonsoirDiscoveryUnknownEvent

### Description
Unknown event occurred.

### Constructor
BonsoirDiscoveryUnknownEvent({String? id, BonsoirService? service})

### Parameters
#### Path Parameters
- **id** (String?) - Optional - The event id.
- **service** (BonsoirService?) - Optional - The service (if any).
```

--------------------------------

### BonsoirDiscoveryUnknownEvent.new

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryUnknownEvent/BonsoirDiscoveryUnknownEvent.html

Creates a new Bonsoir discovery unknown event instance.

```APIDOC
## BonsoirDiscoveryUnknownEvent.new

### Description
Creates a new Bonsoir discovery unknown event instance.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Constructor Signature
```dart
const BonsoirDiscoveryUnknownEvent({
  String? id,
  BonsoirService? service,
});
```

### Implementation
```dart
const BonsoirDiscoveryUnknownEvent({
  super.id,
  super.service,
});
```
```

--------------------------------

### Properties

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcastEvent-class.html

Details about the properties of a BonsoirBroadcastEvent instance.

```APIDOC
## Properties

### `id` → `String?`

The event id.

### `service` → `BonsoirService?`

The service (if any).
```

--------------------------------

### BonsoirDiscoveryStoppedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryStoppedEvent-class.html

Creates a new instance of the BonsoirDiscoveryStoppedEvent.

```APIDOC
## BonsoirDiscoveryStoppedEvent()

### Description
Creates a new Bonsoir discovery stopped event instance.

### Method
Constructor

### Parameters
None
```

--------------------------------

### BonsoirService.fromJson Factory Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/BonsoirService.fromJson.html

Use this factory constructor to create a Bonsoir service instance from a JSON map. It allows for a customizable prefix for JSON keys.

```dart
factory BonsoirService.fromJson(
  Map<String, dynamic> json,
  {
    String prefix = 'service.',
  }
) => BonsoirService.ignoreNorms(
  name: json['${prefix}name'],
  type: json['${prefix}type'],
  host: json['${prefix}host'],
  port: json['${prefix}port'],
  attributes: Map<String, String>.from(json['${prefix}attributes']),
);
```

--------------------------------

### BonsoirBroadcast Constructor Implementation

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirBroadcast/BonsoirBroadcast.html

Creates a new Bonsoir broadcast instance. Requires a BonsoirService and optionally accepts a boolean to control log printing.

```dart
BonsoirBroadcast({
  bool printLogs = kDebugMode,
  required this.service,
}) : super(
       action: BonsoirPlatformInterface.instance.createBroadcastAction(
         service,
         printLogs: printLogs,
       ),
     );
```

--------------------------------

### BonsoirService copyWith Implementation

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirService/copyWith.html

This implementation of copyWith creates a new BonsoirService instance, copying existing properties and applying new ones. The `forceUpdateHost` parameter controls whether the host can be updated even if it's null.

```dart
BonsoirService copyWith({
  String? name,
  String? type,
  int? port,
  String? host,
  Map<String, String>? attributes,
  bool forceUpdateHost = false,
}) => BonsoirService.ignoreNorms(
  name: name ?? this.name,
  type: type ?? this.type,
  host: host ?? (forceUpdateHost ? null : this.host),
  port: port ?? this.port,
  attributes: attributes ?? this.attributes,
);
```

--------------------------------

### MethodChannelBonsoirBroadcastAction Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/MethodChannelBonsoirBroadcastAction/MethodChannelBonsoirBroadcastAction.html

Creates a new method channel action instance for the broadcast action. Requires a BonsoirService and optionally accepts a boolean for printing logs.

```dart
MethodChannelBonsoirBroadcastAction({
  required this.service,
  super.printLogs,
}) : super(
       classType: 'broadcast',
     );
```

--------------------------------

### BonsoirDiscoveryServiceUpdatedEvent Constructor

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryServiceUpdatedEvent-class.html

Creates a new instance of the BonsoirDiscoveryServiceUpdatedEvent.

```APIDOC
## Constructor

### BonsoirDiscoveryServiceUpdatedEvent

```dart
BonsoirDiscoveryServiceUpdatedEvent({required BonsoirService service})
```

#### Parameters

- **service** (BonsoirService) - Required - The updated service object.
```

--------------------------------

### Broadcast a Service with Bonsoir

Source: https://pub.dev/documentation/bonsoir/latest/index.html

Use this snippet to broadcast your own network service. Ensure the service name, type, and port are correctly configured.

```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.initialize();
await broadcast.start();

// ...

// Then if you want to stop the broadcast :
await broadcast.stop();

```

--------------------------------

### BonsoirDiscoveryStartedEvent Constants

Source: https://pub.dev/documentation/bonsoir/latest/bonsoir/BonsoirDiscoveryStartedEvent-class.html

Details the constants available for the BonsoirDiscoveryStartedEvent class.

```APIDOC
## Constants

### discoveryStarted
- **Type**: const String
- **Description**: The event id.
```
Tokens:
Raw