Package uk.ac.manchester.spinnaker.messages.notification

Class DatabaseConfirmation

java.lang.Object

uk.ac.manchester.spinnaker.messages.notification.AbstractNotificationMessage

uk.ac.manchester.spinnaker.messages.notification.DatabaseConfirmation

All Implemented Interfaces:

NotificationMessage, SerializableMessage

public class DatabaseConfirmation
extends AbstractNotificationMessage

Message which contains the path to the job description database created by the toolchain which is to be used by any software which interfaces with SpiNNaker.

Field Summary

Fields

Modifier and Type	Field	Description
String	databasePath	The path to the database, as seen by the sender's filesystem.

Constructor Summary

Constructors

Constructor	Description
DatabaseConfirmation()	Create a message without a database path in it.
DatabaseConfirmation(String databasePath)	Create a message with a database path in it.

Method Summary

Modifier and Type	Method	Description
void	addToBuffer(ByteBuffer buffer)	Writes this message into the given buffer as a contiguous range of bytes.

Methods inherited from class uk.ac.manchester.spinnaker.messages.notification.AbstractNotificationMessage

build

Methods inherited from class java.lang.Object

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

Field Details

databasePath

public final String databasePath

The path to the database, as seen by the sender's filesystem. Note that there is a length limit; the overall message must fit in a UDP message.

Constructor Details

DatabaseConfirmation

public DatabaseConfirmation()

Create a message without a database path in it. This is used to acknowledge that the job database has been read and say that the listening software is ready for the simulation to start.

DatabaseConfirmation

public DatabaseConfirmation(String databasePath)

Create a message with a database path in it.

Parameters:

databasePath - The path.

Method Details

addToBuffer

public void addToBuffer(ByteBuffer buffer)

Description copied from interface: SerializableMessage

Writes this message into the given buffer as a contiguous range of bytes. This is so that a message can be sent. Implementors may assume that the buffer has been configured to be little-endian and that its position is at the point where they should begin writing. Once it has finished, the position should be immediately after the last byte written by this method.

Calling this method should not update the internal state of the message. It should be possible to add the message to multiple buffers without special precautions by the caller.

Specified by:

addToBuffer in interface SerializableMessage

Overrides:

addToBuffer in class AbstractNotificationMessage

Parameters:

buffer - The buffer to write into.