NGServer (nailgun-all 1.0.1 API)

java.lang.Object
- com.facebook.nailgun.NGServer

All Implemented Interfaces:

Runnable
```
public class NGServer
extends Object
implements Runnable
```
Listens for new connections from NailGun clients and launches NGSession threads to process them.
This class can be run as a standalone server or can be embedded within larger applications as a means of providing command-line interaction with the application.

Author:

Marty Lamb

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_SESSIONPOOLSIZE` Default size for thread pool
`PrintStream`	`err` `System.err` at the time of the NGServer's creation
`InputStream`	`in` `System.in` at the time of the NGServer's creation
`PrintStream`	`out` `System.out` at the time of the NGServer's creation

Constructor Summary

Constructors
Constructor and Description
`NGServer()` Creates a new NGServer that will listen on the default port (defined in `NGConstants.DEFAULT_PORT`).
`NGServer(InetAddress addr, int port)` Creates a new NGServer that will listen at the specified address and on the specified port with the default session pool size.
`NGServer(InetAddress addr, int port, int sessionPoolSize, int timeoutMillis)` Creates a new NGServer that will listen at the specified address and on the specified port with the specified session pool size.
`NGServer(NGListeningAddress listeningAddress, int sessionPoolSize, int timeoutMillis)` Creates a new NGServer that will listen at the specified address and on the specified port with the specified session pool size.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowsNailsByClassName()` Returns a flag that indicates whether Nail lookups by classname are allowed.
`AliasManager`	`getAliasManager()` Returns the AliasManager in use by this NGServer.
`Class`	`getDefaultNailClass()` Returns the default class that will be used if no Nails can be found via alias or classname.
`int`	`getHeartbeatTimeout()`
`Map<String,NailStats>`	`getNailStats()` Returns a snapshot of this NGServer's nail statistics.
`int`	`getPort()` Returns the port on which this server is (or will be) listening.
`boolean`	`isRunning()` Returns true iff the server is currently running.
`static void`	`main(String[] args)` Creates and starts a new `NGServer`.
`void`	`run()` Listens for new connections and launches NGSession threads to process them.
`void`	`setAllowNailsByClassName(boolean allowNailsByClassName)` Sets a flag that determines whether Nails can be executed by class name.
`void`	`setDefaultNailClass(Class defaultNailClass)` Sets the default class to use for the Nail if no Nails can be found via alias or classname.
`void`	`shutdown()` Shuts down the server.
`void`	`signalExit()` Signal Nailgun server that it needs to stop listening to incoming nail requests and shut down itself after it processes all current nails The function returns immediately, actual shutdown will happen later

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

- Field Detail
  - DEFAULT_SESSIONPOOLSIZE
```
public static final int DEFAULT_SESSIONPOOLSIZE
```
    Default size for thread pool
    
    See Also:
    
    Constant Field Values
  - out
```
public final PrintStream out
```
    System.out at the time of the NGServer's creation
  - err
```
public final PrintStream err
```
    System.err at the time of the NGServer's creation
  - in
```
public final InputStream in
```
    System.in at the time of the NGServer's creation
- Constructor Detail
  - NGServer
```
public NGServer(InetAddress addr,
                int port,
                int sessionPoolSize,
                int timeoutMillis)
```
    Creates a new NGServer that will listen at the specified address and on the specified port with the specified session pool size. This does not cause the server to start listening. To do so, create a new Thread wrapping this NGServer and start it.
    
    Parameters:
    
    addr - the address at which to listen, or null to bind to all local addresses
    
    port - the port on which to listen.
    
    sessionPoolSize - the max number of idle sessions allowed by the pool
  - NGServer
```
public NGServer(InetAddress addr,
                int port)
```
    Creates a new NGServer that will listen at the specified address and on the specified port with the default session pool size. This does not cause the server to start listening. To do so, create a new Thread wrapping this NGServer and start it.
    
    Parameters:
    
    addr - the address at which to listen, or null to bind to all local addresses
    
    port - the port on which to listen.
  - NGServer
```
public NGServer()
```
    Creates a new NGServer that will listen on the default port (defined in NGConstants.DEFAULT_PORT). This does not cause the server to start listening. To do so, create a new Thread wrapping this NGServer and start it.
  - NGServer
```
public NGServer(NGListeningAddress listeningAddress,
                int sessionPoolSize,
                int timeoutMillis)
```
    Creates a new NGServer that will listen at the specified address and on the specified port with the specified session pool size. This does not cause the server to start listening. To do so, create a new Thread wrapping this NGServer and start it.
    
    Parameters:
    
    listeningAddress - the address at which to listen
    
    sessionPoolSize - the max number of idle sessions allowed by the pool
    
    timeoutMillis - timeout in millis to wait for a heartbeat from the client before disconnecting them
- Method Detail
  - setAllowNailsByClassName
```
public void setAllowNailsByClassName(boolean allowNailsByClassName)
```
    Sets a flag that determines whether Nails can be executed by class name. If this is false, Nails can only be run via aliases (and you should probably remove ng-alias from the AliasManager).
    
    Parameters:
    
    allowNailsByClassName - true iff Nail lookups by classname are allowed
  - allowsNailsByClassName
```
public boolean allowsNailsByClassName()
```
    Returns a flag that indicates whether Nail lookups by classname are allowed. If this is false, Nails can only be run via aliases.
    
    Returns:
    
    a flag that indicates whether Nail lookups by classname are allowed.
  - setDefaultNailClass
```
public void setDefaultNailClass(Class defaultNailClass)
```
    Sets the default class to use for the Nail if no Nails can be found via alias or classname. (may be null, in which case NailGun will use its own default)
    
    Parameters:
    
    defaultNailClass - the default class to use for the Nail if no Nails can be found via alias or classname. (may be null, in which case NailGun will use its own default)
  - getDefaultNailClass
```
public Class getDefaultNailClass()
```
    Returns the default class that will be used if no Nails can be found via alias or classname.
    
    Returns:
    
    the default class that will be used if no Nails can be found via alias or classname.
  - getNailStats
```
public Map<String,NailStats> getNailStats()
```
    Returns a snapshot of this NGServer's nail statistics. The result is a java.util.Map, keyed by class name, with NailStats objects as values.
    
    Returns:
    
    a snapshot of this NGServer's nail statistics.
  - getAliasManager
```
public AliasManager getAliasManager()
```
    Returns the AliasManager in use by this NGServer.
    
    Returns:
    
    the AliasManager in use by this NGServer.
  - signalExit
```
public void signalExit()
```
    Signal Nailgun server that it needs to stop listening to incoming nail requests and shut down itself after it processes all current nails The function returns immediately, actual shutdown will happen later
  - shutdown
```
public void shutdown()
```
    Shuts down the server. The server will stop listening and its thread will finish. Any running nails will be allowed to finish.
    Any nails that provide a
```
public static void nailShutdown(NGServer)
```
    method will have this method called with this NGServer as its sole parameter.
  - isRunning
```
public boolean isRunning()
```
    Returns true iff the server is currently running.
    
    Returns:
    
    true iff the server is currently running.
  - getPort
```
public int getPort()
```
    Returns the port on which this server is (or will be) listening.
    
    Returns:
    
    the port on which this server is (or will be) listening.
  - run
```
public void run()
```
    Listens for new connections and launches NGSession threads to process them.
    
    Specified by:
    
    run in interface Runnable
  - main
```
public static void main(String[] args)
                 throws NumberFormatException,
                        UnknownHostException
```
    Creates and starts a new NGServer. A single optional argument is valid, specifying the port on which this NGServer should listen. If omitted, NGServer.DEFAULT_PORT will be used.
    
    Parameters:
    
    args - a single optional argument specifying the port on which to listen.
    
    Throws:
    
    NumberFormatException - if a non-numeric port is specified
    
    UnknownHostException
  - getHeartbeatTimeout
```
public int getHeartbeatTimeout()
```

Class NGServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SESSIONPOOLSIZE

out

err

in

Constructor Detail

NGServer

NGServer

NGServer

NGServer

Method Detail

setAllowNailsByClassName

allowsNailsByClassName

setDefaultNailClass

getDefaultNailClass

getNailStats

getAliasManager

signalExit

shutdown

isRunning

getPort

run

main

getHeartbeatTimeout