com.viaoa.comm.multiplexer.io

Class VirtualSocket

java.lang.Object

java.net.Socket

com.viaoa.comm.multiplexer.io.VirtualSocket

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class VirtualSocket
extends Socket

A "virtual" socket connection to an MultiplexerServerSocket through a multiplexed connection. A MultiplexerSocket is created and managed by MultiplexerSocketController, so that the input and output streams are able to share the real socket.

Author:

vvia

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_connectionId Real socket connection id (assigned on server)
protected int	_id unique identifer (assigned by MultiplexerSocketController)
protected Object	_lockObject Lock used when waiting to perform a read on the real socket.
protected String	_serverSocketName Name of server socket.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VirtualSocket(int connectionId, int id, String serverSocketName) Called by MultiplexerSocketController when creating a new socket or receiving a command to create a new virtual socket.

Method Summary

Modifier and Type	Method and Description
abstract void	close(boolean bSendCommand)
protected void	createInputStream() Implement an inputStream that will use/share/multiplex the "real" socket.
protected void	createOutputStream() Implement an outputStream that will use/share/multiplex the "real" socket.
int	getConnectionId() The ID that is assigned on the server to the real socket connection.
int	getId() The ID that is assigned by MultiplexerSocketController.
InputStream	getInputStream()
OutputStream	getOutputStream()
String	getServerSocketName()
int	getTimeoutSeconds()
abstract int	read()
abstract int	read(byte[] bs, int off, int len) Used so that the real socket is used for the vsocket read.
void	setTimeoutSeconds(int x)
abstract void	write(byte[] bs, int off, int len) Used so that the real socket is used for the vsocket write.
abstract void	write(int b)

Methods inherited from class java.net.Socket

bind, close, connect, connect, getChannel, getInetAddress, getKeepAlive, getLocalAddress, getLocalPort, getLocalSocketAddress, getOOBInline, getPort, getReceiveBufferSize, getRemoteSocketAddress, getReuseAddress, getSendBufferSize, getSoLinger, getSoTimeout, getTcpNoDelay, getTrafficClass, isBound, isClosed, isConnected, isInputShutdown, isOutputShutdown, sendUrgentData, setKeepAlive, setOOBInline, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSocketImplFactory, setSoLinger, setSoTimeout, setTcpNoDelay, setTrafficClass, shutdownInput, shutdownOutput, toString

Methods inherited from class java.lang.Object

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

Field Detail

_connectionId

protected final int _connectionId

Real socket connection id (assigned on server)

_id

protected final int _id

unique identifer (assigned by MultiplexerSocketController)

_serverSocketName

protected String _serverSocketName

Name of server socket.

_lockObject

protected final Object _lockObject

Lock used when waiting to perform a read on the real socket.

Constructor Detail

VirtualSocket

protected VirtualSocket(int connectionId,
                        int id,
                        String serverSocketName)

Called by MultiplexerSocketController when creating a new socket or receiving a command to create a new virtual socket.

Parameters:

id - seq number assigned by MultiplexerSocketController.

Method Detail

createInputStream

protected void createInputStream()

Implement an inputStream that will use/share/multiplex the "real" socket.

getInputStream

public InputStream getInputStream()
                           throws IOException

Overrides:

getInputStream in class Socket

Throws:

IOException

createOutputStream

protected void createOutputStream()

Implement an outputStream that will use/share/multiplex the "real" socket.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Overrides:

getOutputStream in class Socket

Throws:

IOException

getConnectionId

public int getConnectionId()

The ID that is assigned on the server to the real socket connection.

getId

public int getId()

The ID that is assigned by MultiplexerSocketController. This is assigned during the constructor, and is a sequential number.

getServerSocketName

public String getServerSocketName()

read

public abstract int read(byte[] bs,
                         int off,
                         int len)
                  throws IOException

Used so that the real socket is used for the vsocket read. MultiplexerSocketController will implement these methods and then manage access to the "real" socket.

Throws:

IOException

read

public abstract int read()
                  throws IOException

Throws:

IOException

write

public abstract void write(byte[] bs,
                           int off,
                           int len)
                    throws IOException

Used so that the real socket is used for the vsocket write. MultiplexerSocketController will implement these methods and then manage access to the "real" socket.

Throws:

IOException

write

public abstract void write(int b)
                    throws IOException

Throws:

IOException

close

public abstract void close(boolean bSendCommand)
                    throws IOException

Throws:

IOException

setTimeoutSeconds

public void setTimeoutSeconds(int x)

getTimeoutSeconds

public int getTimeoutSeconds()