bayou.tcp

Class TcpClient

java.lang.Object

bayou.tcp.TcpClient

All Implemented Interfaces:

AutoCloseable

public class TcpClient
extends Object
implements AutoCloseable

Non-blocking TCP client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpClient.Conf Configuration for TcpClient

Constructor Summary

Constructors

Constructor and Description
TcpClient(TcpClient.Conf conf) Create a TcpClient.

Method Summary

Instance Methods
Async<TcpChannel>	connect(String peerHost, InetAddress ip, int port) Connect to a remote server.
int	getConnectionCount() Get the number of established connections.
void	close() Close the client and free resources.
Executor	getExecutor() Get the executor associated with the selector thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpClient

public TcpClient(TcpClient.Conf conf)
          throws Exception

Create a TcpClient.

Throws:

Exception

Method Detail

connect

public Async<TcpChannel> connect(String peerHost,
                                 InetAddress ip,
                                 int port)

Connect to a remote server.

This action succeeds when a TcpChannel is established and ready to read/write.

The default timeout is probably too long; the caller should set a reasonable timeout by

     client.connect(peerHost, ip, port).timeout(duration)
 

The `peerHost` argument will become the TcpChannel's peerHost; it can be null.

getConnectionCount

public int getConnectionCount()

Get the number of established connections.

close

public void close()

Close the client and free resources.

All existing connections will be forcefully closed.

Specified by:

close in interface AutoCloseable

getExecutor

public Executor getExecutor()

Get the executor associated with the selector thread.

Tasks submitted to the executor will be executed on the selector thread, and executed sequentially in the order they are submitted.