uk.co.thomasc.steamkit.base

Interface IClientMsg

All Known Implementing Classes:

ClientMsg, ClientMsgProtobuf, Msg, MsgBase

public interface IClientMsg

Represents a unified interface into client messages.

Method Summary

Methods

Modifier and Type	Method and Description
void	deSerialize(byte[] data) Initializes this client message by deserializing the specified data.
EMsg	getMsgType() The message type.
int	getSessionID() The session id.
JobID	getSourceJobID() The source job id.
SteamID	getSteamID() The SteamID
JobID	getTargetJobID() The target job id.
boolean	isProto() True if this instance is protobuf backed; otherwise, false.
byte[]	serialize() serializes this client message instance to a byte array.
void	setSessionID(int sessionID)
void	setSourceJobID(JobID JobID)
void	setSteamID(SteamID SteamID)
void	setTargetJobID(JobID JobID)

Method Detail

isProto

boolean isProto()

True if this instance is protobuf backed; otherwise, false.

getMsgType

EMsg getMsgType()

The message type.

getSessionID

int getSessionID()

The session id.

setSessionID

void setSessionID(int sessionID)

getSteamID

SteamID getSteamID()

The SteamID

setSteamID

void setSteamID(SteamID SteamID)

getTargetJobID

JobID getTargetJobID()

The target job id.

setTargetJobID

void setTargetJobID(JobID JobID)

getSourceJobID

JobID getSourceJobID()

The source job id.

setSourceJobID

void setSourceJobID(JobID JobID)

serialize

byte[] serialize()
                 throws IOException

serializes this client message instance to a byte array.

Returns:

Data representing a client message.

Throws:

IOException

deSerialize

void deSerialize(byte[] data)
                 throws IOException

Initializes this client message by deserializing the specified data.

Parameters:

data - The data representing a client message.

Throws:

IOException