Package io.deephaven.enterprise.comm.api

Interface CommServer

All Superinterfaces:

com.fishlib.base.log.LogOutputAppendable

All Known Implementing Classes:

AbstractCommServer, DelegatingCommServer, Server, WebSocketCommProxy, WSCommServer

public interface CommServer
extends com.fishlib.base.log.LogOutputAppendable

(description of class)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	IGNORE_CACHE_CLIENTS
static final int	ONLY_CACHE_CLIENTS
static final int	SEND_TO_ALL

Method Summary

Modifier and Type	Method	Description
void	addClientEntry(ClientEntry client)
void	addCommandHandler(String id, CommandHandler commandHandler)
void	disconnect()
List<ClientEntry>	getClientSet()
int	getPort()
void	handleCommand(ClientEntry client, com.fishlib.base.Command cmd)
void	removeCommandHandler(String id)
void	sendAsyncCommandWithResponse(ClientEntry client, String serviceId, com.fishlib.base.Command cmd, AsyncCommandHandler handler, long timeoutMillis, boolean allowFlush)
default void	sendCommand(ClientEntry clientEntry, String id, com.fishlib.base.Command command)
boolean	sendCommand(ClientEntry clientEntry, String id, com.fishlib.base.Command command, boolean allowFlush)
void	sendCommand(String id, com.fishlib.base.Command command)
void	sendCommand(String id, com.fishlib.base.Command command, int sendTo)
default com.fishlib.base.Command	sendCommandWithResponse(ClientEntry client, String serviceId, com.fishlib.base.Command command)
default com.fishlib.base.Command	sendCommandWithResponse(ClientEntry client, String serviceId, com.fishlib.base.Command command, AsyncCommandHandler handler)
com.fishlib.base.Command	sendCommandWithResponse(ClientEntry client, String serviceId, com.fishlib.base.Command command, AsyncCommandHandler handler, long timeoutMillis, boolean allowFlush)
void	TEST_SOCKET_CLOSE()	For unit tests: throw out all connected clients, but don't shut down the server sockets.

Methods inherited from interface com.fishlib.base.log.LogOutputAppendable

append

Field Details

SEND_TO_ALL

static final int SEND_TO_ALL

See Also:

• Constant Field Values

IGNORE_CACHE_CLIENTS

static final int IGNORE_CACHE_CLIENTS

See Also:

• Constant Field Values

ONLY_CACHE_CLIENTS

static final int ONLY_CACHE_CLIENTS

See Also:

• Constant Field Values

Method Details

getPort

int getPort()

sendCommand

void sendCommand(String id,
 com.fishlib.base.Command command)

sendCommand

void sendCommand(String id,
 com.fishlib.base.Command command,
 int sendTo)

sendCommand

boolean sendCommand(ClientEntry clientEntry,
 String id,
 com.fishlib.base.Command command,
 boolean allowFlush)

sendCommand

default void sendCommand(ClientEntry clientEntry,
 String id,
 com.fishlib.base.Command command)

sendAsyncCommandWithResponse

void sendAsyncCommandWithResponse(ClientEntry client,
 String serviceId,
 com.fishlib.base.Command cmd,
 AsyncCommandHandler handler,
 long timeoutMillis,
 boolean allowFlush)
                           throws IOException

Throws:

IOException

sendCommandWithResponse

com.fishlib.base.Command sendCommandWithResponse(ClientEntry client,
 String serviceId,
 com.fishlib.base.Command command,
 AsyncCommandHandler handler,
 long timeoutMillis,
 boolean allowFlush)
                                          throws IOException

Throws:

IOException

sendCommandWithResponse

default com.fishlib.base.Command sendCommandWithResponse(ClientEntry client,
 String serviceId,
 com.fishlib.base.Command command,
 AsyncCommandHandler handler)
                                                  throws IOException

Throws:

IOException

sendCommandWithResponse

default com.fishlib.base.Command sendCommandWithResponse(ClientEntry client,
 String serviceId,
 com.fishlib.base.Command command)
                                                  throws IOException

Throws:

IOException

getClientSet

List<ClientEntry> getClientSet()

addCommandHandler

void addCommandHandler(String id,
 CommandHandler commandHandler)

removeCommandHandler

void removeCommandHandler(String id)

disconnect

void disconnect()
         throws IOException

Throws:

IOException

handleCommand

void handleCommand(ClientEntry client,
 com.fishlib.base.Command cmd)

addClientEntry

void addClientEntry(ClientEntry client)

TEST_SOCKET_CLOSE

void TEST_SOCKET_CLOSE()
                throws IOException

For unit tests: throw out all connected clients, but don't shut down the server sockets.

Throws:

IOException