triptracker.client.net
Class MapSocket

java.lang.Object
  triptracker.client.net.SocketConnection<MapSocketListener>
      triptracker.client.net.MapSocket

public class MapSocket
extends SocketConnection<MapSocketListener>

Field Summary

Fields inherited from class triptracker.client.net.SocketConnection

in, inStream, listeners, loggedIn, out, outStream

Constructor Summary

MapSocket()

Method Summary

void	addListener(MapSocketListener listener) Register a listener for server events.
protected void	coordReceived(int routeId, Coordinate coord) Publish a connection state change event to all listeners.
protected void	coordsReceived(List<Coordinate> coords) Publish a connection state change event to all listeners.
void	getRealtimeRoutes() Gets realtime plotting routes from server.
void	getRoute(Route route) Gets complete route from server.
void	getUser(int userId)
void	getUsers() Send a request for a list of users to the server.
void	logon(String user, String pass) Logon a user of the type Protocol.MAPCLIENT.
protected boolean	messageHandler(String message) Message handler for data received on socket.
void	removeListener(MapSocketListener listener) Remove listener from listener queue.
protected void	routeList(List<Route> routes) Publish a route list update event to all listeners.
protected void	routeReceived(int routeId, List<Coordinate> coords) Publish a route list update event to all listeners.
void	setRealtimeRoute(Route route) Sets realtime route to track.
protected void	userReceived(User user) Publish updated user to all listeners
protected void	usersReceived(List<User> users) Publish an updated user list event to all listeners.

Methods inherited from class triptracker.client.net.SocketConnection

brokenListener, connect, connect, connectionUpdate, disconnect, getHost, getPort, getRoutes, getUsername, invalidMessage, isClosed, isConnected, isLoggedIn, logon, messageLoop, sendMessage, setHost, setPort, setRoute, socketErrorEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapSocket

public MapSocket()

Method Detail

logon

public void logon(String user,
                  String pass)
           throws IOException

Logon a user of the type Protocol.MAPCLIENT.

Parameters:

user - username

pass - password

Throws:

IOException - on connection failure

addListener

public void addListener(MapSocketListener listener)

Register a listener for server events.

Overrides:

addListener in class SocketConnection<MapSocketListener>

Parameters:

listener - event receiver to register

removeListener

public void removeListener(MapSocketListener listener)

Remove listener from listener queue.

Overrides:

removeListener in class SocketConnection<MapSocketListener>

Parameters:

listener - event receiver to remove

getUsers

public void getUsers()

Send a request for a list of users to the server.

getUser

public void getUser(int userId)

getRoute

public void getRoute(Route route)

Gets complete route from server.

setRealtimeRoute

public void setRealtimeRoute(Route route)

Sets realtime route to track.

Parameters:

route -

getRealtimeRoutes

public void getRealtimeRoutes()

Gets realtime plotting routes from server.

coordReceived

protected void coordReceived(int routeId,
                             Coordinate coord)

Publish a connection state change event to all listeners. This notifies the clients that the connection state of the underlying socket has changed.

Parameters:

routeId - route ID updated

coord - new coordinate

coordsReceived

protected void coordsReceived(List<Coordinate> coords)

Publish a connection state change event to all listeners. This notifies the clients that the connection state of the underlying socket has changed.

Parameters:

routeId - route ID updated

coord - new coordinate

usersReceived

protected void usersReceived(List<User> users)

Publish an updated user list event to all listeners.

Parameters:

users -

userReceived

protected void userReceived(User user)

Publish updated user to all listeners

Parameters:

users -

routeReceived

protected void routeReceived(int routeId,
                             List<Coordinate> coords)

Publish a route list update event to all listeners.

Parameters:

routeId - route ID updated

coords - list of coordinates

routeList

protected void routeList(List<Route> routes)

Publish a route list update event to all listeners.

Parameters:

routes - received list of routes

messageHandler

protected boolean messageHandler(String message)

Message handler for data received on socket. Subclasses must implement this method to provide handing of recieved messages.

Specified by:

messageHandler in class SocketConnection<MapSocketListener>

Parameters:

message - received message from server

Returns:

true if more messages can be processed, false to end the message loop, stop message handling and close the socket connection