DataClient (SubData Client Javadoc)

java.lang.Object
- net.ME1312.SubData.Client.DataClient

All Implemented Interfaces:

DataSender

Direct Known Subclasses:

SubDataClient
```
public abstract class DataClient
extends Object
implements DataSender
```
SubData Client API Class

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataClient.Events
SubData Client Event API Class

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataClient.Events` SubData Client Event API Class

Field Summary

Fields
Modifier and Type Field and Description

DataClient.Events on

Fields
Modifier and Type	Field and Description
`DataClient.Events`	`on`

Constructor Summary

Constructors
Constructor and Description

DataClient()

Constructors
Constructor and Description
`DataClient()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract void`	`close()` Closes the connection
`abstract <ForwardableMessageOut extends MessageOut & Forwardable> void`	`forwardMessage(UUID id, ForwardableMessageOut message)` Forward a message to another Client
`abstract InetSocketAddress`	`getAddress()` Get Remote Address
`abstract void`	`getClient(UUID id, Callback<ObjectMap<String>> callback)` Grabs a Client from the Network
`abstract void`	`getClients(Callback<Map<UUID,? extends ObjectMap<String>>> callback)` Grabs all the Clients on the Network
`DataClient`	`getConnection()` Deprecated. The Client connection to the Server is this
`UUID`	`getID()` Get the ID of this Client
`abstract DataProtocol`	`getProtocol()` Get the Protocol for this Client
`abstract boolean`	`isClosed()` Get if the connection has been closed
`abstract DataClient`	`openChannel()` Open an Async Data SubChannel
`abstract void`	`ping(Callback<PingResponse> response)` Ping the Server
`abstract void`	`ping(UUID id, Callback<PingResponse> response)` Ping a remote Client
`abstract void`	`sendMessage(MessageOut message)` Send a message to the Server
`void`	`waitFor()` Wait for the connection to close

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

- Field Detail
  - on
```
public final DataClient.Events on
```
- Constructor Detail
  - DataClient
```
public DataClient()
```
- Method Detail
  - getClient
```
public abstract void getClient(UUID id,
                               Callback<ObjectMap<String>> callback)
```
    Grabs a Client from the Network
    
    Parameters:
    
    id - Client ID
  - getClients
```
public abstract void getClients(Callback<Map<UUID,? extends ObjectMap<String>>> callback)
```
    Grabs all the Clients on the Network
  - ping
```
public abstract void ping(Callback<PingResponse> response)
```
    Ping the Server
    
    Specified by:
    
    ping in interface DataSender
    
    Parameters:
    
    response - Ping Response
  - ping
```
public abstract void ping(UUID id,
                          Callback<PingResponse> response)
```
    Ping a remote Client
    
    Parameters:
    
    id - Client ID
    
    response - Ping Response
  - sendMessage
```
public abstract void sendMessage(MessageOut message)
```
    Send a message to the Server
    
    Specified by:
    
    sendMessage in interface DataSender
    
    Parameters:
    
    message - Message to send
    
    See Also:
    
    Packets must NOT e tagged as Forward-Only
  - forwardMessage
```
public abstract <ForwardableMessageOut extends MessageOut & Forwardable> void forwardMessage(UUID id,
                                                                                             ForwardableMessageOut message)
```
    Forward a message to another Client
    
    Parameters:
    
    id - Client ID
    
    message - Message to send
    
    See Also:
    
    Messages must be tagged as Forwardable
  - getConnection
```
@Deprecated
public DataClient getConnection()
```
    Deprecated. The Client connection to the Server is this
    
    Get the Client that connects the Server to us
    
    Specified by:
    
    getConnection in interface DataSender
    
    Returns:
    
    This Client
  - getProtocol
```
public abstract DataProtocol getProtocol()
```
    Get the Protocol for this Client
    
    Specified by:
    
    getProtocol in interface DataSender
    
    Returns:
    
    Client Protocol
  - getID
```
public UUID getID()
```
    Get the ID of this Client
    
    Specified by:
    
    getID in interface DataSender
    
    Returns:
    
    Client ID
  - getAddress
```
public abstract InetSocketAddress getAddress()
```
    Get Remote Address
    
    Returns:
    
    Address
  - openChannel
```
public abstract DataClient openChannel()
                                throws IOException
```
    Open an Async Data SubChannel
    
    Returns:
    
    New SubData Channel
    
    Throws:
    
    IOException
  - close
```
public abstract void close()
                    throws IOException
```
    Closes the connection
    
    Throws:
    
    IOException
  - waitFor
```
public void waitFor()
             throws InterruptedException
```
    Wait for the connection to close
    
    Throws:
    
    InterruptedException
  - isClosed
```
public abstract boolean isClosed()
```
    Get if the connection has been closed
    
    Returns:
    
    Closed Status

Class DataClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

on

Constructor Detail

DataClient

Method Detail

getClient

getClients

ping

ping

sendMessage

forwardMessage

getConnection

getProtocol

getID

getAddress

openChannel

close

waitFor

isClosed