org.eclipse.milo.opcua.sdk.client.api.config

Interface OpcUaClientConfig

All Superinterfaces:

UaStackClientConfig

public interface OpcUaClientConfig
extends UaStackClientConfig

Method Summary

Modifier and Type	Method and Description
static OpcUaClientConfigBuilder	builder()
static OpcUaClientConfigBuilder	copy(OpcUaClientConfig config) Copy the values from an existing OpcUaClientConfig into a new OpcUaClientConfigBuilder.
static OpcUaClientConfig	copy(OpcUaClientConfig config, Consumer<OpcUaClientConfigBuilder> consumer) Copy the values from an existing OpcUaClientConfig into a new OpcUaClientConfigBuilder and then submit the builder to the provided consumer for modification.
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getApplicationName()
String	getApplicationUri()
IdentityProvider	getIdentityProvider()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getKeepAliveFailuresAllowed()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getKeepAliveInterval()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getKeepAliveTimeout()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMaxPendingPublishRequests()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMaxResponseMessageSize()
String	getProductUri()
String[]	getSessionLocaleIds()
Supplier<String>	getSessionName()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getSessionTimeout()

Methods inherited from interface org.eclipse.milo.opcua.stack.client.UaStackClientConfig

copy, copy, getAcknowledgeTimeout, getCertificate, getCertificateChain, getCertificateValidator, getChannelLifetime, getConnectTimeout, getEncodingLimits, getEndpoint, getEventLoop, getExecutor, getKeyPair, getRequestTimeout, getScheduledExecutor, getWheelTimer

Method Detail

getApplicationName

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getApplicationName()

Returns:

the name of the client application, as a LocalizedText.

getApplicationUri

String getApplicationUri()

Returns:

a URI for the client's application instance. This should be the same as the URI in the client certificate, if present.

getProductUri

String getProductUri()

Returns:

the URI for the client's application product.

getSessionName

Supplier<String> getSessionName()

Returns:

a Supplier for the session name.

getSessionLocaleIds

String[] getSessionLocaleIds()

Returns:

the list of locale ids in priority order for localized strings

getSessionTimeout

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getSessionTimeout()

Returns:

the session timeout, in milliseconds, to request.

getMaxResponseMessageSize

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxResponseMessageSize()

Returns:

the maximum size for a response from the server.

getMaxPendingPublishRequests

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxPendingPublishRequests()

Returns:

the maximum number of outstanding PublishRequests allowed at any given time.

getIdentityProvider

IdentityProvider getIdentityProvider()

Returns:

an IdentityProvider to use when activating a session.

getKeepAliveFailuresAllowed

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getKeepAliveFailuresAllowed()

Returns:

the number of consecutive keep-alive request failures allowed before a connection is determined to be in error state.

getKeepAliveInterval

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getKeepAliveInterval()

Returns:

the interval, in milliseconds, between consecutive keep-alive requests.

getKeepAliveTimeout

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getKeepAliveTimeout()

Returns:

the amount of time to wait, in milliseconds, for a keep-alive request before timing out.

builder

static OpcUaClientConfigBuilder builder()

Specified by:

builder in interface UaStackClientConfig

Returns:

a new OpcUaClientConfigBuilder.

copy

static OpcUaClientConfigBuilder copy(OpcUaClientConfig config)

Copy the values from an existing OpcUaClientConfig into a new OpcUaClientConfigBuilder. This builder can be used to make any desired modifications before invoking OpcUaClientConfigBuilder.build() to produce a new config.

Parameters:

config - the OpcUaClientConfig to copy from.

Returns:

a OpcUaClientConfigBuilder pre-populated with values from config.

copy

static OpcUaClientConfig copy(OpcUaClientConfig config,
                              Consumer<OpcUaClientConfigBuilder> consumer)

Copy the values from an existing OpcUaClientConfig into a new OpcUaClientConfigBuilder and then submit the builder to the provided consumer for modification.

Parameters:

config - the OpcUaClientConfig to copy from.

consumer - a Consumer that may modify the builder.

Returns:

a OpcUaClientConfig built from the builder provided to consumer.