InstanceServer (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.util.InstanceServer

All Implemented Interfaces:

Runnable
```
public class InstanceServer
extends Object
implements Runnable
```
The InstanceServer provides a mechanism for managing the instances of an application running concurrently. The application should attempt to send any desired parameters to an already active instance server using the static sendArguments method. If successful (no exception thrown), the application should then shut down, having successfully passed its arguments to the active application instance. If unsuccessful (caught an exception), the application should create an InstanceServer, thus becoming the active application instance.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`alive` Whether this instance server is still listening for spawn events.
`protected Vector`	`listeners` List of application instance spawn listeners.
`protected ServerSocket`	`serverSocket` Server socket listening for client connections.

Constructor Summary

Constructors
Constructor and Description

InstanceServer(int port)
Creates a new instance server on the given port.

Constructors
Constructor and Description
`InstanceServer(int port)` Creates a new instance server on the given port.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSpawnListener(SpawnListener l)` Adds an application instance spawn listener.
`protected void`	`notifyListeners(SpawnEvent e)` Notifies application instance spawn listeners of a newly spawned application instance.
`void`	`removeAllListeners()` Removes all application instance spawn listeners.
`void`	`removeSpawnListener(SpawnListener l)` Removes an application instance spawn listener.
`void`	`run()` Listens for connections from newly spawned application instances and passes their arguments to all registered listeners.
`static void`	`sendArguments(String[] args, int port)` Attempts to send the given arguments to an instance server running on the specified port.
`void`	`stop()` Stops this instance server's thread.

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

- Field Detail
  - serverSocket
```
protected ServerSocket serverSocket
```
    Server socket listening for client connections.
  - listeners
```
protected Vector listeners
```
    List of application instance spawn listeners.
  - alive
```
protected boolean alive
```
    Whether this instance server is still listening for spawn events.
- Constructor Detail
  - InstanceServer
```
public InstanceServer(int port)
               throws IOException
```
    Creates a new instance server on the given port.
    
    Throws:
    
    IOException
- Method Detail
  - sendArguments
```
public static void sendArguments(String[] args,
                                 int port)
                          throws IOException
```
    Attempts to send the given arguments to an instance server running on the specified port. Returns true if successful, indicating the application should shut down since an instance is already running and has received the parameters. Returns false if unsuccessful, indicating the application should create its own InstanceServer and become the active application instance.
    
    Throws:
    
    IOException
  - addSpawnListener
```
public void addSpawnListener(SpawnListener l)
```
    Adds an application instance spawn listener.
  - removeSpawnListener
```
public void removeSpawnListener(SpawnListener l)
```
    Removes an application instance spawn listener.
  - removeAllListeners
```
public void removeAllListeners()
```
    Removes all application instance spawn listeners.
  - stop
```
public void stop()
```
    Stops this instance server's thread.
  - run
```
public void run()
```
    Listens for connections from newly spawned application instances and passes their arguments to all registered listeners.
    
    Specified by:
    
    run in interface Runnable
  - notifyListeners
```
protected void notifyListeners(SpawnEvent e)
```
    Notifies application instance spawn listeners of a newly spawned application instance.

Class InstanceServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serverSocket

listeners

alive

Constructor Detail

InstanceServer

Method Detail

sendArguments

addSpawnListener

removeSpawnListener

removeAllListeners

stop

run

notifyListeners