com.captainalm.lib.calmnet.packet

Interface IStreamedPacket

All Superinterfaces:

IPacket

All Known Implementing Classes:

Base64Packet, EncryptedPacket, NetworkEncryptionCipherPacket

public interface IStreamedPacket
extends IPacket

This interface provides the streaming packet methods.

Author:

Captain ALM

Method Summary

Modifier and Type	Method and Description
int	getSize() Gets the size of the output data.
void	readData(java.io.OutputStream outputStream) Reads payload data to an OutputStream.
void	writeData(java.io.InputStream inputStream, int size) Writes payload data from an InputStream.

Methods inherited from interface com.captainalm.lib.calmnet.packet.IPacket

getProtocol, isValid, loadPayload, savePayload

Method Detail

readData

void readData(java.io.OutputStream outputStream)
       throws java.io.IOException,
              PacketException

Reads payload data to an OutputStream.

Parameters:

outputStream - The output stream to read data to.

Throws:

java.lang.NullPointerException - outputStream is null.

java.io.IOException - An IO Exception has occurred.

PacketException - An Exception has occurred.

writeData

void writeData(java.io.InputStream inputStream,
               int size)
        throws java.io.IOException,
               PacketException

Writes payload data from an InputStream.

Parameters:

inputStream - The input stream to write data from.

size - The size of the input payload in bytes.

Throws:

java.lang.NullPointerException - inputStream is null.

java.lang.IllegalArgumentException - size is less than 0.

java.io.IOException - An IO Exception has occurred.

PacketException - An Exception has occurred.

getSize

int getSize()
     throws PacketException

Gets the size of the output data.

Returns:

The size of the output data in bytes.

Throws:

PacketException - An Exception has occurred.