Package net.ME1312.SubData.Client
Class SubDataProtocol
java.lang.Object
net.ME1312.SubData.Client.DataProtocol
net.ME1312.SubData.Client.SubDataProtocol
SubData Protocol Class
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addVersion
(Version version) Add a Protocol Version to the Supported Versions Listint
Get SubData's Block SizegetName()
Get the Network Protocol NamegetPacket
(int id) Grab PacketIn Instance via IDVersion[]
Get the Supported Protocol Version Listopen
(Consumer<Runnable> scheduler, Logger logger, InetAddress address, int port) Launch a SubData Client Instanceopen
(Consumer<Runnable> scheduler, Logger logger, InetAddress address, int port, ObjectMap<?> login) Launch a SubData Client Instanceopen
(Logger logger, InetAddress address, int port) Launch a SubData Client Instanceopen
(Logger logger, InetAddress address, int port, ObjectMap<?> login) Launch a SubData Client Instancevoid
registerCipher
(String handle, Cipher cipher) Register a Cipher to SubDatavoid
registerPacket
(int id, Class<? extends PacketOut> packet) Register PacketOut to the Networkvoid
registerPacket
(int id, PacketIn packet) Register PacketIn to the Networkvoid
removeVersion
(Version version) Remove a Protocol Version from the Supported Versions Listvoid
setBlockSize
(int size) Set SubData's Block Sizevoid
Set the Network Protocol Name (may only be called once)void
unregisterCipher
(String handle) Unregister a Cipher from SubDatavoid
unregisterPacket
(Class<? extends PacketOut> packet) Unregister PacketOut to the Networkvoid
unregisterPacket
(PacketIn packet) Unregister PacketIn from the NetworkMethods inherited from class net.ME1312.SubData.Client.DataProtocol
getMessage, registerMessage, registerMessage, unregisterMessage, unregisterMessage
-
Field Details
-
MIN_PACKET_ID
public static final int MIN_PACKET_ID- See Also:
-
MAX_PACKET_ID
public static final int MAX_PACKET_ID- See Also:
-
-
Constructor Details
-
SubDataProtocol
public SubDataProtocol()Create a new Protocol
-
-
Method Details
-
open
public SubDataClient open(Consumer<Runnable> scheduler, Logger logger, InetAddress address, int port, ObjectMap<?> login) throws IOException Launch a SubData Client Instance- Parameters:
scheduler
- Event Schedulerlogger
- Network Loggeraddress
- Bind Address (or null for all)port
- Port Numberlogin
- Login Data- Throws:
IOException
-
open
public SubDataClient open(Consumer<Runnable> scheduler, Logger logger, InetAddress address, int port) throws IOException Launch a SubData Client Instance- Parameters:
scheduler
- Event Schedulerlogger
- Network Loggeraddress
- Bind Address (or null for all)port
- Port Number- Throws:
IOException
-
open
public SubDataClient open(Logger logger, InetAddress address, int port, ObjectMap<?> login) throws IOException Launch a SubData Client Instance- Parameters:
logger
- Network Loggeraddress
- Bind Address (or null for all)port
- Port Numberlogin
- Login Data- Throws:
IOException
-
open
Launch a SubData Client Instance- Parameters:
logger
- Network Loggeraddress
- Bind Address (or null for all)port
- Port Number- Throws:
IOException
-
setName
Set the Network Protocol Name (may only be called once)- Parameters:
name
- Protocol Name
-
getName
Description copied from class:DataProtocol
Get the Network Protocol Name- Specified by:
getName
in classDataProtocol
- Returns:
- Protocol Name
-
addVersion
Add a Protocol Version to the Supported Versions List- Parameters:
version
- Protocol Version
-
removeVersion
Remove a Protocol Version from the Supported Versions List- Parameters:
version
- Protocol Version
-
getVersion
Description copied from class:DataProtocol
Get the Supported Protocol Version List- Specified by:
getVersion
in classDataProtocol
- Returns:
- Supported Protocol Versions
-
getBlockSize
public int getBlockSize()Get SubData's Block Size- Returns:
- Block Size
-
setBlockSize
public void setBlockSize(int size) Set SubData's Block Size- Parameters:
size
- Block Size
-
registerCipher
Register a Cipher to SubData- Parameters:
cipher
- Cipher to Addhandle
- Handle to Bind
-
unregisterCipher
Unregister a Cipher from SubData- Parameters:
handle
- Handle
-
registerPacket
Register PacketIn to the Network- Parameters:
id
- Packet ID (as an unsigned 16-bit value)packet
- PacketIn to register
-
unregisterPacket
Unregister PacketIn from the Network- Parameters:
packet
- PacketIn to unregister
-
registerPacket
Register PacketOut to the Network- Parameters:
id
- Packet ID (as an unsigned 16-bit value)packet
- PacketOut to register
-
unregisterPacket
Unregister PacketOut to the Network- Parameters:
packet
- PacketOut to unregister
-
getPacket
Grab PacketIn Instance via ID- Parameters:
id
- Packet ID (as an unsigned 16-bit value)- Returns:
- PacketIn
-