Class TcpClient

java.lang.Object

org.jgroups.blocks.cs.BaseServer

org.jgroups.blocks.cs.TcpBaseServer

org.jgroups.blocks.cs.TcpClient

All Implemented Interfaces:

Closeable, AutoCloseable, Client, ConnectionListener

public class TcpClient
extends TcpBaseServer
implements Client, ConnectionListener

Client for servers based on TCP

Since:

3.6.5

Author:

Bela Ban

Nested Class Summary

Nested classes/interfaces inherited from class BaseServer

BaseServer.Reaper

Field Summary

Fields

Modifier and Type	Field	Description
protected TcpConnection	conn
protected Address	remote_addr

Fields inherited from class TcpBaseServer

buffered_inputstream_size, buffered_outputstream_size, max_send_queue, non_blocking_sends, peer_addr_read_timeout, use_lock_to_send

Fields inherited from class BaseServer

client_bind_addr, client_bind_port, conn_expire_time, conn_listeners, conns, defer_client_binding, factory, linger, local_addr, locks, log, log_details, max_length, reaper, reaperInterval, receiver, recv_buf_size, running, send_buf_size, sock_conn_timeout, socket_factory, tcp_nodelay, time_service, timer, use_peer_connections

Constructor Summary

Constructors

Constructor	Description
TcpClient(InetAddress bind_addr, int bind_port, InetAddress server_addr, int server_port)	Creates an instance of an TcpClient that acts as a client: no server socket is created and no acceptor is started to listen for incoming connections.
TcpClient(InetAddress bind_addr, int bind_port, InetAddress server_addr, int server_port, boolean vthreads)
TcpClient(IpAddress bind_addr, IpAddress server_addr)	Creates an instance of an TcpClient that acts as a client: no server socket is created and no acceptor is started to listen for incoming connections.

Method Summary

Modifier and Type	Method	Description
void	close(boolean graceful)
void	connectionClosed(Connection conn)
protected void	doStart()
protected void	doStop(boolean graceful)
boolean	isConnected()
Address	remoteAddress()
TcpClient	remoteAddress(IpAddress addr)	Sets the address of the server.
void	send(byte[] data, int offset, int length)	Sends data to the remote server.
void	send(ByteBuffer buf)	Sends data to the remote server.
void	send(ByteBuffer[] bufs)	Sends data to the remote server.
void	send(Address dest, byte[] data, int offset, int length)
void	send(Address dest, ByteBuffer buf)
void	start()
void	stop()	Stops listening for connections and handling traffic.
String	toString()

Methods inherited from class TcpBaseServer

createConnection, getBufferedInputStreamSize, getBufferedOutputStreamSize, maxSendQueue, maxSendQueue, nonBlockingSends, nonBlockingSends, peerAddressReadTimeout, peerAddressReadTimeout, setBufferedInputStreamSize, setBufferedOutputStreamSize, useLockToSend, useLockToSend

Methods inherited from class BaseServer

addConnectionListener, clearConnections, clearConnections, clientBindAddress, clientBindAddress, clientBindPort, clientBindPort, close, closeConnection, closeConnection, closeConnection, closeConnection, connected, connectionEstablished, connectionEstablishedTo, connExpireTime, connExpireTimeout, deferClientBinding, deferClientBinding, explanation, flush, flushAll, forAllConnections, getConnection, getLock, getMaxLength, getNumConnections, getNumOpenConnections, handleIncomingConnection, handleOutgoingConnection, hasConnection, linger, linger, localAddress, localAddress, log, log, logDetails, logDetails, notifyConnectionClosed, notifyConnectionEstablished, printConnections, reaperInterval, reaperInterval, receive, receive, receive, receiveBufferSize, receiveBufferSize, receiver, receiver, removeConnectionIfPresent, removeConnectionListener, replaceConnection, retainAll, retainAll, running, sendBufferSize, sendBufferSize, sendToAll, sendToAll, setMaxLength, socketConnectionTimeout, socketConnectionTimeout, socketFactory, socketFactory, tcpNodelay, tcpNodelay, timer, timer, timeService, timeService, toString, useAcks, useAcks, usePeerConnections, usePeerConnections, validateArgs

Methods inherited from class Object

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

Methods inherited from interface Client

localAddress

Methods inherited from interface ConnectionListener

connectionEstablished

Field Details

remote_addr

protected Address remote_addr

conn

protected TcpConnection conn

Constructor Details

TcpClient

public TcpClient(IpAddress bind_addr,
 IpAddress server_addr)

Creates an instance of an TcpClient that acts as a client: no server socket is created and no acceptor is started to listen for incoming connections. Instead, a client socket is created (bound to bind_addr/bind_port) and connected to server_addr/server_port. This is used to send messages to the remote server and receive messages from it. Note that there is only a single TCP connection established between the client and server.

Parameters:

bind_addr - The address to which the local socket should bind to. Can be null, then the OS picks the address

server_addr - The address of the server to connect to

TcpClient

public TcpClient(InetAddress bind_addr,
 int bind_port,
 InetAddress server_addr,
 int server_port)

Creates an instance of an TcpClient that acts as a client: no server socket is created and no acceptor is started to listen for incoming connections. Instead, a client socket is created (bound to bind_addr/bind_port) and connected to server_addr/server_port. This is used to send messages to the remote server and receive messages from it. Note that there is only a single TCP connection established between the client and server.

Parameters:

bind_addr - The address to which the local socket should bind to. Can be null, then the OS picks the address

bind_port - The local port. Can be 0, then the OS picks the port.

server_addr - The address of the server to connect to

server_port - The port of the server to connect to.

TcpClient

public TcpClient(InetAddress bind_addr,
 int bind_port,
 InetAddress server_addr,
 int server_port,
 boolean vthreads)

Method Details

remoteAddress

public Address remoteAddress()

Specified by:

remoteAddress in interface Client

remoteAddress

public TcpClient remoteAddress(IpAddress addr)

Sets the address of the server. Has no effect when already connected.

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Client

start

public void start()
           throws Exception

Overrides:

start in class BaseServer

Throws:

Exception

stop

public void stop()

Description copied from class: BaseServer

Stops listening for connections and handling traffic. Typically, socket handler or selector threads are stopped, and server sockets or channels are closed.

Overrides:

stop in class BaseServer

close

public void close(boolean graceful)
           throws IOException

Throws:

IOException

send

public void send(Address dest,
 byte[] data,
 int offset,
 int length)
          throws Exception

Overrides:

send in class BaseServer

Throws:

Exception

send

public void send(Address dest,
 ByteBuffer buf)
          throws Exception

Overrides:

send in class BaseServer

Throws:

Exception

send

public void send(byte[] data,
 int offset,
 int length)
          throws Exception

Description copied from interface: Client

Sends data to the remote server. The server's address must have been set before.

Specified by:

send in interface Client

Throws:

Exception

send

public void send(ByteBuffer buf)
          throws Exception

Description copied from interface: Client

Sends data to the remote server. The server's address must have been set before.

Specified by:

send in interface Client

Throws:

Exception

send

public void send(ByteBuffer[] bufs)
          throws Exception

Description copied from interface: Client

Sends data to the remote server. The server's address must have been set before.

Specified by:

send in interface Client

Throws:

Exception

connectionClosed

public void connectionClosed(Connection conn)

Specified by:

connectionClosed in interface ConnectionListener

Overrides:

connectionClosed in class BaseServer

toString

public String toString()

Overrides:

toString in class BaseServer

doStart

protected void doStart()
                throws Exception

Throws:

Exception

doStop

protected void doStop(boolean graceful)