com.buabook.common.net

Class DataSocket

java.lang.Object

com.buabook.common.net.DataSocket

public class DataSocket
extends Object

Simple Socket Wrapper

This class is a simple Socket wrapper that exposes the native Socket.getInputStream() and Socket.getOutputStream() as a DataInputStream and DataOutputStream respectively.

This is useful when wanting to send data over a socket at a low-level (i.e. serialising / de-serialising Google Protobuf messages).

(c) 2014 - 2017 Sport Trades Ltd

Since:

14 Jul 2014

Version:

1.0.2

Author:

Jas Rajasansir

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	log
private DataInputStream	receiveStream
private InetSocketAddress	remoteSocketAddress
private DataOutputStream	sendStream
private Socket	socket The socket that is wrapped by this class.

Constructor Summary

Constructors

Constructor and Description
DataSocket(Socket socket) Instantiates the wrapper object based on an existing Socket

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnects the socket.
DataInputStream	getReceiveStream()
SocketAddress	getRemoteSocketAddress()
DataOutputStream	getSendStream()
private void	initialiseIOStreams()
Boolean	isClosed()
void	reconnect() This method will only attempt a reconnect on a disconnected socket (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.slf4j.Logger log

remoteSocketAddress

private final InetSocketAddress remoteSocketAddress

socket

private Socket socket

The socket that is wrapped by this class.

receiveStream

private DataInputStream receiveStream

See Also:

Socket.getInputStream()

sendStream

private DataOutputStream sendStream

See Also:

Socket.getOutputStream()

Constructor Detail

DataSocket

public DataSocket(Socket socket)
           throws DataSocketFailedToInitialiseException

Instantiates the wrapper object based on an existing Socket

Throws:

DataSocketFailedToInitialiseException - If the socket provided is null or if there is any error when attempting to create the DataInputStream or DataOutputStream.

See Also:

initialiseIOStreams()

Method Detail

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

See Also:

Socket.getRemoteSocketAddress()

getReceiveStream

public DataInputStream getReceiveStream()

See Also:

Socket.getInputStream(), DataInputStream

getSendStream

public DataOutputStream getSendStream()

See Also:

Socket.getOutputStream(), DataOutputStream

isClosed

public Boolean isClosed()

Returns:

true if the socket has been closed. This will only occur when the disconnect() method is called (which in turn should be called when an IOException occurs on one of the data streams). Unfortunately the state change of the socket isn't accurately reflected in the Socket object.

disconnect

public void disconnect()

Disconnects the socket. Any error that occurs during disconnect is suppressed.

reconnect

public void reconnect()
               throws DataSocketFailedToInitialiseException

This method will only attempt a reconnect on a disconnected socket (i.e. isClosed() returns true). The socket that is created has the following properties set:

• Socket.setKeepAlive(boolean) = true

Throws:

DataSocketFailedToInitialiseException - If the socket cannot be connected

See Also:

isClosed(), initialiseIOStreams()

initialiseIOStreams

private void initialiseIOStreams()
                          throws DataSocketFailedToInitialiseException

Throws:

DataSocketFailedToInitialiseException