games.strategy.net
Class ServerMessenger

java.lang.Object
  extended by games.strategy.net.ServerMessenger
All Implemented Interfaces:
IMessenger, IServerMessenger, NIOSocketListener

public class ServerMessenger
extends java.lang.Object
implements IServerMessenger, NIOSocketListener

A Messenger that can have many clients connected to it.

Version:
1.0
Author:
Sean Bridges

Constructor Summary
ServerMessenger(java.lang.String name, int portNumber)
          Creates new ServerMessenger
ServerMessenger(java.lang.String name, int portNumber, IObjectStreamFactory streamFactory)
           
 
Method Summary
 void addConnectionChangeListener(IConnectionChangeListener listener)
          Add a listener for change in connection status.
 void addErrorListener(IMessengerErrorListener listener)
          Listen for errors
 void addMessageListener(IMessageListener listener)
          Listen for messages.
 void broadcast(java.io.Serializable msg)
          Send a message to all nodes.
 INode getLocalNode()
          Get the local node
 ILoginValidator getLoginValidator()
           
 java.util.Set<INode> getNodes()
          Get a list of nodes.
 INode getRemoteNode(java.nio.channels.SocketChannel channel)
          Get the remote node id for this channel, or null if the remote node id is not yet known.
 java.net.InetSocketAddress getRemoteServerSocketAddress()
          Get the socket address to which we talk to the server.
 INode getServerNode()
           
 java.lang.String getUniqueName(java.lang.String currentName)
           
 boolean isAcceptNewConnections()
           
 boolean isConnected()
          test the connection.
 boolean isServer()
          Am I the server node?
 void messageReceived(MessageHeader msg, java.nio.channels.SocketChannel channel)
           
 void removeConnection(INode node)
          Remove the node from the network.
 void removeConnectionChangeListener(IConnectionChangeListener listener)
          Remove a listener for change in connection status.
 void removeErrorListener(IMessengerErrorListener listener)
          Stop listening for errors.
 void removeMessageListener(IMessageListener listener)
          Stop listening to messages.
 void send(java.io.Serializable msg, INode to)
          Send a message to the given node.
 void setAcceptNewConnections(boolean accept)
           
 void setLoginValidator(ILoginValidator loginValidator)
           
 void shutDown()
          Shut the connection down.
 void socketError(java.nio.channels.SocketChannel channel, java.lang.Exception error)
          An error occured on the channel and it was shut down.
 void socketUnqaurantined(java.nio.channels.SocketChannel channel, QuarantineConversation conversation)
          This connection will leave quarantine.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServerMessenger

public ServerMessenger(java.lang.String name,
                       int portNumber,
                       IObjectStreamFactory streamFactory)
                throws java.io.IOException
Throws:
java.io.IOException

ServerMessenger

public ServerMessenger(java.lang.String name,
                       int portNumber)
                throws java.io.IOException
Creates new ServerMessenger

Throws:
java.io.IOException
Method Detail

setLoginValidator

public void setLoginValidator(ILoginValidator loginValidator)
Specified by:
setLoginValidator in interface IServerMessenger

getLoginValidator

public ILoginValidator getLoginValidator()
Specified by:
getLoginValidator in interface IServerMessenger

addMessageListener

public void addMessageListener(IMessageListener listener)
Description copied from interface: IMessenger
Listen for messages.

Specified by:
addMessageListener in interface IMessenger

removeMessageListener

public void removeMessageListener(IMessageListener listener)
Description copied from interface: IMessenger
Stop listening to messages.

Specified by:
removeMessageListener in interface IMessenger

getNodes

public java.util.Set<INode> getNodes()
Get a list of nodes.

Specified by:
getNodes in interface IServerMessenger

shutDown

public void shutDown()
Description copied from interface: IMessenger
Shut the connection down.

Specified by:
shutDown in interface IMessenger

isConnected

public boolean isConnected()
Description copied from interface: IMessenger
test the connection.

Specified by:
isConnected in interface IMessenger

send

public void send(java.io.Serializable msg,
                 INode to)
Send a message to the given node.

Specified by:
send in interface IMessenger

broadcast

public void broadcast(java.io.Serializable msg)
Send a message to all nodes.

Specified by:
broadcast in interface IMessenger

messageReceived

public void messageReceived(MessageHeader msg,
                            java.nio.channels.SocketChannel channel)
Specified by:
messageReceived in interface NIOSocketListener

getUniqueName

public java.lang.String getUniqueName(java.lang.String currentName)

addErrorListener

public void addErrorListener(IMessengerErrorListener listener)
Description copied from interface: IMessenger
Listen for errors

Specified by:
addErrorListener in interface IMessenger

removeErrorListener

public void removeErrorListener(IMessengerErrorListener listener)
Description copied from interface: IMessenger
Stop listening for errors.

Specified by:
removeErrorListener in interface IMessenger

addConnectionChangeListener

public void addConnectionChangeListener(IConnectionChangeListener listener)
Description copied from interface: IServerMessenger
Add a listener for change in connection status.

Specified by:
addConnectionChangeListener in interface IServerMessenger

removeConnectionChangeListener

public void removeConnectionChangeListener(IConnectionChangeListener listener)
Description copied from interface: IServerMessenger
Remove a listener for change in connection status.

Specified by:
removeConnectionChangeListener in interface IServerMessenger

setAcceptNewConnections

public void setAcceptNewConnections(boolean accept)
Specified by:
setAcceptNewConnections in interface IServerMessenger

isAcceptNewConnections

public boolean isAcceptNewConnections()
Specified by:
isAcceptNewConnections in interface IServerMessenger

getLocalNode

public INode getLocalNode()
Get the local node

Specified by:
getLocalNode in interface IMessenger
Specified by:
getLocalNode in interface NIOSocketListener

isServer

public boolean isServer()
Description copied from interface: IMessenger
Am I the server node? There should only be one server node, and it should exist before other nodes.

Specified by:
isServer in interface IMessenger

removeConnection

public void removeConnection(INode node)
Description copied from interface: IServerMessenger
Remove the node from the network.

Specified by:
removeConnection in interface IServerMessenger

getServerNode

public INode getServerNode()
Specified by:
getServerNode in interface IMessenger
Returns:
local node if we are a server node.

socketError

public void socketError(java.nio.channels.SocketChannel channel,
                        java.lang.Exception error)
Description copied from interface: NIOSocketListener
An error occured on the channel and it was shut down.

Specified by:
socketError in interface NIOSocketListener

socketUnqaurantined

public void socketUnqaurantined(java.nio.channels.SocketChannel channel,
                                QuarantineConversation conversation)
Description copied from interface: NIOSocketListener
This connection will leave quarantine. Messages on this channel will not be read until after this method returns, allowing for setup of the channel.

Specified by:
socketUnqaurantined in interface NIOSocketListener

getRemoteNode

public INode getRemoteNode(java.nio.channels.SocketChannel channel)
Description copied from interface: NIOSocketListener
Get the remote node id for this channel, or null if the remote node id is not yet known. The node may be unknown if the channel is still quarantined

Specified by:
getRemoteNode in interface NIOSocketListener

getRemoteServerSocketAddress

public java.net.InetSocketAddress getRemoteServerSocketAddress()
Description copied from interface: IMessenger
Get the socket address to which we talk to the server. This may be different than getServerNode().getSocketAddress() since the server will report the socket that he thinks the server is running on, if the server is behind a firewall, or a NAT, then this socket will be different than the actual port we use.

Specified by:
getRemoteServerSocketAddress in interface IMessenger