Package in.dragonbra.javasteam.base

Class AbstractMsgBase

java.lang.Object

in.dragonbra.javasteam.base.AbstractMsgBase

Direct Known Subclasses:

GCMsgBase, MsgBase

public abstract class AbstractMsgBase
extends java.lang.Object

This class provides a payload backing to client messages.

Field Summary

Fields

Modifier and Type	Field	Description
protected MemoryStream	payload

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MemoryStream	getPayload()
byte	readByte()
byte[]	readBytes(int numBytes)
double	readDouble()
float	readFloat()
int	readInt()
long	readLong()
java.lang.String	readNullTermString()
java.lang.String	readNullTermString(java.nio.charset.Charset charset)
short	readShort()
long	seek(long offset, SeekOrigin seekOrigin)	Seeks within the payload to the specified offset.
void	write(byte data)
void	write(byte[] data)
void	write(double data)
void	write(float data)
void	write(int data)
void	write(long data)
void	write(short data)
void	write(java.lang.String data)
void	write(java.lang.String data, java.nio.charset.Charset charset)
void	writeNullTermString(java.lang.String data)
void	writeNullTermString(java.lang.String data, java.nio.charset.Charset charset)

Methods inherited from class java.lang.Object

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

Field Detail

payload

protected MemoryStream payload

Constructor Detail

AbstractMsgBase

public AbstractMsgBase()

Initializes a new instance of the AbstractMsgBase class.

AbstractMsgBase

public AbstractMsgBase(int payloadReserve)

Initializes a new instance of the AbstractMsgBase class.

Parameters:

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

Method Detail

seek

public long seek(long offset,
                 SeekOrigin seekOrigin)

Seeks within the payload to the specified offset.

Parameters:

offset - The offset in the payload to seek to.

seekOrigin - The origin to seek from.

Returns:

The new position within the stream, calculated by combining the initial reference point and the offset.

write

public void write(byte data)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(short data)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(int data)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(long data)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(byte[] data)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(float data)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(double data)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(java.lang.String data)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(java.lang.String data,
                  java.nio.charset.Charset charset)
           throws java.io.IOException

Throws:

java.io.IOException

writeNullTermString

public void writeNullTermString(java.lang.String data)
                         throws java.io.IOException

Throws:

java.io.IOException

writeNullTermString

public void writeNullTermString(java.lang.String data,
                                java.nio.charset.Charset charset)
                         throws java.io.IOException

Throws:

java.io.IOException

readByte

public byte readByte()
              throws java.io.IOException

Throws:

java.io.IOException

readBytes

public byte[] readBytes(int numBytes)
                 throws java.io.IOException

Throws:

java.io.IOException

readShort

public short readShort()
                throws java.io.IOException

Throws:

java.io.IOException

readInt

public int readInt()
            throws java.io.IOException

Throws:

java.io.IOException

readLong

public long readLong()
              throws java.io.IOException

Throws:

java.io.IOException

readFloat

public float readFloat()
                throws java.io.IOException

Throws:

java.io.IOException

readDouble

public double readDouble()
                  throws java.io.IOException

Throws:

java.io.IOException

readNullTermString

public java.lang.String readNullTermString()
                                    throws java.io.IOException

Throws:

java.io.IOException

readNullTermString

public java.lang.String readNullTermString(java.nio.charset.Charset charset)
                                    throws java.io.IOException

Throws:

java.io.IOException

getPayload

public MemoryStream getPayload()