org.jgroups.blocks

Class TcpConnection

java.lang.Object

org.jgroups.blocks.TcpConnection

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Connection<Address>

public class TcpConnection
extends java.lang.Object
implements Connection<Address>

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

Since:

3.6.5

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TcpConnection.Receiver
protected class	TcpConnection.Sender

Field Summary

Fields

Modifier and Type	Field and Description
protected static byte[]	cookie
protected java.io.DataInputStream	in
protected long	last_access
protected java.io.DataOutputStream	out
protected Address	peer_addr
protected TcpConnection.Receiver	receiver
protected java.util.concurrent.locks.ReentrantLock	send_lock
protected TcpConnection.Sender	sender
protected TcpServer	server
protected java.net.Socket	sock

Constructor Summary

Constructors

Constructor and Description
TcpConnection(Address peer_addr, TcpServer server) Creates a connection stub and binds it, use connect(Address) to connect
TcpConnection(java.net.Socket s, TcpServer server)

Method Summary

Modifier and Type	Method and Description
protected void	_send(byte[] data, int offset, int length, boolean acquire_lock, boolean flush) Sends data using the 'out' output stream of the socket
void	close()
void	connect(Address dest) Called after TcpConnection#TcpConnection(Address, SocketFactory)
protected void	doSend(byte[] data, int offset, int length, boolean acquire_lock, boolean flush)
protected void	flush()
protected Address	getPeerAddress()
protected java.lang.String	getSockAddress()
protected long	getTimestamp()
boolean	isConnected()
boolean	isExpired(long now)
boolean	isOpen()
protected boolean	isSenderUsed()
protected boolean	matchCookie(byte[] input)
protected Address	readPeerAddress(java.net.Socket client_sock) Reads the peer's address.
void	send(byte[] data, int offset, int length)
void	send(java.nio.ByteBuffer buf)
protected void	sendLocalAddress(Address local_addr) Send the cookie first, then the our port number.
protected void	setSocketParameters(java.net.Socket client_sock)
void	start()
java.lang.String	toString()
protected void	updateLastAccessed()

Methods inherited from class java.lang.Object

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

Field Detail

sock

protected final java.net.Socket sock

send_lock

protected final java.util.concurrent.locks.ReentrantLock send_lock

cookie

protected static final byte[] cookie

out

protected java.io.DataOutputStream out

in

protected java.io.DataInputStream in

peer_addr

protected Address peer_addr

last_access

protected long last_access

sender

protected volatile TcpConnection.Sender sender

receiver

protected volatile TcpConnection.Receiver receiver

server

protected final TcpServer server

Constructor Detail

TcpConnection

public TcpConnection(Address peer_addr,
                     TcpServer server)
              throws java.lang.Exception

Creates a connection stub and binds it, use connect(Address) to connect

Throws:

java.lang.Exception

TcpConnection

public TcpConnection(java.net.Socket s,
                     TcpServer server)
              throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getTimestamp

protected long getTimestamp()

getPeerAddress

protected Address getPeerAddress()

isSenderUsed

protected boolean isSenderUsed()

getSockAddress

protected java.lang.String getSockAddress()

updateLastAccessed

protected void updateLastAccessed()

connect

public void connect(Address dest)
             throws java.lang.Exception

Called after TcpConnection#TcpConnection(Address, SocketFactory)

Specified by:

connect in interface Connection<Address>

Throws:

java.lang.Exception

start

public void start()

Specified by:

start in interface Connection<Address>

send

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

Specified by:

send in interface Connection<Address>

Parameters:

data - Guaranteed to be non null

offset -

length -

Throws:

java.lang.Exception

send

public void send(java.nio.ByteBuffer buf)
          throws java.lang.Exception

Specified by:

send in interface Connection<Address>

Throws:

java.lang.Exception

_send

protected void _send(byte[] data,
                     int offset,
                     int length,
                     boolean acquire_lock,
                     boolean flush)
              throws java.lang.Exception

Sends data using the 'out' output stream of the socket

Parameters:

data -

offset -

length -

acquire_lock -

Throws:

java.lang.Exception

doSend

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

Throws:

java.lang.Exception

flush

protected void flush()
              throws java.lang.Exception

Throws:

java.lang.Exception

setSocketParameters

protected void setSocketParameters(java.net.Socket client_sock)
                            throws java.net.SocketException

Throws:

java.net.SocketException

readPeerAddress

protected Address readPeerAddress(java.net.Socket client_sock)
                           throws java.lang.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:

java.lang.Exception

sendLocalAddress

protected void sendLocalAddress(Address local_addr)
                         throws java.lang.Exception

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

Throws:

java.lang.Exception

matchCookie

protected boolean matchCookie(byte[] input)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isExpired

public boolean isExpired(long now)

Specified by:

isExpired in interface Connection<Address>

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Connection<Address>

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Connection<Address>

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException