EchoServerGenerator (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.websocket.server.AbstractWebSocketServerGenerator
      - adams.flow.websocket.server.EchoServerGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, WebSocketServerGenerator, Serializable
```
public class EchoServerGenerator
extends AbstractWebSocketServerGenerator
```
Generates a simple echo server.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected int m_Port
the port to bind to.
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

EchoServerGenerator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected com.pusher.java_websocket.server.WebSocketServer`	`doGenerate()`	Generates the server.
`int`	`getPort()`	Returns the port to connect to.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`portTipText()`	Returns the tip text for this property.
`void`	`setPort(int value)`	Sets the port to connect to.

Methods inherited from class adams.flow.websocket.server.AbstractWebSocketServerGenerator
check, generateServer, getQuickInfo

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

- Field Detail
  - m_Port
```
protected int m_Port
```
    the port to bind to.
- Constructor Detail
  - EchoServerGenerator
```
public EchoServerGenerator()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setPort
```
public void setPort(int value)
```
    Sets the port to connect to.
    
    Parameters:
    
    value - the port
  - getPort
```
public int getPort()
```
    Returns the port to connect to.
    
    Returns:
    
    the port
  - portTipText
```
public String portTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - doGenerate
```
protected com.pusher.java_websocket.server.WebSocketServer doGenerate()
```
    Generates the server.
    
    Specified by:
    
    doGenerate in class AbstractWebSocketServerGenerator
    
    Returns:
    
    the server