Features

  • receive Datagrams on demand without subscription.
  • receive timeout.
  • Various shorthand methods.

Usage

usage example:

import 'dart:convert';
import 'package:easy_udp_socket/easy_udp_socket.dart';

start_server() async {
  // Create a EasyUDPSocket and bind to localhost:7777,
  // Note that you can also manually create a RawDatagramSocket 
  // and pass it to EasyUDPSocket(..) to create a EasyUDPSocket.
  final socket = await EasyUDPSocket.bindSimple(7777);

  while (true) {
    // Rather than subscribing to a stream of RawSocketEvents and
    // calling receive in the callback, which is the case when using
    // RawDatagramSocket, with EasyUDPSocket, you can get Datagram 
    // on demand with `receive` method.
    final datagram = await socket.receive();
    print('Server received: ${ascii.decode(datagram.data)} from ${datagram.port}');

    // use `sendBack` to send message to where a Datagram comes from.
    // This is a shorthand of:
    // socket.send(somedata, datagram.address, datagram.port);
    socket.sendBack(datagram, ascii.encode('pong'));
  }
}

start_client(int port) async {
  final socket = await EasyUDPSocket.bindSimple(port);
  socket.send(ascii.encode('ping'), 'localhost', 7777);
  final resp = await socket.receive();
  print('Client $port received: ${ascii.decode(resp.data)}');

  // `close` method of EasyUDPSocket is awaitable.
  await socket.close();
  print('Client $port closed');
}

start_multicast_server() async {
  //TODO: here create a multicast server
}

start_multicast_client(int port) async {
  final socket = await EasyUDPSocket.bindMulticast('224.0.2.200',port);
  if (socket != null) {
    socket.send(ascii.encode('ping'), '224.0.2.200', 7777);
    final resp = await socket.receive();
    print('Client $port received: ${ascii.decode(resp.data)}');

    // `close` method of EasyUDPSocket is awaitable.
    await socket.close();
    print('Client $port closed');
  }
}

start_broadcat_server(int port) async {
  //TODO: here create a broadcast server
}

// mark: the port must be server broadcast port
start_broadcast_client(int port) async {
  final socket = await EasyUDPSocket.bindBroadcast(port);
  if (socket != null) {
    socket.send(ascii.encode('ping'), '192.168.1.255', port);
    final resp = await socket.receive();
    print('Client $port received: ${ascii.decode(resp.data)}');

    // `close` method of EasyUDPSocket is awaitable.
    await socket.close();
    print('Client $port closed');
  }
}

main() async {
  start_server();
  await Future.delayed(Duration(seconds: 1));
  start_client(8001);
  start_client(8002);
  start_client(8003);
}

// Output:
//
// Server received: ping from 8001
// Server received: ping from 8002
// Server received: ping from 8003
// Client 8001 received: pong
// Client 8002 received: pong
// Client 8003 received: pong
// Client 8001 closed
// Client 8002 closed
// Client 8003 closed

with timeout:

...
final datagram = await socket.receive(timeout: 1000);
if(datagram == null) {
  print('Receive timeout');
  continue;
}
...

// Output:
//
// Server received: ping from 8001
// Server received: ping from 8002
// Server received: ping from 8003
// Client 8001 received: pong
// Client 8002 received: pong
// Client 8003 received: pong
// Client 8001 closed
// Client 8002 closed
// Client 8003 closed
// Receive timeout
// Receive timeout
// Receive timeout
// Receive timeout

Features and bugs

Please file feature requests and bugs at the issue tracker.

Libraries

easy_udp
usage example: [...]