uk.co.thomasc.steamkit.base

Class AMsgBase

java.lang.Object

uk.co.thomasc.steamkit.base.AMsgBase

Direct Known Subclasses:

GCMsgBase, MsgBase

public abstract class AMsgBase
extends Object

This class provides a payload backing to client messages.

Field Summary

Fields

Modifier and Type	Field and Description
private BinaryWriter	outputStream
private BinaryReader	reader

Constructor Summary

Constructors

Constructor and Description
AMsgBase()
AMsgBase(int payloadReserve) Initializes a new instance of the AMsgBase class.

Method Summary

Methods

Modifier and Type	Method and Description
void	write(byte[] data) Writes the specified byte array to the message payload.
void	write(int data) Writes a single 32bit integer to the message payload.
void	write(long data) Writes a single 64bit long to the message payload.
void	write(String data, Charset encoding) Writes the specified string to the message payload using the specified encoding.
void	writeNullTermString(String data, Charset encoding) Writes the specified string and a null terminator to the message payload using the specified encoding.

Methods inherited from class java.lang.Object

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

Field Detail

reader

private BinaryReader reader

outputStream

private final BinaryWriter outputStream

Constructor Detail

AMsgBase

public AMsgBase(int payloadReserve)

Initializes a new instance of the AMsgBase class.

Parameters:

payloadReserve - The number of bytes to initialize the payload capacity to.

AMsgBase

public AMsgBase()

Method Detail

write

public void write(int data)
           throws IOException

Writes a single 32bit integer to the message payload.

Parameters:

data - The integer.

Throws:

IOException

write

public void write(long data)
           throws IOException

Writes a single 64bit long to the message payload.

Parameters:

data - The long.

Throws:

IOException

write

public void write(byte[] data)
           throws IOException

Writes the specified byte array to the message payload.

Parameters:

data - The byte array.

Throws:

IOException

write

public void write(String data,
         Charset encoding)
           throws IOException

Writes the specified string to the message payload using the specified encoding. This function does not write a terminating null character.

Parameters:

data - The string to write.

encoding - The encoding to use.

Throws:

IOException

writeNullTermString

public void writeNullTermString(String data,
                       Charset encoding)
                         throws IOException

Writes the specified string and a null terminator to the message payload using the specified encoding.

Parameters:

data - The string to write.

encoding - The encoding to use.

Throws:

IOException