triptracker.client.net
Class GPSSocket

java.lang.Object
  triptracker.client.net.SocketConnection<GPSSocketListener>
      triptracker.client.net.GPSSocket

public class GPSSocket
extends SocketConnection<GPSSocketListener>

Field Summary

Fields inherited from class triptracker.client.net.SocketConnection

in, inStream, listeners, loggedIn, out, outStream

Constructor Summary

GPSSocket()

Method Summary

void	addListener(GPSSocketListener listener) Register a listener for server events.
void	lockRoute(int route) For locking route when it is finnished.
void	logon(String user, String pass) Logon a user of the type Protocol.SENDCLIENT.
void	makeRoute(String description) Generates new route
protected boolean	messageHandler(String message) Message handler for data received on socket.
void	removeListener(GPSSocketListener listener) Remove listener from listener queue.
protected void	routeCreated(int routeId) Publish a route created message event to all listeners.
protected void	routesReceived(List<Route> routes)
void	sendCoord(Coordinate coord) Sends coordinates to server.
boolean	sendTmpCoords(StringBuilder coordBuffer) Sends buffered coordinates to server.

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

GPSSocket

public GPSSocket()

Method Detail

logon

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

Logon a user of the type Protocol.SENDCLIENT.

Parameters:

user - username

pass - password

Throws:

IOException - on connection failure

sendCoord

public void sendCoord(Coordinate coord)

Sends coordinates to server.

Parameters:

coord - coordinate to send to server

sendTmpCoords

public boolean sendTmpCoords(StringBuilder coordBuffer)

Sends buffered coordinates to server.

Parameters:

coordBuffer - string buffer of all coordinates

Returns:

true if send successful, false if send failed

makeRoute

public void makeRoute(String description)

Generates new route

Parameters:

description -

lockRoute

public void lockRoute(int route)

For locking route when it is finnished.

routesReceived

protected void routesReceived(List<Route> routes)

addListener

public void addListener(GPSSocketListener listener)

Register a listener for server events.

Overrides:

addListener in class SocketConnection<GPSSocketListener>

Parameters:

listener - event receiver to register

removeListener

public void removeListener(GPSSocketListener listener)

Remove listener from listener queue.

Overrides:

removeListener in class SocketConnection<GPSSocketListener>

Parameters:

listener - event receiver to remove

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<GPSSocketListener>

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

routeCreated

protected void routeCreated(int routeId)

Publish a route created message event to all listeners. This signals that a previous request to create a route has been accepted.

Parameters:

routeId - route ID of the new route