com.devexperts.qd.qtp.socket

Class ClientSocketConnector

java.lang.Object

com.devexperts.qd.qtp.AbstractMessageConnector

com.devexperts.qd.qtp.socket.ClientSocketConnector

All Implemented Interfaces:

MessageConnector, MessageConnectorMBean, ClientSocketConnectorMBean, SocketHandler.CloseListener

@MessageConnectorSummary(info="Connects to some host using TCP/IP client socket.",
                         addressFormat="<host>:<port>")
public class ClientSocketConnector
extends AbstractMessageConnector
implements SocketHandler.CloseListener, ClientSocketConnectorMBean

The ClientSocketConnector handles standard client socket using blocking API.

Nested Class Summary

Nested classes/interfaces inherited from class com.devexperts.qd.qtp.AbstractMessageConnector

AbstractMessageConnector.Joinable

Nested classes/interfaces inherited from interface com.devexperts.qd.qtp.MessageConnector

MessageConnector.Bindable

Field Summary

Fields

Modifier and Type	Field and Description
protected String	address
protected LocalTime	connectionRestoreTime
protected ConnectOrder	connectOrder
protected String	proxyHost
protected int	proxyPort
protected List<SocketAddress>	socketAddresses
protected String	stripeConfig
protected SymbolStriper	striper
protected TrustManager	trustManager
protected boolean	useTls

Fields inherited from class com.devexperts.qd.qtp.AbstractMessageConnector

log

Constructor Summary

Constructors

Constructor and Description
ClientSocketConnector(com.devexperts.connector.proto.ApplicationConnectionFactory factory, String address) Creates new client socket connector.
ClientSocketConnector(com.devexperts.connector.proto.ApplicationConnectionFactory factory, String host, int port) Deprecated.
ClientSocketConnector(MessageAdapter.Factory factory, String host, int port) Deprecated. use ClientSocketConnector(ApplicationConnectionFactory, String, int)

Method Summary

Modifier and Type	Method and Description
protected Socket	createSocket(String host, int port)
String	getAddress() Address string of connector.
int	getConnectionCount() Number of established connections
ConnectOrder	getConnectOrder()
String[]	getCurrentAddresses() List of addresses (host:port) for all active connections
String	getCurrentHost() Current IP address of connection when connecting to the cluster
int	getCurrentPort()
String	getHost() Deprecated.
int	getPort() Deprecated.
String	getProxyHost() HTTP proxy host name
int	getProxyPort() HTTP proxy port
String	getRestoreTime()
MessageConnectorState	getState() State of connector.
String	getStripe() Symbol striper for connector, auto (for system default), or null (default)
boolean	getTls() Deprecated.
TrustManager	getTrustManager() Deprecated.
void	handlerClosed(com.devexperts.qd.qtp.socket.SocketHandler handler)
boolean	isActive() True when connector is active (started).
protected void	restartImpl(boolean fullStop) Restart logic implementation; If fullStop is false, connection context (like last chosen address for multi-host connections) may be preserved.
String	restoreGracefully(String gracefulDelay) Restore connection graceful with delay in TimePeriod format
String	restoreNow()
com.devexperts.transport.stats.EndpointStats	retrieveCompleteEndpointStats() Retrieves endpoint statistics for this message connector since its creation
void	setAddress(String address)
void	setConnectOrder(ConnectOrder connectOrder)
void	setHost(String host) Deprecated.
void	setPort(int port) Deprecated.
void	setProxyHost(String proxyHost)
void	setProxyPort(int proxyPort)
void	setRestoreTime(String restoreTime)
void	setStats(QDStats stats) Sets stats for this connector.
void	setStripe(String stripeConfig)
void	setTls(boolean useTls) Deprecated.
void	setTrustManager(TrustManager trustManager) Deprecated.
void	start() Starts connector (connection is immediately established).
protected AbstractMessageConnector.Joinable	stopImpl()

Methods inherited from class com.devexperts.qd.qtp.AbstractMessageConnector

addClosedConnectionStats, addMessageConnectorListener, close, closeImpl, getClosedConnectionCount, getEndpointStats, getFactory, getFieldReplacer, getLogging, getName, getPassword, getReconnectDelay, getStats, getThreadPriority, getUser, handlerClosed, isClosed, notifyMessageConnectorListeners, reconfigure, reconnect, removeMessageConnectorListener, resetEndpointStats, restart, setFactory, setFieldReplacer, setName, setPassword, setReconnectDelay, setThreadPriority, setUser, stop, stopAndWait, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.devexperts.qd.qtp.MessageConnectorMBean

getEndpointStats, getFieldReplacer, getName, getPassword, getReconnectDelay, getThreadPriority, getUser, reconnect, resetEndpointStats, restart, setFieldReplacer, setName, setPassword, setReconnectDelay, setThreadPriority, setUser, stop

Methods inherited from interface com.devexperts.qd.qtp.MessageConnector

awaitProcessed

Field Detail

address

protected String address

socketAddresses

protected List<SocketAddress> socketAddresses

proxyHost

protected String proxyHost

proxyPort

protected int proxyPort

connectOrder

protected ConnectOrder connectOrder

connectionRestoreTime

protected LocalTime connectionRestoreTime

striper

protected SymbolStriper striper

stripeConfig

protected String stripeConfig

useTls

protected boolean useTls

trustManager

protected TrustManager trustManager

Constructor Detail

ClientSocketConnector

@Deprecated
public ClientSocketConnector(MessageAdapter.Factory factory,
                                         String host,
                                         int port)

Deprecated. use ClientSocketConnector(ApplicationConnectionFactory, String, int)

Creates new client socket connector.

Parameters:

factory - message adapter factory to use

host - host to connect to

port - TCP port to connect to

Throws:

NullPointerException - if factory or host is null

ClientSocketConnector

@Deprecated
public ClientSocketConnector(com.devexperts.connector.proto.ApplicationConnectionFactory factory,
                                         String host,
                                         int port)

Deprecated.

Creates new client socket connector.

Parameters:

factory - application connection factory to use

host - host to connect to

port - TCP port to connect to

Throws:

NullPointerException - if factory or host is null

ClientSocketConnector

public ClientSocketConnector(com.devexperts.connector.proto.ApplicationConnectionFactory factory,
                             String address)

Creates new client socket connector.

Parameters:

factory - application connection factory to use

address - list of addresses

Throws:

NullPointerException - if factory or address is null

Method Detail

getAddress

public String getAddress()

Description copied from interface: MessageConnectorMBean

Address string of connector.

Specified by:

getAddress in interface MessageConnectorMBean

Returns:

address string of this connector. It is "[host1[:port1],host2[:port2],...]:port" for client socket connector and ":port" for server socket connector.

setAddress

public void setAddress(String address)

Specified by:

setAddress in interface ClientSocketConnectorMBean

getHost

@Deprecated
public String getHost()

Deprecated.

Description copied from interface: ClientSocketConnectorMBean

Host name of IP address.

Specified by:

getHost in interface ClientSocketConnectorMBean

setHost

@Deprecated
public void setHost(String host)

Deprecated.

getPort

@Deprecated
public int getPort()

Deprecated.

Description copied from interface: ClientSocketConnectorMBean

Port number of IP address.

Specified by:

getPort in interface ClientSocketConnectorMBean

setPort

@Deprecated
public void setPort(int port)

Deprecated.

getProxyHost

public String getProxyHost()

Description copied from interface: ClientSocketConnectorMBean

HTTP proxy host name

Specified by:

getProxyHost in interface ClientSocketConnectorMBean

setProxyHost

public void setProxyHost(String proxyHost)

Specified by:

setProxyHost in interface ClientSocketConnectorMBean

getProxyPort

public int getProxyPort()

Description copied from interface: ClientSocketConnectorMBean

HTTP proxy port

Specified by:

getProxyPort in interface ClientSocketConnectorMBean

setProxyPort

public void setProxyPort(int proxyPort)

Specified by:

setProxyPort in interface ClientSocketConnectorMBean

getConnectOrder

public ConnectOrder getConnectOrder()

Specified by:

getConnectOrder in interface ClientSocketConnectorMBean

setConnectOrder

public void setConnectOrder(ConnectOrder connectOrder)

Specified by:

setConnectOrder in interface ClientSocketConnectorMBean

getRestoreTime

public String getRestoreTime()

Specified by:

getRestoreTime in interface ClientSocketConnectorMBean

setRestoreTime

public void setRestoreTime(String restoreTime)

Specified by:

setRestoreTime in interface ClientSocketConnectorMBean

restoreNow

public String restoreNow()

Specified by:

restoreNow in interface ClientSocketConnectorMBean

restoreGracefully

public String restoreGracefully(String gracefulDelay)

Description copied from interface: ClientSocketConnectorMBean

Restore connection graceful with delay in TimePeriod format

Specified by:

restoreGracefully in interface ClientSocketConnectorMBean

getStripe

public String getStripe()

Description copied from interface: ClientSocketConnectorMBean

Symbol striper for connector, auto (for system default), or null (default)

Specified by:

getStripe in interface ClientSocketConnectorMBean

setStripe

public void setStripe(String stripeConfig)

Specified by:

setStripe in interface ClientSocketConnectorMBean

getTls

@Deprecated
public boolean getTls()

Deprecated.

setTls

@Deprecated
public void setTls(boolean useTls)

Deprecated.

getTrustManager

@Deprecated
public TrustManager getTrustManager()

Deprecated.

setTrustManager

@Deprecated
public void setTrustManager(TrustManager trustManager)

Deprecated.

Sets the custom trust manager to be used by SSLSocketFactory. This property has effect only when the connector is configured to use TLS.

Parameters:

trustManager - trust manager to use instead of the default one, or null in order to use default one.

setStats

public void setStats(QDStats stats)

Sets stats for this connector. Stats should be of type QDStats.SType#CLIENT_SOCKET_CONNECTOR or a suitable substitute. This method may be invoked only once.

Specified by:

setStats in interface MessageConnector

Overrides:

setStats in class AbstractMessageConnector

Throws:

IllegalStateException - if already set.

isActive

public boolean isActive()

Description copied from interface: MessageConnectorMBean

True when connector is active (started).

Specified by:

isActive in interface MessageConnectorMBean

Returns:

true if connector is started (not stopped)

getState

public MessageConnectorState getState()

Description copied from interface: MessageConnectorMBean

State of connector.

Specified by:

getState in interface MessageConnectorMBean

Returns:

message connector state.

getConnectionCount

public int getConnectionCount()

Description copied from interface: MessageConnectorMBean

Number of established connections

Specified by:

getConnectionCount in interface MessageConnectorMBean

retrieveCompleteEndpointStats

public com.devexperts.transport.stats.EndpointStats retrieveCompleteEndpointStats()

Description copied from interface: MessageConnectorMBean

Retrieves endpoint statistics for this message connector since its creation

Specified by:

retrieveCompleteEndpointStats in interface MessageConnectorMBean

Overrides:

retrieveCompleteEndpointStats in class AbstractMessageConnector

start

public void start()

Description copied from interface: MessageConnectorMBean

Starts connector (connection is immediately established). Does nothing if connector is already started.

Specified by:

start in interface MessageConnectorMBean

Specified by:

start in class AbstractMessageConnector

createSocket

protected Socket createSocket(String host,
                              int port)
                       throws IOException

Throws:

IOException

stopImpl

protected AbstractMessageConnector.Joinable stopImpl()

Specified by:

stopImpl in class AbstractMessageConnector

restartImpl

protected void restartImpl(boolean fullStop)

Description copied from class: AbstractMessageConnector

Restart logic implementation; If fullStop is false, connection context (like last chosen address for multi-host connections) may be preserved.

Overrides:

restartImpl in class AbstractMessageConnector

handlerClosed

public void handlerClosed(com.devexperts.qd.qtp.socket.SocketHandler handler)

Specified by:

handlerClosed in interface SocketHandler.CloseListener

getCurrentHost

public String getCurrentHost()

Description copied from interface: ClientSocketConnectorMBean

Current IP address of connection when connecting to the cluster

Specified by:

getCurrentHost in interface ClientSocketConnectorMBean

getCurrentPort

public int getCurrentPort()

Specified by:

getCurrentPort in interface ClientSocketConnectorMBean

getCurrentAddresses

public String[] getCurrentAddresses()

Description copied from interface: ClientSocketConnectorMBean

List of addresses (host:port) for all active connections

Specified by:

getCurrentAddresses in interface ClientSocketConnectorMBean