xyz.thepathfinder.android

Class Connection

java.lang.Object

javax.websocket.Endpoint

xyz.thepathfinder.android.Connection

 class Connection
extends Endpoint

Controls access the web socket connection with the Pathfinder sever. To gain access to the connection use PathfinderServices.getConnection().

Field Summary

Fields

Modifier and Type	Field and Description
private String	applictionIdentifier The application identifier sent to the Pathfinder server.
private static Logger	logger Logs all outgoing messages through the web socket.
private MessageHandler	messageHandler Handles incoming web socket messages.
private ModelRegistry	registry Access to the model registry to notify Models of incoming web socket messages.
private long	sentMessageCount Number of messages sent through the web socket.
private Session	session The web socket session used to send messages through the web socket.
private String	userCredentials The user's credentials to the Pathfinder server.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Connection(String applictionIdentifier, String userCredentials, ModelRegistry registry) Constructs a connection object that controls access to the web socket connection with the Pathfinder Server.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(CloseReason reason) Closes the web socket connection with the Pathfinder server.
long	getReceivedMessageCount() Returns the number of messages receive through the web socket.
long	getSentMessageCount() Returns the number of messages sent through the web socket.
boolean	isConnected() Returns if the web socket is connected.
void	onClose(Session session, CloseReason closeReason)
void	onOpen(Session session, EndpointConfig config)
void	sendMessage(String message) Sends a text message through the web socket to the Pathfinder server.

Methods inherited from class javax.websocket.Endpoint

onError

Methods inherited from class java.lang.Object

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

Field Detail

applictionIdentifier

private final String applictionIdentifier

The application identifier sent to the Pathfinder server.

userCredentials

private final String userCredentials

The user's credentials to the Pathfinder server.

registry

private final ModelRegistry registry

Access to the model registry to notify Models of incoming web socket messages.

session

private Session session

The web socket session used to send messages through the web socket.

sentMessageCount

private long sentMessageCount

Number of messages sent through the web socket.

messageHandler

private MessageHandler messageHandler

Handles incoming web socket messages.

logger

private static final Logger logger

Logs all outgoing messages through the web socket.

Constructor Detail

Connection

protected Connection(String applictionIdentifier,
          String userCredentials,
          ModelRegistry registry)

Constructs a connection object that controls access to the web socket connection with the Pathfinder Server.

Parameters:

applictionIdentifier - the application identifier provided by the Pathfinder server for the application

userCredentials - the user's credentials for this application

registry - a model registry

Method Detail

sendMessage

public void sendMessage(String message)

Sends a text message through the web socket to the Pathfinder server.

Parameters:

message - the message to be sent.

Throws:

IllegalStateException - the web socket is not connected.

onOpen

public void onOpen(Session session,
          EndpointConfig config)

Specified by:

onOpen in class Endpoint

onClose

public void onClose(Session session,
           CloseReason closeReason)

Overrides:

onClose in class Endpoint

isConnected

public boolean isConnected()

Returns if the web socket is connected.

Returns:

true if the web socket is connected, false otherwise.

getSentMessageCount

public long getSentMessageCount()

Returns the number of messages sent through the web socket.

Returns:

the number of messages sent.

getReceivedMessageCount

public long getReceivedMessageCount()

Returns the number of messages receive through the web socket.

Returns:

the number of messages received.

close

public void close(CloseReason reason)
           throws IOException

Closes the web socket connection with the Pathfinder server.

Parameters:

reason - the reason for closing the web socket.

Throws:

IOException - if the web socket failed to close properly.