org.jppf.comm.socket
Class BootstrapSocketClient

java.lang.Object
  extended by org.jppf.comm.socket.AbstractSocketWrapper
      extended by org.jppf.comm.socket.BootstrapSocketClient
All Implemented Interfaces:
SocketWrapper

public class BootstrapSocketClient
extends AbstractSocketWrapper

This class provides a simple API to transfer objects over a TCP socket connection.

Author:
Laurent Cohen

Field Summary
 
Fields inherited from class org.jppf.comm.socket.AbstractSocketWrapper
dis, dos, host, opened, port, serializer, socket
 
Fields inherited from interface org.jppf.comm.socket.SocketWrapper
SOCKET_RECEIVE_BUFFER_SIZE
 
Constructor Summary
BootstrapSocketClient()
          Default constructor is invisible to other classes.
BootstrapSocketClient(Socket socket)
          Initialize this socket client with an already opened and connected socket.
BootstrapSocketClient(String host, int port)
          Initialize this socket client and connect it to the specified host on the specified port.
 
Method Summary
 ObjectSerializer getSerializer()
          Get the object serializer for this socket connection.
 Object receive(int timeout)
          Read an object from a TCP socket connection.
 void send(Object o)
          Send an object over a TCP socket connection.
 
Methods inherited from class org.jppf.comm.socket.AbstractSocketWrapper
checkOpened, close, flush, getHost, getPort, getSocket, getSocketTimestamp, initStreams, isOpened, open, read, readInt, receive, receiveBytes, sendBytes, setHost, setPort, setSerializer, setSocket, skip, updateSocketTimestamp, write, writeInt
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BootstrapSocketClient

public BootstrapSocketClient()
Default constructor is invisible to other classes. See BootstrapSocketClient(String, int)


BootstrapSocketClient

public BootstrapSocketClient(String host,
                             int port)
                      throws ConnectException,
                             IOException
Initialize this socket client and connect it to the specified host on the specified port.

Parameters:
host - the remote host this socket client connects to.
port - the remote port on the host this socket client connects to.
Throws:
ConnectException - if the connection fails.
IOException - if there is an issue with the socket streams.

BootstrapSocketClient

public BootstrapSocketClient(Socket socket)
                      throws JPPFException
Initialize this socket client with an already opened and connected socket.

Parameters:
socket - the underlying socket this socket client wraps around.
Throws:
JPPFException - if the socket connection fails.
Method Detail

send

public void send(Object o)
          throws Exception
Send an object over a TCP socket connection.

Parameters:
o - the object to send.
Throws:
Exception - if the underlying output stream throws an exception.

receive

public Object receive(int timeout)
               throws Exception
Read an object from a TCP socket connection. This method blocks until an object is received or the specified timeout has expired, whichever happens first.

Parameters:
timeout - timeout after which the operation is aborted. A timeout of zero is interpreted as an infinite timeout.
Returns:
the object that was read from the underlying input stream or null if the operation timed out.
Throws:
Exception - if the underlying input stream throws an exception.

getSerializer

public ObjectSerializer getSerializer()
Get the object serializer for this socket connection.

Specified by:
getSerializer in interface SocketWrapper
Overrides:
getSerializer in class AbstractSocketWrapper
Returns:
an instance of ObjectSerializer.
See Also:
AbstractSocketWrapper.getSerializer()


Copyright © 2005-2010 JPPF Team.