lib.easyjava.net.tcp

Class Connection<S extends java.io.Serializable,R extends java.io.Serializable>

java.lang.Object

lib.easyjava.net.tcp.Connection<S,R>

Type Parameters:

S - the type that will be sent through the socket

R - the type that will be received through the socket

public class Connection<S extends java.io.Serializable,R extends java.io.Serializable>
extends java.lang.Object

Manages socket connections to minimize common blocking/read/write issues.

Author:

Rob Rua (robrua@alumni.cmu.edu)

Constructor Summary

Constructors

Constructor and Description
Connection(java.net.Socket socket) A Connection created with this constructor will fail when an unexpected type is sent through the socket.
Connection(java.net.Socket socket, java.lang.Class<R> receivingClass) A Connection created with this constructor will ignore unexpected types sent through the socket.
Connection(java.lang.String host, int port) A Connection created with this constructor will fail when an unexpected type is sent through the socket.
Connection(java.lang.String host, int port, java.lang.Class<R> receivingClass) A Connection created with this constructor will ignore unexpected types sent through the socket.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection
boolean	isClosed() Checks to see if the connection is closed
R	receive() Receives a message from the connection.
R	receive(long timeout, java.util.concurrent.TimeUnit unit) Receives a message from the connection.
boolean	receiveWillBlock() Returns whether a call to receive() will block to wait on new data or not
boolean	send(S message) Sends a message over the connection
java.lang.String	toString()
void	waitForEvent() Blocks until some data is received on the connection or it is closed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Connection

public Connection(java.net.Socket socket)
           throws java.io.IOException

A Connection created with this constructor will fail when an unexpected type is sent through the socket.

Parameters:

socket - the socket this manager will control

Throws:

java.io.IOException - if the connection could not be made

Connection

public Connection(java.net.Socket socket,
                  java.lang.Class<R> receivingClass)
           throws java.io.IOException

A Connection created with this constructor will ignore unexpected types sent through the socket. This constructor is recommended for server-side connection management.

Parameters:

socket - the socket this manager will control

receivingClass - the class of object that will be received by this manager. Required to circumvent Java generics type erasure.

Throws:

java.io.IOException - if the connection could not be made

Connection

public Connection(java.lang.String host,
                  int port)
           throws java.io.IOException

A Connection created with this constructor will fail when an unexpected type is sent through the socket.

Parameters:

host - the host to connect to

port - the port to connect on

Throws:

java.io.IOException - if the connection could not be made

Connection

public Connection(java.lang.String host,
                  int port,
                  java.lang.Class<R> receivingClass)
           throws java.io.IOException

A Connection created with this constructor will ignore unexpected types sent through the socket.

Parameters:

host - the host to connect to

port - the port to connect on

receivingClass - the class of object that will be received by this manager. Required to circumvent Java generics type erasure.

Throws:

java.io.IOException - if the connection could not be made

Method Detail

close

public void close()

Closes the connection

isClosed

public boolean isClosed()

Checks to see if the connection is closed

Returns:

whether the connection is closed

receive

public R receive()
          throws java.lang.InterruptedException

Receives a message from the connection. Will block until something is sent through or the connection is closed.

Returns:

the message that was received or null if the connection was closed

Throws:

java.lang.InterruptedException - if the thread waiting was interrupted

receive

public R receive(long timeout,
                 java.util.concurrent.TimeUnit unit)
          throws java.lang.InterruptedException

Receives a message from the connection. Will block until something is sent through, the connection is closed, or the specified time has elapsed.

Parameters:

timeout - the amount of time before timeout

unit - the unit of time

Returns:

the message that was received, null if the listener was closed or receive timed out

Throws:

java.lang.InterruptedException - if the thread waiting was interrupted

receiveWillBlock

public boolean receiveWillBlock()

Returns whether a call to receive() will block to wait on new data or not

Returns:

false if there is existing data in the stream, true if receive() will wait for new data

send

public boolean send(S message)
             throws java.io.IOException

Sends a message over the connection

Parameters:

message - the message to send

Returns:

true, unless the connection was closed and the message was not sent.

Throws:

java.io.IOException - if the message could not be sent

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

waitForEvent

public void waitForEvent()
                  throws java.lang.InterruptedException

Blocks until some data is received on the connection or it is closed

Throws:

java.lang.InterruptedException - if the thread waiting was interrupted