Package com.inductiveautomation.ignition.client.gateway_interface

Class GatewayConnectionContext.Builder

java.lang.Object

com.inductiveautomation.ignition.client.gateway_interface.GatewayConnectionContext.Builder

Enclosing class:

GatewayConnectionContext

public static final class GatewayConnectionContext.Builder
extends Object

Builder class for customizing a new instance of GatewayConnectionContext using a fluent-style API.

Method Summary

Modifier and Type	Method	Description
GatewayConnectionContext	build()	Build a new GatewayConnectionContext.
GatewayConnectionContext.Builder	setIdleTimeoutMs(SystemProp<Long> idleTimeoutMs)	Set the SystemProp for customizing the WebSocket's idle timeout
GatewayConnectionContext.Builder	setMaxBinaryMessageSizeKb(SystemProp<Integer> maxBinaryMessageSizeKb)	Set the SystemProp for customizing the WebSocket's max binary message size
GatewayConnectionContext.Builder	setMaxTextMessageSizeKb(SystemProp<Integer> maxTextMessageSizeKb)	Set the SystemProp for customizing the WebSocket's max text message size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setMaxBinaryMessageSizeKb

public GatewayConnectionContext.Builder setMaxBinaryMessageSizeKb(SystemProp<Integer> maxBinaryMessageSizeKb)

Set the SystemProp for customizing the WebSocket's max binary message size

Parameters:

maxBinaryMessageSizeKb - the SystemProp for customizing the WebSocket's max binary message size

Returns:

this GatewayConnectionContext.Builder instance (never null)

setMaxTextMessageSizeKb

public GatewayConnectionContext.Builder setMaxTextMessageSizeKb(SystemProp<Integer> maxTextMessageSizeKb)

Set the SystemProp for customizing the WebSocket's max text message size

Parameters:

maxTextMessageSizeKb - the SystemProp for customizing the WebSocket's max text message size

Returns:

this GatewayConnectionContext.Builder instance (never null)

setIdleTimeoutMs

public GatewayConnectionContext.Builder setIdleTimeoutMs(SystemProp<Long> idleTimeoutMs)

Set the SystemProp for customizing the WebSocket's idle timeout

Parameters:

idleTimeoutMs - the SystemProp for customizing the WebSocket's idle timeout

Returns:

this GatewayConnectionContext.Builder instance (never null)

build

public GatewayConnectionContext build()

Build a new GatewayConnectionContext. The GatewayConnectionContext will be created with a new cached worker thread pool and a single threaded scheduler thread.

Returns:

The new GatewayConnectionContext instance. Never null.