MultiplexerSocketController (OA Java Code Documentation)

java.lang.Object
- com.viaoa.comm.multiplexer.io.MultiplexerSocketController

```
public class MultiplexerSocketController
extends Object
```
Manages the "real" socket connection and the multiplexed MultiplexerSockets that use it. There will be an MultiplexerSocketController at both ends of a real socket: client and server. This class will manage the transport layer, encryption, compression and validation.
Each client will have one SC on the client, and a matching SC on the server. A server will have a SC for each "real" client connection, all managed by MultiplexerServerSocketController.

Author:

vvia

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STATUS_DisconnectedByError`
`static int`	`STATUS_DisconnetedByClient`
`static int`	`STATUS_DisconnetedByServer`
`static int`	`STATUS_Running` Status of real connection.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`MultiplexerSocketController(Socket socket)` Used by client to create a new multiplexed socket.
`protected`	`MultiplexerSocketController(Socket socket, int id)` Created by MultiplexerServerSocketController for server-side connections.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` If the socket exists, then the other end of the socket will be notified to close, and then the socket will be closed.
`protected void`	`close(boolean bError)`
`protected void`	`closeSocket(VirtualSocket vs, boolean bSendCommand)`
`protected VirtualSocket`	`createSocket(int connectionId, int id, String serverSocketName)` Used to create a new "virtual" socket.
`VirtualSocket`	`createSocket(String serverSocketName)` Creates a vsocket on client to communicated with a remote handler on server.
`int`	`getId()`
`InetAddress`	`getInetAddress()`
`MultiplexerInputStreamController`	`getInputStreamController()`
`String`	`getInvalidConnectionMessage()`
`int`	`getLiveSocketCount()`
`VirtualSocket[]`	`getMultiplexerSockets()`
`MultiplexerOutputStreamController`	`getOutputStreamController()` Used to control the real outputstream.
`long`	`getStartTimeMS()`
`int`	`getStatus()`
`Thread`	`getThread()`
`boolean`	`isClosed()`
`boolean`	`isValid()` Flag to know if socket is a valid socket connection.
`protected void`	`onSocketException(Exception e)` Called when there is a read on the "real" socket.
`void`	`setInvalidConnectionMessage(String msg)` Message to display when a non-multiplexersocket connects.
`protected boolean`	`verifyServerSideHandshake()` This will verify that the client that is connected is a valid MultiplexerSocket.
`boolean`	`wasCloseAlreadyCalled()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STATUS_Running
```
public static final int STATUS_Running
```
    Status of real connection.
    
    See Also:
    
    Constant Field Values
  - STATUS_DisconnetedByClient
```
public static final int STATUS_DisconnetedByClient
```
    See Also:
    
    Constant Field Values
  - STATUS_DisconnetedByServer
```
public static final int STATUS_DisconnetedByServer
```
    See Also:
    
    Constant Field Values
  - STATUS_DisconnectedByError
```
public static final int STATUS_DisconnectedByError
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MultiplexerSocketController
```
public MultiplexerSocketController(Socket socket)
                            throws Exception
```
    Used by client to create a new multiplexed socket.
    
    Throws:
    
    Exception
  - MultiplexerSocketController
```
protected MultiplexerSocketController(Socket socket,
                                      int id)
```
    Created by MultiplexerServerSocketController for server-side connections. Note: needs to return as soon as possible, since this is executed on the serverSocket.accept() thread.
    
    Parameters:
    
    socket - real connection to server.
- Method Detail
  - verifyServerSideHandshake
```
protected boolean verifyServerSideHandshake()
                                     throws IOException
```
    This will verify that the client that is connected is a valid MultiplexerSocket. To be valid, the client will send a "signature" string that must match the signature on the server.
    
    Returns:
    
    true if client is a valid vsocket, else returns false.
    
    Throws:
    
    IOException
  - getId
```
public int getId()
```
  - getOutputStreamController
```
public MultiplexerOutputStreamController getOutputStreamController()
```
    Used to control the real outputstream.
  - getInputStreamController
```
public MultiplexerInputStreamController getInputStreamController()
```
  - getStatus
```
public int getStatus()
```
  - isValid
```
public boolean isValid()
```
    Flag to know if socket is a valid socket connection.
  - getStartTimeMS
```
public long getStartTimeMS()
```
  - getThread
```
public Thread getThread()
```
  - createSocket
```
public VirtualSocket createSocket(String serverSocketName)
                           throws IOException
```
    Creates a vsocket on client to communicated with a remote handler on server.
    
    Throws:
    
    IOException
  - createSocket
```
protected VirtualSocket createSocket(int connectionId,
                                     int id,
                                     String serverSocketName)
                              throws IOException
```
    Used to create a new "virtual" socket. On the server, this is called directly by MultiplexerServerSocketController when it receives a command CMD_CreateVSocket
    
    Throws:
    
    IOException
  - closeSocket
```
protected void closeSocket(VirtualSocket vs,
                           boolean bSendCommand)
                    throws IOException
```
    Throws:
    
    IOException
  - onSocketException
```
protected void onSocketException(Exception e)
```
    Called when there is a read on the "real" socket. By default, this will call close.
  - getInetAddress
```
public InetAddress getInetAddress()
```
  - close
```
public void close()
           throws IOException
```
    If the socket exists, then the other end of the socket will be notified to close, and then the socket will be closed.
    
    Throws:
    
    IOException
  - wasCloseAlreadyCalled
```
public boolean wasCloseAlreadyCalled()
```
  - close
```
protected void close(boolean bError)
              throws IOException
```
    Throws:
    
    IOException
  - getMultiplexerSockets
```
public VirtualSocket[] getMultiplexerSockets()
```
    Returns:
    
    array of all active MultiplexerSockets.
  - getLiveSocketCount
```
public int getLiveSocketCount()
```
  - isClosed
```
public boolean isClosed()
```
  - setInvalidConnectionMessage
```
public void setInvalidConnectionMessage(String msg)
```
    Message to display when a non-multiplexersocket connects. This message will be sent to client, followed by a disconnect.
  - getInvalidConnectionMessage
```
public String getInvalidConnectionMessage()
```

Class MultiplexerSocketController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_Running

STATUS_DisconnetedByClient

STATUS_DisconnetedByServer

STATUS_DisconnectedByError

Constructor Detail

MultiplexerSocketController

MultiplexerSocketController

Method Detail

verifyServerSideHandshake

getId

getOutputStreamController

getInputStreamController

getStatus

isValid

getStartTimeMS

getThread

createSocket

createSocket

closeSocket

onSocketException

getInetAddress

close

wasCloseAlreadyCalled

close

getMultiplexerSockets

getLiveSocketCount

isClosed

setInvalidConnectionMessage

getInvalidConnectionMessage