com.buabook.kdb.connection

Class KdbConnection

java.lang.Object

com.buabook.kdb.connection.KdbConnection

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

KdbConsumer, KdbPublisher

public class KdbConnection
extends Object
implements AutoCloseable

KDB Connection Wrapper

Class provides connect / disconnect / reconnect functionality on top of the default c class.

NOTE: By default this class exposes no send / receive functionality. This is left up to extension classes to provide these features.

(c) 2014 - 2015 Sport Trades Ltd

Since:

27 Apr 2014

Version:

1.0.1

Author:

Jas Rajasansir

Field Summary

Fields

Modifier and Type	Field and Description
private c	connection The current active connection to the kdb process
private static Integer	DEFAULT_RECONNECT_INTERVAL_MS The default reconnection interval in milliseconds
private static org.slf4j.Logger	log
private KdbProcess	process The details of the process to connect to
protected Integer	reconnectIntervalMs The amount of time in milliseconds to wait between connection attempts

Constructor Summary

Constructors

Constructor and Description
KdbConnection(KdbProcess process) Creates a new kdb connection object with the reconnection interval set as the default (as defined by DEFAULT_RECONNECT_INTERVAL_MS.
KdbConnection(KdbProcess process, Integer reconnectIntervalMs) Creates a new kdb connection object with the specified reconnection interval.

Method Summary

Modifier and Type	Method and Description
void	close()
void	connect() Performs the connection to the KDB process
void	disconnect() Disconnects from the KDB process (by closing the underlying socket)
c	getConnection()
KdbProcess	getRemoteProcess()
boolean	isConnected()
void	reconnect() Provides the ability to reconnect to the target KDB process if necessary (generally after an IOException).

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.slf4j.Logger log

DEFAULT_RECONNECT_INTERVAL_MS

private static final Integer DEFAULT_RECONNECT_INTERVAL_MS

The default reconnection interval in milliseconds

reconnectIntervalMs

protected final Integer reconnectIntervalMs

The amount of time in milliseconds to wait between connection attempts

process

private final KdbProcess process

The details of the process to connect to

connection

private c connection

The current active connection to the kdb process

Constructor Detail

KdbConnection

public KdbConnection(KdbProcess process)

Creates a new kdb connection object with the reconnection interval set as the default (as defined by DEFAULT_RECONNECT_INTERVAL_MS. NOTE: Calling this constructor will not initiate the connection. This must be done manually by calling connect().

Parameters:

process - The kdb process to connect to

See Also:

KdbConnection(KdbProcess, Integer)

KdbConnection

public KdbConnection(KdbProcess process,
                     Integer reconnectIntervalMs)

Creates a new kdb connection object with the specified reconnection interval. NOTE: Calling this constructor will not initiate the connection. This must be done manually by calling connect().

Parameters:

process - The kdb process to connect to

reconnectIntervalMs - The reconnect interval (in milliseconds) in case the connection is lost

Method Detail

connect

public void connect()
             throws KdbTargetProcessUnavailableException

Performs the connection to the KDB process

Throws:

KdbTargetProcessUnavailableException - If the target KDB process is unavailable

See Also:

reconnect()

disconnect

public void disconnect()

Disconnects from the KDB process (by closing the underlying socket)

isConnected

public boolean isConnected()

Returns:

False if either the connection object or the connection Socket is null. NOTE: These are the only two circumstances where false will be returned. True will be returned in all other cases.

getConnection

public c getConnection()

Returns:

The current connection to the kdb process

getRemoteProcess

public KdbProcess getRemoteProcess()

Returns:

The remote process that this connection object is connected to

reconnect

public void reconnect()

Provides the ability to reconnect to the target KDB process if necessary (generally after an IOException). Function will also force a disconnect of the underlying Socket, just to be sure.

NOTE: This function will block in a retry loop if the kdb process is unavailable when attempting to connect.

See Also:

reconnectIntervalMs

close

public void close()

Specified by:

close in interface AutoCloseable