MultiplexerServer (OA Java Code Documentation)

java.lang.Object
- com.viaoa.comm.multiplexer.MultiplexerServer

```
public class MultiplexerServer
extends Object
```
Used for creating a multiplexed ServerSockets, so that a client can have multiple "virtual" server sockets through a single real socket.
The MultiplexerServer can be used to have multiple serversockets that a MultiplexerClient can then make many connections through a single real socket.
This is useful for situations where multiple real connections are undesired because of routing/loadbalance and connection management issues.
An MultiplexerClient can then have a single connection to a server and then have multiple connections through this connection.

Author:

vvia

Constructor Summary

Constructors
Constructor and Description
`MultiplexerServer(int port)`
`MultiplexerServer(String host, int port)` Creates a new server that allows for multiplexing many client connections over a single real connection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VirtualServerSocket`	`createServerSocket(String serverSocketName)` Creates a serverSocket (virtual) through the real socket.
`int`	`getCreatedConnectionCount()`
`String`	`getHost()` Host name.
`String`	`getInvalidConnectionMessage()`
`int`	`getLiveConnectionCount()`
`int`	`getPort()` Server listen port.
`long`	`getReadCount()`
`long`	`getReadSize()`
`int`	`getThrottleLimit()`
`long`	`getWriteCount()`
`long`	`getWriteSize()`
`boolean`	`isStarted()`
`protected void`	`onClientConnect(Socket socket, int connectionId)` Called when a real socket connection is made.
`protected void`	`onClientDisconnect(int connectionId)` Called when a real socket is disconnected.
`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()` This must be called to enable serverSocket to begin accepting new connections.
`void`	`stop()`
`void`	`stopServerSocket()` Stop the serverSocket from accepting new connections.

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

- Constructor Detail
  - MultiplexerServer
```
public MultiplexerServer(String host,
                         int port)
```
    Creates a new server that allows for multiplexing many client connections over a single real connection.
    
    Parameters:
    
    host - name
    
    port - port number to connect to
    
    See Also:
    
    call start to allow new connections from clients.
  - MultiplexerServer
```
public MultiplexerServer(int port)
```
- Method Detail
  - setThrottleLimit
```
public void setThrottleLimit(int mbPerSecond)
                      throws Exception
```
    Used to set the limit on the number of bytes that can be written per second (in MB).
    
    Throws:
    
    Exception
  - getThrottleLimit
```
public int getThrottleLimit()
                     throws Exception
```
    Throws:
    
    Exception
  - start
```
public void start()
           throws Exception
```
    This must be called to enable serverSocket to begin accepting new connections.
    
    Throws:
    
    Exception
  - stop
```
public void stop()
          throws Exception
```
    Throws:
    
    Exception
  - stopServerSocket
```
public void stopServerSocket()
                      throws Exception
```
    Stop the serverSocket from accepting new connections. Dont accept new client connections, but keep current client sockets connected
    
    Throws:
    
    Exception
  - isStarted
```
public boolean isStarted()
```
    Returns:
    
    true if serverSocket is accepting new connnections.
  - createServerSocket
```
public VirtualServerSocket createServerSocket(String serverSocketName)
                                       throws IOException
```
    Creates a serverSocket (virtual) through the real socket. This can then be used to accept new socket connections from a MultiplexerClient.
    
    Parameters:
    
    serverSocketName - unique name that will be used by clients when creating an vsocket.
    
    Returns:
    
    new ServerSocket that can be used to accept new socket connections.
    
    Throws:
    
    IOException
  - getPort
```
public int getPort()
```
    Server listen port.
  - getHost
```
public String getHost()
```
    Host name.
  - 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()
```
  - onClientDisconnect
```
protected void onClientDisconnect(int connectionId)
```
    Called when a real socket is disconnected.
  - onClientConnect
```
protected void onClientConnect(Socket socket,
                               int connectionId)
```
    Called when a real socket connection is made.
  - getReadCount
```
public long getReadCount()
```
    Returns:
    
    number of reads made.
  - getReadSize
```
public long getReadSize()
```
  - getWriteCount
```
public long getWriteCount()
```
    Returns:
    
    number of writes made.
  - getWriteSize
```
public long getWriteSize()
```
  - getCreatedConnectionCount
```
public int getCreatedConnectionCount()
```
  - getLiveConnectionCount
```
public int getLiveConnectionCount()
```

Class MultiplexerServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MultiplexerServer

MultiplexerServer

Method Detail

setThrottleLimit

getThrottleLimit

start

stop

stopServerSocket

isStarted

createServerSocket

getPort

getHost

setInvalidConnectionMessage

getInvalidConnectionMessage

onClientDisconnect

onClientConnect

getReadCount

getReadSize

getWriteCount

getWriteSize

getCreatedConnectionCount

getLiveConnectionCount