MultiplexerClient (OA Java Code Documentation)

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

```
public class MultiplexerClient
extends Object
```
Creates multiplexed sockets over a single socket. This is used so that a client can have multiple socket connections to multiple "virtual" server sockets through a single real socket.
An Client can then have a single connection to a server and then have multiple virtual socket connections through this connection.

Author:

vvia

See Also:

to create the connection to the server.

Constructor Summary

Constructors
Constructor and Description

MultiplexerClient(String host, int port)
Create a new client.

MultiplexerClient(URI uri)
Create a new client.

Constructors
Constructor and Description
`MultiplexerClient(String host, int port)` Create a new client.
`MultiplexerClient(URI uri)` Create a new client.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close the "real" socket to server.
`VirtualSocket`	`createSocket(String serverSocketName)` Create a socket to a VServerSocket.
`int`	`getConnectionId()` The connectionId that has been assigned by the server.
`int`	`getCreatedSocketCount()`
`String`	`getHost()` Server host name or ip address for the Server.
`int`	`getKeepAlive()`
`int`	`getLiveSocketCount()`
`int`	`getPort()` Port used for connecting to the server.
`long`	`getReadCount()`
`long`	`getReadSize()`
`Socket`	`getSocket()` Get the "real" socket.
`int`	`getThrottleLimit()`
`long`	`getWriteCount()`
`long`	`getWriteSize()`
`boolean`	`isConnected()` Returns true if real socket is connected to server.
`protected void`	`onClose(boolean bError)`
`protected void`	`onSocketException(Exception e)` Called when there is a socket exception
`void`	`pingServer()`
`void`	`runKeepAliveThread()`
`void`	`setKeepAlive(int seconds)`
`void`	`setThrottleLimit(int mbPerSecond)` Used to set the limit on the number of bytes that can be written per second (in MB).
`void`	`start()` Used to create the connection to the MultiplexerServer.

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

- Constructor Detail
  - MultiplexerClient
```
public MultiplexerClient(URI uri)
                  throws Exception
```
    Create a new client.
    
    Parameters:
    
    uri - URI, that includes host and port
    
    Throws:
    
    Exception
    
    See Also:
    
    MultiplexerClient(String, int)
  - MultiplexerClient
```
public MultiplexerClient(String host,
                         int port)
```
    Create a new client.
    
    Parameters:
    
    host - ip or name of server to connect to.
    
    port - port number of the server to connect to.
- Method Detail
  - start
```
public void start()
           throws Exception
```
    Used to create the connection to the MultiplexerServer.
    
    Throws:
    
    Exception
  - onSocketException
```
protected void onSocketException(Exception e)
```
    Called when there is a socket exception
  - onClose
```
protected void onClose(boolean bError)
```
  - setKeepAlive
```
public void setKeepAlive(int seconds)
```
  - getKeepAlive
```
public int getKeepAlive()
```
  - runKeepAliveThread
```
public void runKeepAliveThread()
```
  - pingServer
```
public void pingServer()
                throws Exception
```
    Throws:
    
    Exception
  - 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()
```
  - createSocket
```
public VirtualSocket createSocket(String serverSocketName)
                           throws IOException
```
    Create a socket to a VServerSocket. The server socket must be created on the server first.
    
    Parameters:
    
    serverSocketName - the name given to the socket when creating in MultiplexerServer.
    
    Throws:
    
    IOException
  - getCreatedSocketCount
```
public int getCreatedSocketCount()
```
  - getLiveSocketCount
```
public int getLiveSocketCount()
```
  - close
```
public void close()
           throws IOException
```
    Close the "real" socket to server.
    
    Throws:
    
    IOException
  - getConnectionId
```
public int getConnectionId()
```
    The connectionId that has been assigned by the server.
  - isConnected
```
public boolean isConnected()
```
    Returns true if real socket is connected to server.
  - getSocket
```
public Socket getSocket()
```
    Get the "real" socket.
  - getPort
```
public int getPort()
```
    Port used for connecting to the server.
  - getHost
```
public String getHost()
```
    Server host name or ip address for the Server.
  - 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()
```

Class MultiplexerClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MultiplexerClient

MultiplexerClient

Method Detail

start

onSocketException

onClose

setKeepAlive

getKeepAlive

runKeepAliveThread

pingServer

setThrottleLimit

getThrottleLimit

createSocket

getCreatedSocketCount

getLiveSocketCount

close

getConnectionId

isConnected

getSocket

getPort

getHost

getWriteCount

getWriteSize

getReadCount

getReadSize