rescuecore2.messages

Interface Message

All Known Subinterfaces:

Command, Control

All Known Implementing Classes:

AbstractCommand, AbstractMessage, AKAcknowledge, AKClear, AKClearArea, AKConnect, AKExtinguish, AKLoad, AKMove, AKRescue, AKRest, AKSay, AKSpeak, AKSubscribe, AKTell, AKUnload, EntityIDRequest, EntityIDResponse, GKConnectError, GKConnectOK, KAConnectError, KAConnectOK, KASense, KGAcknowledge, KGConnect, KSAfterShocksInfo, KSCommands, KSConnectError, KSConnectOK, KSUpdate, KVConnectError, KVConnectOK, KVTimestep, Shutdown, SKAcknowledge, SKConnect, SKUpdate, VKAcknowledge, VKConnect

public interface Message

The top-level interface for messages that are sent between simulator components.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getURN() Get the urn of this message type.
void	read(java.io.InputStream in) Read the content of this message from a stream.
void	write(java.io.OutputStream out) Write the content of this message to a stream.

Method Detail

getURN

java.lang.String getURN()

Get the urn of this message type.

Returns:

The message urn.

write

void write(java.io.OutputStream out)
    throws java.io.IOException

Write the content of this message to a stream. The content should not include the message type ID.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - If the write fails.

read

void read(java.io.InputStream in)
   throws java.io.IOException

Read the content of this message from a stream. The content should not include the message type ID.

Parameters:

in - The stream to read from.

Throws:

java.io.IOException - If the read fails.