Skip to main content

API

TransportServersFactory​

Declaration
class TransportServersFactory {
  TransportServer tcp(
    InternetAddress address,
    int port,
    void Function(TransportServerConnection connection) onAccept, {
    TransportTcpServerConfiguration? configuration,
  })
  TransportServerDatagramReceiver udp(
    InternetAddress address,
    int port, {
    TransportUdpServerConfiguration? configuration,
  })
  TransportServer unixStream(
    String path,
    void Function(TransportServerConnection connection) onAccept, {
    TransportUnixStreamServerConfiguration? configuration,
  })
}

Methods​

tcp​

Creates TCP server.

udp​

Creates UDP server.

unixStream​

Creates UNIX Socket server.

TransportServerConnection​

Declaration
class TransportServerConnection {
  Stream<TransportPayload> get inbound
  bool get active
  Future<void> read()
  Stream<TransportPayload> stream()
  void writeSingle(Uint8List bytes, {void Function(Exception error)? onError, void Function()? onDone})
  void writeMany(List<Uint8List> bytes, {bool linked = true, void Function(Exception error)? onError, void Function()? onDone})
  Future<void> close({Duration? gracefulTimeout})
  Future<void> closeServer({Duration? gracefulTimeout})
}

Properties​

active​

Server connection live status.

inbound​

Stream for inbound (read) payloads.

Methods​

read​

Initiates a read event for new data from the connection.

stream​

Automatically reads a stream of inbound data from the connection.

writeSingle​

Writes a single buffer to the connection.

writeMany​

Writes many buffers to the connection.

close​

Closes the connection.

closeServer​

Closes the server. It will close all TCP connections and also will stop UDP processing.

TransportServerDatagramReceiver​

Declaration
class TransportServerDatagramReceiver {
  Stream<TransportServerDatagramResponder> get inbound
  bool get active
  Stream<TransportServerDatagramResponder> receive({int? flags})
  Future<void> close({Duration? gracefulTimeout})
}

Properties​

inbound​

Stream for inbound (read) payloads.

active​

Server live status.

Methods​

stream​

Automatically reads a stream of inbound data from the sender.

closeServer​

Closes the server. It will close all TCP connections and also will stop UDP processing.

TransportServerDatagramResponder​

Declaration
class TransportServerDatagramResponder {
  Uint8List get receivedBytes
  bool get active
  void respondSingle(Uint8List bytes, {int? flags, void Function(Exception error)? onError, void Function()? onDone})
  void respondMany(List<Uint8List> bytes, {int? flags, bool linked = true, void Function(Exception error)? onError, void Function()? onDone})
  void release()
  Uint8List takeBytes({bool release = true})
  List<int> toBytes({bool release = true})
}

Properties​

receivedBytes​

Current datagram bytes from the sender.

active​

Responder live status.

Methods​

respondSingle​

Responds with a single message to the sender.

respondMany​

Responds with many messages to the sender.

release​

Returns responder to a pool and clears it.

takeBytes​

Takes Uint8List from the payload and releases the responder.

toBytes​

Takes List<int> from the payload and releases the responder.