Connection (pathfinder-android 0.0.16 API)

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 static org.slf4j.Logger`	`logger` Logs actions performed by the class.
`private MessageHandler`	`messageHandler` Handles incoming web socket messages.
`private Queue<String>`	`messageQueue` Stores messages while the connection is down.
`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.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Connection()
Constructs a connection object that controls access to the web socket connection with the Pathfinder Server.

Constructors
Modifier	Constructor and Description
`protected`	`Connection()` Constructs a connection object that controls access to the web socket connection with the Pathfinder Server.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close(CloseReason reason)` Closes the web socket connection with the Pathfinder server.
`protected long`	`getReceivedMessageCount()` Returns the number of messages receive through the web socket.
`protected 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`	`onError(Session session, Throwable throwable)`
`void`	`onOpen(Session session, EndpointConfig config)`
`private void`	`send(String message)` Sends a message through the web socket connection to the Pathfinder server.
`protected void`	`sendAuthenticationMessage(String message)` Sends an authentication messages that bypasses the message queue.
`void`	`sendMessage(String message)` Sends a text message through the web socket to the Pathfinder server if connected.
`protected void`	`setMessageHandler(MessageHandler messageHandler)` Sets the web socket connection's message handler.

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

- Field Detail
  - logger
```
private static final org.slf4j.Logger logger
```
    Logs actions performed by the class.
  - 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.
  - messageQueue
```
private Queue<String> messageQueue
```
    Stores messages while the connection is down.
- Constructor Detail
  - Connection
```
protected Connection()
```
    Constructs a connection object that controls access to the web socket connection with the Pathfinder Server.
- Method Detail
  - setMessageHandler
```
protected void setMessageHandler(MessageHandler messageHandler)
```
    Sets the web socket connection's message handler. If the message handler is not of the type AuthenticationMessageHandler it will attempt to send all of the backed up messages until the user was authenticated.
    
    Parameters:
    
    messageHandler - to receive the web socket messages.
  - send
```
private void send(String message)
```
    Sends a message through the web socket connection to the Pathfinder server.
    
    Parameters:
    
    message - to be send.
  - sendMessage
```
public void sendMessage(String message)
```
    Sends a text message through the web socket to the Pathfinder server if connected. It will save the message in a queue if not connected.
    
    Parameters:
    
    message - to be sent.
  - sendAuthenticationMessage
```
protected void sendAuthenticationMessage(String message)
```
    Sends an authentication messages that bypasses the message queue.
    
    Parameters:
    
    message - to send to the pathfinder server.
  - 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
  - onError
```
public void onError(Session session,
                    Throwable throwable)
```
    Overrides:
    
    onError 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
```
protected long getSentMessageCount()
```
    Returns the number of messages sent through the web socket.
    
    Returns:
    
    the number of messages sent.
  - getReceivedMessageCount
```
protected 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.

Class Connection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

session

sentMessageCount

messageHandler

messageQueue

Constructor Detail

Connection

Method Detail

setMessageHandler

send

sendMessage

sendAuthenticationMessage

onOpen

onClose

onError

isConnected

getSentMessageCount

getReceivedMessageCount

close