Coldwave Documentation

Appearance

FlakeClientConfiguration ​

Configuration struct for a Flake Client

swift
struct FlakeClientConfiguration

Initializers ​

init(replyTimeoutMilliseconds:numberOfConsecutiveTimeoutsBeforeClose:) ​

swift
init(replyTimeoutMilliseconds: Int, numberOfConsecutiveTimeoutsBeforeClose: Int?)

Instance Properties ​

numberOfConsecutiveTimeoutsBeforeClose ​

swift
let numberOfConsecutiveTimeoutsBeforeClose: Int?

The number of timeout errors until the connection is considered to be defect and as a result closed. If nil timeouts will not trigger the closing of the connection.

replyTimeoutMilliseconds ​

swift
let replyTimeoutMilliseconds: Int

Time in milliseconds until a reply is considered to be lost

shouldCloseConnectionOnTimeout ​

swift
var shouldCloseConnectionOnTimeout: Bool

Convenients property to check if timeouts will trigger a close, depends on numberOfConsecutiveTimeoutsBeforeClose

Type Properties ​

default ​

swift
static var `default`: FlakeClientConfiguration

Default Configuration