com.buabook.kdb.publisher

Class KdbPublisher

java.lang.Object

com.buabook.kdb.connection.KdbConnection

com.buabook.kdb.publisher.KdbPublisher

All Implemented Interfaces:

AutoCloseable

public class KdbPublisher
extends KdbConnection

KDB Data Publisher

Provides the ability to publish some data (in either KdbTable or c.Flip format) to a specific kdb process.

Any instantiation of this class will cause the publisher to run in the current thread. Use KdbPublisherThread if you need a new thread.

(c) 2014 - 2015 Sport Trades Ltd

Since:

6 Apr 2014

Version:

1.1.0

Author:

Jas Rajasansir

Field Summary

Fields

Modifier and Type	Field and Description
private static org.joda.time.Duration	DEFAULT_RESET_CONNECTION_DURATION
private org.joda.time.DateTime	lastPublishTime The time of the last successful publish to the kdb process
private static org.slf4j.Logger	log
private static String	PUBLISH_FUNCTION
private org.joda.time.Duration	resetConnectionDuration The maximum amount of time after the last publish / connect allowed before the connection to the kdb process is reset.

Fields inherited from class com.buabook.kdb.connection.KdbConnection

reconnectIntervalMs

Constructor Summary

Constructors

Constructor and Description
KdbPublisher(KdbProcess server)
KdbPublisher(KdbProcess server, org.joda.time.Duration resetConnectionDuration) Generates a new KDB publisher.

Method Summary

Modifier and Type	Method and Description
Boolean	publish(KdbTable table) Allows a table (as an internal KdbTable to be published to the target KDB process
List<Boolean>	publish(List<KdbTable> tables) Allows a list of tables to be published (in sequence) to the target KDB process
Boolean	publish(String tableName, c.Flip tableData) Performs the publish of a c.Flip table structure to the target KDB process

Methods inherited from class com.buabook.kdb.connection.KdbConnection

close, connect, disconnect, getConnection, getRemoteProcess, isConnected, reconnect

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_RESET_CONNECTION_DURATION

private static final org.joda.time.Duration DEFAULT_RESET_CONNECTION_DURATION

See Also:

resetConnectionDuration

PUBLISH_FUNCTION

private static final String PUBLISH_FUNCTION

See Also:

Constant Field Values

resetConnectionDuration

private final org.joda.time.Duration resetConnectionDuration

The maximum amount of time after the last publish / connect allowed before the connection to the kdb process is reset. This is due to socket timeout on the target machine that may not be noticed by the local Java process.

On Linux boxes, /proc/sys/net/ipv4/tcp_keepalive_time will tell you how long a socket can stay open.

lastPublishTime

private org.joda.time.DateTime lastPublishTime

The time of the last successful publish to the kdb process

Constructor Detail

KdbPublisher

public KdbPublisher(KdbProcess server)
             throws KdbTargetProcessUnavailableException

Throws:

KdbTargetProcessUnavailableException

See Also:

KdbPublisher(KdbProcess, Duration)

KdbPublisher

public KdbPublisher(KdbProcess server,
                    org.joda.time.Duration resetConnectionDuration)
             throws KdbTargetProcessUnavailableException

Generates a new KDB publisher. NOTE: The process must be online and available to connect to when this constructor is called; reconnection is not supported here.

Parameters:

server - The server to connect to

resetConnectionDuration - The maximum time allowed between publishes before the connection is reset. If this is null, DEFAULT_RESET_CONNECTION_DURATION will be used

Throws:

KdbTargetProcessUnavailableException - If the target KDB process is unavailable

See Also:

KdbConnection.connect(), resetConnectionDuration

Method Detail

publish

public List<Boolean> publish(List<KdbTable> tables)

Allows a list of tables to be published (in sequence) to the target KDB process

Parameters:

tables - The list of tables to publish

Returns:

The publish status for each table in the list

See Also:

publish(KdbTable)

publish

public Boolean publish(KdbTable table)

Allows a table (as an internal KdbTable to be published to the target KDB process

Parameters:

table - The table to publish

Returns:

true if the publish was successful, false otherwise

See Also:

#publish(String, Flip)

publish

public Boolean publish(String tableName,
                       c.Flip tableData)

Performs the publish of a c.Flip table structure to the target KDB process

Parameters:

tableName - The name of the table to publish

tableData - The table contents

Returns:

true if the publish was successful, false otherwise. NOTE: The function will also return true if either parameter is null