SocketController (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.i2pcontrol.SocketController

All Implemented Interfaces:
ClientApp, RouterApp
```
public class SocketController
extends Object
implements RouterApp
```
This handles the starting and stopping of a ServerSocket from a single static class so it can be called via clients.config. This class is NOT used for the webapp or the HTTP/HTTPS implementation.

Field Summary
Fields
Modifier and Type Field and Description
(package private) static String PROP_ALLOWED_HOSTS
Allowed hosts config property

Fields
Modifier and Type	Field and Description
`(package private) static String`	`PROP_ALLOWED_HOSTS` Allowed hosts config property

Constructor Summary
Constructors
Constructor and Description
SocketController(RouterContext ctx, ClientAppManager mgr)
RouterApp (new way)

Constructors
Constructor and Description
`SocketController(RouterContext ctx, ClientAppManager mgr)` RouterApp (new way)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServerSocket`	`buildServer()` Builds a new server.
`String`	`getDisplayName()` The display name of the ClientApp, used in user interfaces.
`String`	`getName()` The generic name of the ClientApp, used for registration, e.g.
`ClientAppState`	`getState()` The current state of the ClientApp.
`void`	`shutdown(String[] args)` Stop the socket server
`void`	`startup()` Start the socket server

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

- Field Detail
  - PROP_ALLOWED_HOSTS
```
static final String PROP_ALLOWED_HOSTS
```
    Allowed hosts config property
    See Also:
    Constant Field Values
- Constructor Detail
  - SocketController
```
public SocketController(RouterContext ctx,
                        ClientAppManager mgr)
                 throws IOException
```
    RouterApp (new way)
    Throws:
    IOException
- Method Detail
  - buildServer
```
public ServerSocket buildServer()
                         throws IOException
```
    Builds a new server. Used for changing ports during operation and such. Does NOT start the server. Must call start() on the returned server.
    Returns:
    Server - A new server built from current configuration.
    Throws:
    IOException
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: ClientApp
    The display name of the ClientApp, used in user interfaces. The app must translate.
    Specified by:
    getDisplayName in interface ClientApp
    Returns:
    "I2PControl-Socket"
  - getName
```
public String getName()
```
    Description copied from interface: ClientApp
    The generic name of the ClientApp, used for registration, e.g. "console". Do not translate.
    Specified by:
    getName in interface ClientApp
    Returns:
    "I2PControl-Socket"
  - getState
```
public ClientAppState getState()
```
    Description copied from interface: ClientApp
    The current state of the ClientApp.
    Specified by:
    getState in interface ClientApp
    Returns:
    current state
  - shutdown
```
public void shutdown(String[] args)
```
    Stop the socket server
    Specified by:
    shutdown in interface ClientApp
    Parameters:
    args - generally null but could be stopArgs from clients.config
  - startup
```
public void startup()
```
    Start the socket server
    Specified by:
    startup in interface ClientApp

Class SocketController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_ALLOWED_HOSTS

Constructor Detail

SocketController

Method Detail

buildServer

getDisplayName

getName

getState

shutdown

startup