Type Alias ReliableChannelOptions

Type declaration

• OptionalautoStart?: boolean

  Whether to auto start the message channel

  Default

  true
  Copy

• OptionalmaxRetryAttempts?: number

  How many times do we attempt resending messages that were not acknowledged.

  Default

  10 [[DEFAULT_MAX_RETRY_ATTEMPTS]]
  Copy

• OptionalprocessTaskMinElapseMs?: number

  The minimum elapse time between calling the underlying channel process task for incoming messages. This is to avoid overload when processing a lot of messages.

  Default

  1000 (1 second)
  Copy

• OptionalqueryOnConnect?: boolean

  Whether to automatically do a store query after connection to store nodes.

  Default

  true
  Copy

• OptionalretrievalStrategy?: RetrievalStrategy

  Strategy for retrieving missing messages.

  Default

  'both'
  Copy

• OptionalretrieveFrequencyMs?: number

  How often store queries are done to retrieve missing messages. Only applies when retrievalStrategy includes Store ('both' or 'store-only').

  Default

  10,000 (10 seconds)
  Copy

• OptionalretryIntervalMs?: number

  How long to wait before re-sending a message that as not acknowledged.

  Default

  60,000 (60 seconds) [[DEFAULT_RETRY_INTERVAL_MS]]
  Copy

• OptionalsweepInBufIntervalMs?: number

  How often SDS message channel incoming buffer is swept.

  Default

  5000 (every 5 seconds)
  Copy

• OptionalsyncMinIntervalMs?: number

  The minimum interval between 2 sync messages in the channel.

  Meaning, how frequently we want messages in the channel, noting that the responsibility of sending a sync messages is shared between participants of the channel.

  0 means no sync messages will be sent.

  Default

  30,000 (30 seconds) [[DEFAULT_SYNC_MIN_INTERVAL_MS]]
  Copy