Package com.illumon.iris.db.v2.locations.remote

Class RemoteTableDataService

java.lang.Object

com.illumon.iris.db.v2.tabledataservice.AbstractTableDataService

com.illumon.iris.db.v2.locations.remote.RemoteTableDataService

All Implemented Interfaces:

TableDataService, NamedImplementation

public class RemoteTableDataService
extends AbstractTableDataService

Remote TableDataService implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteTableDataService.ConnectInfo	ConnectInfo is a class that holds the information required to connect to a remote server.
class	RemoteTableDataService.TableLocationProviderImpl	TableLocationProvider implementation that delegates to appropriate Requests.

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.tabledataservice.TableDataService

TableDataService.Null

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	allowIOMessageFlush
protected final String	logPrefix
protected final long	requestTimeoutMillis
protected final boolean	supportsSubscriptions

Constructor Summary

Constructors

Constructor	Description
RemoteTableDataService(io.deephaven.enterprise.niowrapper.sched.Scheduler scheduler, com.fishlib.io.logger.Logger log, String name, long requestTimeoutMillis, boolean supportsSubscriptions, boolean allowIOMessageFlush)	Deprecated. Use RemoteTableDataService(Scheduler, Logger, String, long, boolean, boolean, ConnectInfo) instead, with new ConnectInfo.NULL() as the last argument if necessary.
RemoteTableDataService(io.deephaven.enterprise.niowrapper.sched.Scheduler scheduler, com.fishlib.io.logger.Logger log, String name, long requestTimeoutMillis, boolean supportsSubscriptions, boolean allowIOMessageFlush, RemoteTableDataService.ConnectInfo connectInfo)	Construct a new remote table data service, ready to be connected.

Method Summary

Modifier and Type	Method	Description
void	authenticate()	Authenticate the TableDataService using AuthenticationClientManager.getDefault()
RemoteTableDataService	connect(com.fishlib.base.Function.Nullary<SocketAddress> addressFunction)	Connect to a remote server by address function, allowing fallback to different server addresses.
RemoteTableDataService	connect(String host, int port)	Connect to a remote server.
RemoteTableDataService	connect(InetSocketAddress address)	Connect to a remote server.
String	describe()	Like toString, but with more detail.
boolean	equals(Object o)
TableDataServiceKey	getKey()	Return a key object that identifies this TableDataService instance, and does not hold resources.
int	hashCode()
protected TableLocationProvider	makeTableLocationProvider(TableKey tableKey)
void	shutdown()	Stop any processes and release resources held by this TableDataService instance.
String	toString()

Methods inherited from class com.illumon.iris.db.v2.tabledataservice.AbstractTableDataService

getKnownLocationProviders, getName, getTableLocationProvider, reset, reset

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.illumon.util.type.NamedImplementation

getImplementationName

Methods inherited from interface com.illumon.iris.db.v2.tabledataservice.TableDataService

getTableLocationProvider

Field Details

logPrefix

protected final String logPrefix

requestTimeoutMillis

protected final long requestTimeoutMillis

supportsSubscriptions

protected final boolean supportsSubscriptions

allowIOMessageFlush

protected final boolean allowIOMessageFlush

Constructor Details

RemoteTableDataService

public RemoteTableDataService(@NotNull
 io.deephaven.enterprise.niowrapper.sched.Scheduler scheduler,
 @NotNull
 com.fishlib.io.logger.Logger log,
 @NotNull
 String name,
 long requestTimeoutMillis,
 boolean supportsSubscriptions,
 boolean allowIOMessageFlush,
 @NotNull
 RemoteTableDataService.ConnectInfo connectInfo)

Construct a new remote table data service, ready to be connected.

Parameters:

scheduler - Job scheduler

log - Logger for output

name - Remote service name

requestTimeoutMillis - The timeout value to use for all requests

supportsSubscriptions - Whether the service underlying the TableDataServiceExporter we connect to supports subscriptions

allowIOMessageFlush - allow synchronous flush of message buffers

connectInfo - the information that will be used to connect to the remote server

RemoteTableDataService

@Deprecated
public RemoteTableDataService(@NotNull
 io.deephaven.enterprise.niowrapper.sched.Scheduler scheduler,
 @NotNull
 com.fishlib.io.logger.Logger log,
 @NotNull
 String name,
 long requestTimeoutMillis,
 boolean supportsSubscriptions,
 boolean allowIOMessageFlush)

Deprecated.

Use RemoteTableDataService(Scheduler, Logger, String, long, boolean, boolean, ConnectInfo) instead, with new ConnectInfo.NULL() as the last argument if necessary.
Construct a new remote table data service, ready to be connected. This constructor does not include ConnectInfo, so cannot be used where the TableDataService is tracked.

Parameters:

scheduler - Job scheduler

log - Logger for output

name - Remote service name

requestTimeoutMillis - The timeout value to use for all requests

supportsSubscriptions - Whether the service underlying the TableDataServiceExporter we connect to supports subscriptions

allowIOMessageFlush - allow synchronous flush of message buffers

Method Details

getKey

@NotNull
public TableDataServiceKey getKey()

Description copied from interface: TableDataService

Return a key object that identifies this TableDataService instance, and does not hold resources.

Specified by:

getKey in interface TableDataService

Overrides:

getKey in class AbstractTableDataService

Returns:

a TableDataServiceKey for this TableDataService

authenticate

public void authenticate()

Description copied from interface: TableDataService

Authenticate the TableDataService using AuthenticationClientManager.getDefault()

connect

public RemoteTableDataService connect(@NotNull
 InetSocketAddress address)
                               throws IOException

Connect to a remote server.

Parameters:

address - The host/port to connect to

Returns:

this

Throws:

IOException

connect

public RemoteTableDataService connect(@NotNull
 String host,
 int port)
                               throws IOException

Connect to a remote server.

Parameters:

host - The host to connect to

port - The port to connect to

Returns:

this

Throws:

IOException

connect

public RemoteTableDataService connect(@NotNull
 com.fishlib.base.Function.Nullary<SocketAddress> addressFunction)
                               throws IOException

Connect to a remote server by address function, allowing fallback to different server addresses.

Parameters:

addressFunction - The address function to determine each connection attempt's host and port

Returns:

this

Throws:

IOException

shutdown

public void shutdown()

Description copied from interface: TableDataService

Stop any processes and release resources held by this TableDataService instance.

makeTableLocationProvider

@NotNull
protected TableLocationProvider makeTableLocationProvider(@NotNull
 TableKey tableKey)

Specified by:

makeTableLocationProvider in class AbstractTableDataService

toString

public String toString()

Overrides:

toString in class AbstractTableDataService

describe

public String describe()

Description copied from interface: TableDataService

Like toString, but with more detail.

Returns:

a description string

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object