com.prosysopc.ua.stack.transport.tcp.io

Class OpcTcpSettings

java.lang.Object

com.prosysopc.ua.stack.transport.tcp.io.OpcTcpSettings

All Implemented Interfaces:

Cloneable

public class OpcTcpSettings
extends Object
implements Cloneable

Settings used when making opc.tcp connections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpcTcpSettings.Flag

Constructor Summary

Constructors

Constructor and Description
OpcTcpSettings()

Method Summary

Modifier and Type	Method and Description
OpcTcpSettings	clone()
CertificateValidator	getCertificateValidator() Getter for the field certificateValidator.
Cert	getClientCertificate() Getter for the field clientCertificate.
int	getConnectTimeout() Timeout for the initial socket connect operation, in milliseconds.
EnumSet<OpcTcpSettings.Flag>	getFlags() Getter for the field flags.
int	getHandshakeTimeout() Timeout for the initial handshake (Hello/Acknowledge exchange) after a socket connection is opened.
int	getMaxConnections()
PrivKey	getPrivKey() Getter for the field privKey.
int	getReverseHelloAcceptTimeout() Get the timeout used to listen on reverse connections, in milliseconds.
TcpConnection.SocketFactory	getSocketFactory() The TcpConnection.SocketFactory to be used in the connection (if null TcpConnection.getSocketFactory() is used instead).
void	readFrom(OpcTcpSettings tcs) readFrom.
void	setCertificateValidator(CertificateValidator certificateValidator) Setter for the field certificateValidator.
void	setClientCertificate(Cert clientCertificate) Setter for the field clientCertificate.
void	setClientCertificate(X509Certificate clientCertificate) Setter for the field clientCertificate.
void	setConnectTimeout(int connectTimeout) See getConnectTimeout().
void	setFlags(EnumSet<OpcTcpSettings.Flag> flags) Setter for the field flags.
void	setHandshakeTimeout(int handshakeTimeout) See getHandshakeTimeout().
void	setMaxConnections(int maxConnections)
void	setPrivKey(PrivKey privKey) Setter for the field privKey.
void	setReverseHelloAcceptTimeout(int reverseHelloListenTimeout) See getReverseHelloAcceptTimeout().
void	setSocketFactory(TcpConnection.SocketFactory socketFactory) The TcpConnection.SocketFactory to be used in the connection (if null TcpConnection.getSocketFactory() is used instead).

Methods inherited from class java.lang.Object

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

Constructor Detail

OpcTcpSettings

public OpcTcpSettings()

Method Detail

clone

public OpcTcpSettings clone()

Overrides:

clone in class Object

getCertificateValidator

public CertificateValidator getCertificateValidator()

Getter for the field certificateValidator.

Returns:

a CertificateValidator object.

getClientCertificate

public Cert getClientCertificate()

Getter for the field clientCertificate.

Returns:

a Cert object.

getConnectTimeout

public int getConnectTimeout()

Timeout for the initial socket connect operation, in milliseconds. NOTE! this value is passed to Socket.connect(java.net.SocketAddress, int). However in practice the maximum timeout is determined by the Operating System. If this is -1, then TcpConnection.getDefaultHandshakeTimeout() is used.

getFlags

public EnumSet<OpcTcpSettings.Flag> getFlags()

Getter for the field flags.

Returns:

a EnumSet object.

getHandshakeTimeout

public int getHandshakeTimeout()

Timeout for the initial handshake (Hello/Acknowledge exchange) after a socket connection is opened.

getMaxConnections

public int getMaxConnections()

getPrivKey

public PrivKey getPrivKey()

Getter for the field privKey.

Returns:

a PrivKey object.

getReverseHelloAcceptTimeout

public int getReverseHelloAcceptTimeout()

Get the timeout used to listen on reverse connections, in milliseconds. Use -1 to use the default of TcpConnection.getDefaultReverseHelloAcceptTimeout(). 0 is infinite.

getSocketFactory

public TcpConnection.SocketFactory getSocketFactory()

The TcpConnection.SocketFactory to be used in the connection (if null TcpConnection.getSocketFactory() is used instead).

readFrom

public void readFrom(OpcTcpSettings tcs)

readFrom.

Parameters:

tcs - a OpcTcpSettings object.

setCertificateValidator

public void setCertificateValidator(CertificateValidator certificateValidator)

Setter for the field certificateValidator.

Parameters:

certificateValidator - a CertificateValidator object.

setClientCertificate

public void setClientCertificate(Cert clientCertificate)

Setter for the field clientCertificate.

Parameters:

clientCertificate - a Cert object.

setClientCertificate

public void setClientCertificate(X509Certificate clientCertificate)
                          throws CertificateEncodingException

Setter for the field clientCertificate.

Parameters:

clientCertificate - a X509Certificate object.

Throws:

CertificateEncodingException - if any.

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

See getConnectTimeout().

setFlags

public void setFlags(EnumSet<OpcTcpSettings.Flag> flags)

Setter for the field flags.

Parameters:

flags - a EnumSet object.

setHandshakeTimeout

public void setHandshakeTimeout(int handshakeTimeout)

See getHandshakeTimeout().

setMaxConnections

public void setMaxConnections(int maxConnections)

setPrivKey

public void setPrivKey(PrivKey privKey)

Setter for the field privKey.

Parameters:

privKey - a PrivKey object.

setReverseHelloAcceptTimeout

public void setReverseHelloAcceptTimeout(int reverseHelloListenTimeout)

See getReverseHelloAcceptTimeout().

setSocketFactory

public void setSocketFactory(TcpConnection.SocketFactory socketFactory)

The TcpConnection.SocketFactory to be used in the connection (if null TcpConnection.getSocketFactory() is used instead).