Package com.clickhouse.client

Class AbstractSocketClient

java.lang.Object

com.clickhouse.client.AbstractSocketClient

All Implemented Interfaces:

AutoCloseable

public class AbstractSocketClient
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_INVALID_INPUT_STREAM
static final String	ERROR_INVALID_OUTPUT_STREAM
static final String	ERROR_READ_TIMEOUT
static final String	ERROR_WRITE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractSocketClient()
AbstractSocketClient(ClickHouseConfig config)
AbstractSocketClient(ClickHouseNode server)

Method Summary

Modifier and Type	Method	Description
void	close()
CompletableFuture<Boolean>	connect(ClickHouseNode server)
CompletableFuture<Boolean>	connect(InetSocketAddress address)
static final ClickHouseSocketFactory	getCustomSocketFactory(String className, ClickHouseSocketFactory defaultFactory, Class<?> forClass)
protected SocketChannel	getSocketChannel()
boolean	isActive()
boolean	isShutdown()
InetSocketAddress	localAddress()
protected void	onConnect(ClickHouseConfig config, SocketChannel channel)
protected boolean	onRead(ClickHouseConfig config, SocketChannel sc, ClickHouseOutputStream out)	Reads byte from socket input buffer.
protected long	onWrite(ClickHouseConfig config, SocketChannel sc, ClickHouseInputStream in, long startPosition)
protected CompletableFuture<Boolean>	processRequest(ClickHouseConfig config, ClickHouseInputStream in, ClickHouseOutputStream out)
InetSocketAddress	remoteAddress()
protected final void	removeInterestOp(int op)
ClickHouseInputStream	send(ClickHouseConfig config, ClickHouseInputStream rawRequest)
void	send(ClickHouseConfig config, ClickHouseInputStream rawRequest, ClickHouseOutputStream responseStream)
protected final void	setInterestOp(int op)
static final Socket	setSocketOptions(ClickHouseConfig config, Socket socket)	Sets socket options.
static final SocketChannel	setSocketOptions(ClickHouseConfig config, SocketChannel socket)	Sets socket options.
protected boolean	start()

Methods inherited from class java.lang.Object

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

Field Details

ERROR_INVALID_INPUT_STREAM

public static final String ERROR_INVALID_INPUT_STREAM

See Also:

• Constant Field Values

ERROR_INVALID_OUTPUT_STREAM

public static final String ERROR_INVALID_OUTPUT_STREAM

See Also:

• Constant Field Values

ERROR_READ_TIMEOUT

public static final String ERROR_READ_TIMEOUT

See Also:

• Constant Field Values

ERROR_WRITE_TIMEOUT

public static final String ERROR_WRITE_TIMEOUT

See Also:

• Constant Field Values

Constructor Details

AbstractSocketClient

public AbstractSocketClient()
                     throws IOException

Throws:

IOException

AbstractSocketClient

public AbstractSocketClient(ClickHouseNode server)
                     throws IOException

Throws:

IOException

AbstractSocketClient

public AbstractSocketClient(ClickHouseConfig config)
                     throws IOException

Throws:

IOException

Method Details

getCustomSocketFactory

public static final ClickHouseSocketFactory getCustomSocketFactory(String className,
 ClickHouseSocketFactory defaultFactory,
 Class<?> forClass)

setSocketOptions

public static final Socket setSocketOptions(ClickHouseConfig config,
 Socket socket)
                                     throws SocketException

Sets socket options. May be called at any time(e.g. before or even after the socket is bound or connected).

Parameters:

config - non-null configuration

socket - non-null socket

Returns:

the given socket

Throws:

SocketException - when there's error setting socket options

setSocketOptions

public static final SocketChannel setSocketOptions(ClickHouseConfig config,
 SocketChannel socket)
                                            throws IOException

Sets socket options. May be called at any time(e.g. before or even after the socket is bound or connected).

Parameters:

config - non-null configuration

socket - non-null socket channel

Returns:

the given socket channel

Throws:

IOException - when there's error setting socket options

getSocketChannel

protected SocketChannel getSocketChannel()

processRequest

protected CompletableFuture<Boolean> processRequest(ClickHouseConfig config,
 ClickHouseInputStream in,
 ClickHouseOutputStream out)
                                             throws IOException

Throws:

IOException

setInterestOp

protected final void setInterestOp(int op)

removeInterestOp

protected final void removeInterestOp(int op)

onConnect

protected void onConnect(ClickHouseConfig config,
 SocketChannel channel)
                  throws IOException

Throws:

IOException

onRead

protected boolean onRead(ClickHouseConfig config,
 SocketChannel sc,
 ClickHouseOutputStream out)
                  throws IOException

Reads byte from socket input buffer.

Parameters:

config - non-null configuration

sc - socket channel

out - output stream

Returns:

true if the read was a success; false otherwise

Throws:

IOException

onWrite

protected long onWrite(ClickHouseConfig config,
 SocketChannel sc,
 ClickHouseInputStream in,
 long startPosition)
                throws IOException

Throws:

IOException

start

protected boolean start()
                 throws IOException

Throws:

IOException

connect

public CompletableFuture<Boolean> connect(ClickHouseNode server)
                                   throws IOException

Throws:

IOException

connect

public CompletableFuture<Boolean> connect(InetSocketAddress address)
                                   throws IOException

Throws:

IOException

isActive

public boolean isActive()

isShutdown

public boolean isShutdown()

localAddress

public InetSocketAddress localAddress()
                               throws IOException

Throws:

IOException

remoteAddress

public InetSocketAddress remoteAddress()
                                throws IOException

Throws:

IOException

send

public ClickHouseInputStream send(ClickHouseConfig config,
 ClickHouseInputStream rawRequest)
                           throws IOException

Throws:

IOException

send

public void send(ClickHouseConfig config,
 ClickHouseInputStream rawRequest,
 ClickHouseOutputStream responseStream)
          throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException