rescuecore2.messages.control

Class KVConnectOK

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.control.KVConnectOK

All Implemented Interfaces:

Control, Message

public class KVConnectOK
extends AbstractMessage
implements Control

A message for signalling a successful connection to the kernel.

Constructor Summary

Constructors

Constructor and Description
KVConnectOK(java.io.InputStream in) A KVConnectOK message that populates its data from a stream.
KVConnectOK(int viewerID, int requestID, java.util.Collection<? extends Entity> allEntities, Config config) A populated KVConnectOK message.

Method Summary

Modifier and Type	Method and Description
Config	getConfig() Get the Config.
java.util.Collection<Entity>	getEntities() Get the entity list.
int	getRequestID() Get the request ID.
int	getViewerID() Get the viewer ID.

Methods inherited from class rescuecore2.messages.AbstractMessage

addMessageComponent, getComponents, getURN, read, toString, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface rescuecore2.messages.Message

getURN, read, write

Constructor Detail

KVConnectOK

public KVConnectOK(java.io.InputStream in)
            throws java.io.IOException

A KVConnectOK message that populates its data from a stream.

Parameters:

in - The InputStream to read.

Throws:

java.io.IOException - If there is a problem reading the stream.

KVConnectOK

public KVConnectOK(int viewerID,
                   int requestID,
                   java.util.Collection<? extends Entity> allEntities,
                   Config config)

A populated KVConnectOK message.

Parameters:

viewerID - The viewer ID.

requestID - The request ID.

allEntities - All Entities in the world.

config - The Config that the agent knows about.

Method Detail

getViewerID

public int getViewerID()

Get the viewer ID.

Returns:

The viewer ID.

getRequestID

public int getRequestID()

Get the request ID.

Returns:

The request ID.

getEntities

public java.util.Collection<Entity> getEntities()

Get the entity list.

Returns:

All entities in the world.

getConfig

public Config getConfig()

Get the Config.

Returns:

The viewer config.