io.vertx.kotlin.ext.web.handler.sockjs.SockJSHandlerOptions.kt Maven / Gradle / Ivy
/*
* Copyright 2019 Red Hat, Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.kotlin.ext.web.handler.sockjs
import io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions
/**
* A function providing a DSL for building [io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions] objects.
*
* Options for configuring a SockJS handler
*
* @param sessionTimeout Set the delay before the server sends a close event when a client receiving connection has not been seen for a while. Defaults to 5 seconds.
* @param insertJSESSIONID Whether to insert a JSESSIONID cookie so load-balancers ensure requests for a specific SockJS session are always routed to the correct server.
Defaults to true.
* @param heartbeatInterval In order to keep proxies and load balancers from closing long running HTTP requests we need to pretend that the connection is active and send a heartbeat packet once in a while. This setting controls how often this is done.
Defaults to 25 seconds.
* @param maxBytesStreaming Most streaming transports save responses on the client side and don't free memory used by delivered messages. Such transports need to be garbage-collected once in a while.
This setting controls the maximum number of bytes that can be sent over a single HTTP streaming request before it will be closed. After that the client needs to open new request. Setting this value to one effectively disables streaming and will make streaming transports to behave like polling transports.
Defaults to 128K.
* @param libraryURL Transports which don't support cross-domain communication natively use an iframe trick. A simple page is served from the SockJS server (using its foreign domain) and is placed in an invisible iframe.
Code run from this iframe doesn't need to worry about cross-domain issues, as it's being run from domain local to the SockJS server. This iframe also does need to load SockJS javascript client library, and this option lets you specify its URL.
* @param disabledTransports Add a transport (by name) to the set of disabled transports.
* @param registerWriteHandler Whether a writeHandler should be registered on the [io.vertx.core.eventbus.EventBus].
Defaults to false.
* @param localWriteHandler Whether the writeHandler should be local only or cluster-wide.
Defaults to true.
* @param origin Set the origin to be verified before a websocket upgrade happens.
Defaults to null.
*
*
* NOTE: This function has been automatically generated from the [io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions original] using Vert.x codegen.
*/
fun sockJSHandlerOptionsOf(
sessionTimeout: Long? = null,
insertJSESSIONID: Boolean? = null,
heartbeatInterval: Long? = null,
maxBytesStreaming: Int? = null,
libraryURL: String? = null,
disabledTransports: Iterable? = null,
registerWriteHandler: Boolean? = null,
localWriteHandler: Boolean? = null,
origin: String? = null): SockJSHandlerOptions = io.vertx.ext.web.handler.sockjs.SockJSHandlerOptions().apply {
if (sessionTimeout != null) {
this.setSessionTimeout(sessionTimeout)
}
if (insertJSESSIONID != null) {
this.setInsertJSESSIONID(insertJSESSIONID)
}
if (heartbeatInterval != null) {
this.setHeartbeatInterval(heartbeatInterval)
}
if (maxBytesStreaming != null) {
this.setMaxBytesStreaming(maxBytesStreaming)
}
if (libraryURL != null) {
this.setLibraryURL(libraryURL)
}
if (disabledTransports != null) {
for (item in disabledTransports) {
this.addDisabledTransport(item)
}
}
if (registerWriteHandler != null) {
this.setRegisterWriteHandler(registerWriteHandler)
}
if (localWriteHandler != null) {
this.setLocalWriteHandler(localWriteHandler)
}
if (origin != null) {
this.setOrigin(origin)
}
}