Skip to main content

API

TransportClientConnectionPool​

Declaration
class TransportClientConnectionPool {
  List<TransportClientConnection> get clients
  TransportClientConnection select()
  void forEach(FutureOr<void> Function(TransportClientConnection provider) action)
  int count()
  Future<void> close({Duration? gracefulTimeout})
}

Properties​

clients​

Connected clients inside the pool.

Methods​

select​

Round-robin client selection.

forEach​

Invokes an action for each client.

count​

Number of current clients.

close​

Closes all client connections.

TransportClientsFactory​

Declaration
class TransportClientsFactory {
  Future<TransportClientConnectionPool> tcp(
    InternetAddress address,
    int port, {
    TransportTcpClientConfiguration? configuration,
  }) async
  TransportDatagramClient udp(
    InternetAddress sourceAddress,
    int sourcePort,
    InternetAddress destinationAddress,
    int destinationPort, {
    TransportUdpClientConfiguration? configuration,
  })
  Future<TransportClientConnectionPool> unixStream(
    String path, {
    TransportUnixStreamClientConfiguration? configuration,
  }) async
}

Methods​

tcp​

Creates TCP clients (pooled).

udp​

Creates UDP single client.

unixStream​

Creates UNIX Socket clients.

TransportDatagramClient​

Declaration
class TransportDatagramClient {
  bool get active
  Stream<TransportPayload> get inbound
  Future<void> receive({int? flags})
  Stream<TransportPayload> stream({int? flags}) 
  void sendSingle(
    Uint8List bytes, {
    int? flags,
    void Function(Exception error)? onError,
    void Function()? onDone,
  })
  void sendMany(
    List<Uint8List> bytes, {
    int? flags,
    bool linked = false,
    void Function(Exception error)? onError,
    void Function()? onDone,
  })
  Future<void> close({Duration? gracefulTimeout})
}

Properties​

active​

Client live status.

inbound​

Stream for inbound (read) payloads.

Methods​

receive​

Initiates a receive event for new data from the client.

stream​

Automatically reads a stream of inbound data from the client.

sendSingle​

Sends a single message to the client.

sendMany​

Sends multiple messages to the client.

close​

Closes the client.

TransportClientConnection​

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

Properties​

active​

Client 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.