MultiplexerServerSocketController (OA Java Code Documentation)

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

```
public class MultiplexerServerSocketController
extends Object
```
Manages multiplexed server socket connections. This will use a "real" ServerSocket to accept new "real" client socket connections. The real connections are then managed by a MultiplexerSocketController so that new sockets can be multiplexed inside the "real" socket.

Author:

vvia

Constructor Summary

Constructors
Constructor and Description
`MultiplexerServerSocketController()` Created by MultiplexerServer to manage a "real" serversocket, to accept client connections created by MultiplexerClient.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`add(MultiplexerSocketController vsc)` Adds a new SocketController to list.
`void`	`close()` Close all client connections.
`int`	`getCreatedConnectionCount()`
`String`	`getInvalidConnectionMessage()`
`int`	`getLiveConnectionCount()`
`long`	`getReadCount()`
`long`	`getReadSize()`
`VirtualServerSocket`	`getServerSocket(String serverSocketName)` Create a new ServerSocket that will accept new client MultiplexerSockets through a multiplexed connection.
`protected MultiplexerSocketController[]`	`getSocketControllers()`
`int`	`getThrottleLimit()`
`long`	`getWriteCount()`
`long`	`getWriteSize()`
`protected void`	`onAcceptRealClientConnection(Socket socket)` This is internally called when a new "real" client socket connection is accepted on the server.
`void`	`onClientConnect(Socket socket, int connectionId)`
`void`	`onClientDisconnect(int connectionId)`
`protected void`	`remove(MultiplexerSocketController vsc)` Removes a SocketController from list.
`void`	`setInvalidConnectionMessage(String msg)` Message to display when a non-socket connects.
`void`	`setThrottleLimit(int mbPerSecond)` Used to set the limit on the number of bytes that can be written per second (in MB).
`void`	`start(ServerSocket ss)`
`protected void`	`timeoutConnections()` Used by Thread to check new connections to make sure that they are valid connections.

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

- Constructor Detail
  - MultiplexerServerSocketController
```
public MultiplexerServerSocketController()
```
    Created by MultiplexerServer to manage a "real" serversocket, to accept client connections created by MultiplexerClient.
- Method Detail
  - setInvalidConnectionMessage
```
public void setInvalidConnectionMessage(String msg)
```
    Message to display when a non-socket connects. This message will be sent to client, followed by a disconnect.
  - getInvalidConnectionMessage
```
public String getInvalidConnectionMessage()
```
  - start
```
public void start(ServerSocket ss)
```
  - setThrottleLimit
```
public void setThrottleLimit(int mbPerSecond)
```
    Used to set the limit on the number of bytes that can be written per second (in MB).
  - getThrottleLimit
```
public int getThrottleLimit()
```
  - onAcceptRealClientConnection
```
protected void onAcceptRealClientConnection(Socket socket)
                                     throws IOException
```
    This is internally called when a new "real" client socket connection is accepted on the server. This will create a MultiplexerSocketController (ISC) to manage the connection. The ISC will then create MultiplexerSockets, which will then be "given" to MultiplexerServerSocket accept(). This method is thread safe, since only one accept() can be done at a time.
    
    Throws:
    
    IOException
  - timeoutConnections
```
protected void timeoutConnections()
```
    Used by Thread to check new connections to make sure that they are valid connections. Each new connection is given 5 seconds to be validated by MultiplexerSocketController.
  - add
```
protected void add(MultiplexerSocketController vsc)
```
    Adds a new SocketController to list.
  - remove
```
protected void remove(MultiplexerSocketController vsc)
```
    Removes a SocketController from list.
  - getSocketControllers
```
protected MultiplexerSocketController[] getSocketControllers()
```
    Returns:
    
    list of all client connections.
  - getServerSocket
```
public VirtualServerSocket getServerSocket(String serverSocketName)
                                    throws IOException
```
    Create a new ServerSocket that will accept new client MultiplexerSockets through a multiplexed connection. This is used by MultiplexerServer to create new server sockets.
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws Exception
```
    Close all client connections.
    
    Throws:
    
    Exception
  - onClientConnect
```
public void onClientConnect(Socket socket,
                            int connectionId)
```
  - onClientDisconnect
```
public void onClientDisconnect(int connectionId)
```
  - getWriteCount
```
public long getWriteCount()
```
    Returns:
    
    number of writes made.
  - getWriteSize
```
public long getWriteSize()
```
  - getReadCount
```
public long getReadCount()
```
    Returns:
    
    number of reads made.
  - getReadSize
```
public long getReadSize()
```
  - getCreatedConnectionCount
```
public int getCreatedConnectionCount()
```
  - getLiveConnectionCount
```
public int getLiveConnectionCount()
```

Class MultiplexerServerSocketController

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MultiplexerServerSocketController

Method Detail

setInvalidConnectionMessage

getInvalidConnectionMessage

start

setThrottleLimit

getThrottleLimit

onAcceptRealClientConnection

timeoutConnections

add

remove

getSocketControllers

getServerSocket

close

onClientConnect

onClientDisconnect

getWriteCount

getWriteSize

getReadCount

getReadSize

getCreatedConnectionCount

getLiveConnectionCount