ClientInputHandler (FreeCol Code Documentation)

java.lang.Object
- net.sf.freecol.client.control.FreeColClientHolder
- - net.sf.freecol.client.control.ClientInputHandler

All Implemented Interfaces:: MessageHandler

public final class ClientInputHandler
extends FreeColClientHolder
implements MessageHandler

Message handler implementation for the client side.

Field Summary

Fields
Modifier and Type Field Description

private static java.util.logging.Logger logger

Constructor Summary

Constructors
Constructor Description

ClientInputHandler(FreeColClient freeColClient)
The constructor to use.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Message`	`handle(Connection connection, Message message)`	Handle an incoming message.
`Message`	`read(Connection connection)`	Read an incoming Message.

Methods inherited from class net.sf.freecol.client.control.FreeColClientHolder
askServer, currentPlayerIsMyPlayer, getClientOptions, getConnectController, getFreeColClient, getFreeColServer, getGame, getGUI, getMap, getMyPlayer, getSpecification, igc, pgc

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

- Field Detail
  - logger
```
private static final java.util.logging.Logger logger
```
- Constructor Detail
  - ClientInputHandler
```
public ClientInputHandler(FreeColClient freeColClient)
```
    The constructor to use.
    
    Parameters:
    
    freeColClient - The FreeColClient for the game.
- Method Detail
  - handle
```
public Message handle(Connection connection,
                      Message message)
               throws FreeColException
```
    Handle an incoming message.
    
    Specified by:
    
    handle in interface MessageHandler
    
    Parameters:
    
    connection - The Connection the message arrived on.
    
    message - The Message to handle.
    
    Returns:
    
    A reply message, if any.
    
    Throws:
    
    FreeColException - if the message is malformed.
  - read
```
public Message read(Connection connection)
             throws FreeColException,
                    javax.xml.stream.XMLStreamException
```
    Read an incoming Message.
    
    Specified by:
    
    read in interface MessageHandler
    
    Parameters:
    
    connection - The Connection to read from.
    
    Returns:
    
    The Message found, or null if none.
    
    Throws:
    
    FreeColException - if the message can not be instantiated.
    
    javax.xml.stream.XMLStreamException - if there is a problem reading the message.