org.eclipse.milo.opcua.stack.client

Class UaStackClient

java.lang.Object

org.eclipse.milo.opcua.stack.client.UaStackClient

public class UaStackClient
extends Object

Constructor Summary

Constructors

Constructor and Description
UaStackClient(UaStackClientConfig config, Function<UaStackClient,UaTransport> transportFactory)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<UaStackClient>	connect() Connect this UaStackClient to the server in the configured endpoint.
static UaStackClient	create(UaStackClientConfig config) Create a UaStackClient with config.
CompletableFuture<UaStackClient>	disconnect() Disconnect this UaStackClient from the server in the configured endpoint.
UaStackClientConfig	getConfig()
DataTypeManager	getDynamicDataTypeManager() Get the client's "dynamic" DataTypeManager.
SerializationContext	getDynamicSerializationContext() Get a "dynamic" SerializationContext.
NamespaceTable	getNamespaceTable() Get the client NamespaceTable.
DataTypeManager	getStaticDataTypeManager() Get the client's "static" DataTypeManager.
SerializationContext	getStaticSerializationContext() Get a "static" SerializationContext instance.
RequestHeader	newRequestHeader() Create a new RequestHeader with a null authentication token.
RequestHeader	newRequestHeader(NodeId authToken) Create a new RequestHeader with authToken.
RequestHeader	newRequestHeader(NodeId authToken, UInteger requestTimeout) Create a new RequestHeader with authToken and requestTimeout.
CompletableFuture<UaResponseMessage>	sendRequest(UaRequestMessage request) Send a UaRequestMessage to the connected server.

Methods inherited from class java.lang.Object

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

Constructor Detail

UaStackClient

public UaStackClient(UaStackClientConfig config,
                     Function<UaStackClient,UaTransport> transportFactory)

Method Detail

getConfig

public UaStackClientConfig getConfig()

Returns:

the UaStackClientConfig this client was created with.

connect

public CompletableFuture<UaStackClient> connect()

Connect this UaStackClient to the server in the configured endpoint.

Depending on the underlying transport this may or may not actually make a connection attempt.

Returns:

this UaStackClient.

disconnect

public CompletableFuture<UaStackClient> disconnect()

Disconnect this UaStackClient from the server in the configured endpoint.

Depending on the underlying transport this may or may not actually make a disconnect attempt.

Returns:

this UaStackClient.

getNamespaceTable

public NamespaceTable getNamespaceTable()

Get the client NamespaceTable.

Returns:

the client NamespaceTable.

getStaticDataTypeManager

public DataTypeManager getStaticDataTypeManager()

Get the client's "static" DataTypeManager.

This DataTypeManager is for static codecs that serialize classes that exist at compile time, e.g. structures from namespace 0 and or code-generated structures.

Returns:

the client's static DataTypeManager.

getDynamicDataTypeManager

public DataTypeManager getDynamicDataTypeManager()

Get the client's "dynamic" DataTypeManager.

This DataTypeManager is for dynamic codecs that were created by reading the server's DataType Dictionary at runtime and serializes generic representations of structures used by instances of a BsdParser implementation.

Returns:

the client's dynamic DataTypeManager.

getStaticSerializationContext

public SerializationContext getStaticSerializationContext()

Get a "static" SerializationContext instance.

This SerializationContext instance returns the client's static DataTypeManager.

Returns:

a "static" SerializationContext instance.

See Also:

getStaticDataTypeManager()

getDynamicSerializationContext

public SerializationContext getDynamicSerializationContext()

Get a "dynamic" SerializationContext.

This SerializationContext instance returns the client's dynamic DataTypeManager.

Returns:

a "dynamic" SerializationContext.

See Also:

getDynamicDataTypeManager()

newRequestHeader

public RequestHeader newRequestHeader()

Create a new RequestHeader with a null authentication token.

A unique request handle will be automatically assigned to the header.

Returns:

a new RequestHeader with a null authentication token.

newRequestHeader

public RequestHeader newRequestHeader(NodeId authToken)

Create a new RequestHeader with authToken.

A unique request handle will be automatically assigned to the header.

Parameters:

authToken - the authentication token to create the header with.

Returns:

a new RequestHeader created with authToken.

newRequestHeader

public RequestHeader newRequestHeader(NodeId authToken,
                                      UInteger requestTimeout)

Create a new RequestHeader with authToken and requestTimeout.

A unique request handle will be automatically assigned to the header.

Parameters:

authToken - the authentication token to create the header with.

requestTimeout - the timeout hint to create the header with.f

Returns:

a new RequestHeader created with authToken and requestTimeout.

sendRequest

public CompletableFuture<UaResponseMessage> sendRequest(UaRequestMessage request)

Send a UaRequestMessage to the connected server.

The RequestHeader of request must have a unique request handle. Use the newRequestHeader helper functions to create headers for UaRequestMessages.

Parameters:

request - the UaRequestMessage to send.

Returns:

a CompletableFuture containing the eventual UaResponseMessage from the server.

See Also:

newRequestHeader(), newRequestHeader(NodeId), newRequestHeader(NodeId, UInteger)

create

public static UaStackClient create(UaStackClientConfig config)
                            throws UaException

Create a UaStackClient with config.

The UaTransport instance to create will be inferred from the transport profile URI in the configured endpoint.

Supported transports:

• TCP + UA Binary
• HTTP(s) + UA Binary

Experimentally supported:

• WebSocket + UA Binary

Not supported:

• HTTP(s) + UA JSON
• HTTP(s) + UA XML
• WebSocket + UA JSON

Parameters:

config - the UaStackClientConfig.

Returns:

a UaStackClient created with config.

Throws:

UaException - if the transport is unsupported.