WebSockets

class WebSockets

Client WebSocket feature.

Types

Feature

companion object Feature : 
    HttpClientFeature<Unit, WebSockets>

Constructors

<init>

WebSockets(
    pingInterval: Long = -1L,
    maxFrameSize: Long = Int.MAX_VALUE.toLong())

Client WebSocket feature.

Properties

maxFrameSize

val maxFrameSize: Long
  • max size of single websocket frame.

pingInterval

val pingInterval: Long

Companion Object Properties

key

The AttributeKey for this feature.

Companion Object Functions

install

fun install(feature: WebSockets, scope: HttpClient): Unit

Installs the feature class for a HttpClient defined at scope.

prepare

fun prepare(block: Unit.() -> Unit): WebSockets

Builds a TFeature by calling the block with a TConfig config instance as receiver.