TransportWsClientOptions constructor

const TransportWsClientOptions({
  1. required WebSocketMaker socketMaker,
  2. FutureOr<Map<String, Object?>?> connectionParams()?,
  3. bool lazy = true,
  4. void onNonLazyError(
    1. Object? errorOrCloseEvent
    )? = print,
  5. Duration lazyCloseTimeout = Duration.zero,
  6. Duration keepAlive = Duration.zero,
  7. Duration connectionAckWaitTimeout = Duration.zero,
  8. bool disablePong = false,
  9. int retryAttempts = 0,
  10. Future<void> retryWait(
    1. int retries
    ) = randomizedExponentialBackoff,
  11. bool shouldRetry(
    1. Object errOrCloseEvent
    ) = shouldRetryDefault,
  12. bool isFatalConnectionProblem(
    1. Object errOrCloseEvent
    ) = isFatalConnectionProblemDefault,
  13. List<TransportWsEventHandler>? eventHandlers,
  14. String generateID() = generateUUID,
  15. RequestSerializer serializer = const RequestSerializer(),
  16. ResponseParser parser = const ResponseParser(),
  17. FutureOr<Object> graphQLSocketMessageEncoder(
    1. TransportWsMessage message
    ) = defaultGraphQLSocketMessageEncoder,
  18. GraphQLSocketMessageDecoder graphQLSocketMessageDecoder = defaultGraphQLSocketMessageDecoder,
  19. void log(
    1. String logMessage
    )?,
})

Options for a TransportWsClient instance.

Implementation

const TransportWsClientOptions({
  required this.socketMaker,
  this.connectionParams,
  this.lazy = true,
  this.onNonLazyError = print,
  this.lazyCloseTimeout = Duration.zero,
  this.keepAlive = Duration.zero,
  this.connectionAckWaitTimeout = Duration.zero,
  this.disablePong = false,
  this.retryAttempts = 0,
  this.retryWait = randomizedExponentialBackoff,
  this.shouldRetry = shouldRetryDefault,
  this.isFatalConnectionProblem = isFatalConnectionProblemDefault,
  this.eventHandlers,
  this.generateID = generateUUID,
  this.serializer = const RequestSerializer(),
  this.parser = const ResponseParser(),
  this.graphQLSocketMessageEncoder = defaultGraphQLSocketMessageEncoder,
  this.graphQLSocketMessageDecoder = defaultGraphQLSocketMessageDecoder,
  this.log,
});