Class TcpConnection

java.lang.Object

org.jgroups.blocks.cs.Connection

org.jgroups.blocks.cs.TcpConnection

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

TcpConnectionNonBlocking

public class TcpConnection
extends Connection

Blocking IO (BIO) connection. Starts 1 reader thread for the peer socket and blocks until data is available. Calls BaseServer.receive(Address,byte[],int,int) when data has been received.

Since:

3.6.5

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	TcpConnection.Receiver

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	connected
protected DataInputStream	in
protected final byte[]	length_buf
protected DataOutputStream	out
protected TcpConnection.Receiver	receiver
protected final Socket	sock
protected boolean	use_lock_to_send
protected final AtomicInteger	writers

Fields inherited from class Connection

closed_gracefully, cookie, GRACEFUL_CLOSE, last_access, peer_addr, send_lock, server

Constructor Summary

Constructors

Constructor	Description
TcpConnection(Socket s, TcpServer server)	Called by TcpServer.Acceptor.handleAccept(Socket)
TcpConnection(Address peer_addr, TcpBaseServer server)	Creates a connection to a remote peer, use connect(Address) to connect

Method Summary

Modifier and Type	Method	Description
void	close()
void	close(boolean graceful)
protected void	closeGracefully()
void	connect(Address dest)
protected void	connect(Address dest, boolean send_local_addr)
protected DataInputStream	createDataInputStream(InputStream in)
protected DataOutputStream	createDataOutputStream(OutputStream out)
protected void	doClose()
protected void	doSend(byte[] data, int offset, int length, boolean flush)
void	flush()
protected String	getSockAddress()
protected void	handshake(SSLSocket ssl, Address dest, long timeout)	Performs the TLS handshake, bounded by timeout ms, which is what is left of sock_conn_timeout after the TCP connect, so that the connection setup as a whole is bounded by it.
boolean	isClosed()
boolean	isConnected()
boolean	isConnectionPending()
Address	localAddress()
void	locklessSend(byte[] data, int offset, int length)
protected Address	readPeerAddress(Socket client_sock)	Reads the peer's address.
void	send(byte[] data, int offset, int length)
void	send(ByteBuffer buf)
void	send(ByteBuffer[] bufs)
protected void	sendLocalAddress(Address local_addr)	Send the cookie first, then our port number.
protected void	setSocketParameters(Socket client_sock)
void	start()
String	status()
String	toString()
boolean	useLockToSend()
<T extends Connection> T	useLockToSend(boolean u)

Methods inherited from class Connection

getTimestamp, isClosedGracefully, isExpired, peerAddress, setClosedGracefully, updateLastAccessed

Methods inherited from class Object

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

Field Details

sock

protected final Socket sock

out

protected DataOutputStream out

in

protected DataInputStream in

receiver

protected volatile TcpConnection.Receiver receiver

writers

protected final AtomicInteger writers

connected

protected volatile boolean connected

length_buf

protected final byte[] length_buf

use_lock_to_send

protected boolean use_lock_to_send

Constructor Details

TcpConnection

public TcpConnection(Address peer_addr,
 TcpBaseServer server)
              throws Exception

Creates a connection to a remote peer, use connect(Address) to connect

Throws:

Exception

TcpConnection

public TcpConnection(Socket s,
 TcpServer server)
              throws Exception

Called by TcpServer.Acceptor.handleAccept(Socket)

Throws:

Exception

Method Details

useLockToSend

public boolean useLockToSend()

useLockToSend

public <T extends Connection> T useLockToSend(boolean u)

localAddress

public Address localAddress()

Specified by:

localAddress in class Connection

getSockAddress

protected String getSockAddress()

connect

public void connect(Address dest)
             throws Exception

Specified by:

connect in class Connection

Throws:

Exception

connect

protected void connect(Address dest,
 boolean send_local_addr)
                throws Exception

Throws:

Exception

handshake

protected void handshake(SSLSocket ssl,
 Address dest,
 long timeout)
                  throws IOException

Performs the TLS handshake, bounded by timeout ms, which is what is left of sock_conn_timeout after the TCP connect, so that the connection setup as a whole is bounded by it. If the server has a timer, the handshake as a whole is bounded: a watchdog closes the socket when the deadline expires, which makes the blocked handshake fail. Without a timer, SO_TIMEOUT is used, which only bounds each single read of the handshake.

Throws:

IOException

start

public void start()

Specified by:

start in class Connection

send

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

Specified by:

send in class Connection

Throws:

Exception

send

public void send(ByteBuffer buf)
          throws Exception

Specified by:

send in class Connection

Throws:

Exception

send

public void send(ByteBuffer[] bufs)
          throws Exception

Specified by:

send in class Connection

Throws:

Exception

locklessSend

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

Throws:

Exception

doSend

protected void doSend(byte[] data,
 int offset,
 int length,
 boolean flush)
               throws Exception

Throws:

Exception

flush

public void flush()

Specified by:

flush in class Connection

createDataOutputStream

protected DataOutputStream createDataOutputStream(OutputStream out)

createDataInputStream

protected DataInputStream createDataInputStream(InputStream in)

setSocketParameters

protected void setSocketParameters(Socket client_sock)
                            throws SocketException

Throws:

SocketException

sendLocalAddress

protected void sendLocalAddress(Address local_addr)
                         throws Exception

Send the cookie first, then our port number. If the cookie doesn't match the receiver's cookie, the receiver will reject the connection and close it.

Throws:

Exception

readPeerAddress

protected Address readPeerAddress(Socket client_sock)
                           throws Exception

Reads the peer's address. First a cookie has to be sent which has to match my own cookie, otherwise the connection will be refused

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

status

public String status()

Specified by:

status in class Connection

isConnected

public boolean isConnected()

Specified by:

isConnected in class Connection

isConnectionPending

public boolean isConnectionPending()

Specified by:

isConnectionPending in class Connection

isClosed

public boolean isClosed()

Specified by:

isClosed in class Connection

close

public void close()
           throws IOException

Throws:

IOException

close

public void close(boolean graceful)
           throws IOException

Specified by:

close in class Connection

Throws:

IOException

closeGracefully

protected void closeGracefully()

doClose

protected void doClose()