Module io.ciera.runtime.api

Package io.ciera.runtime.api.domain

Interface Message

All Superinterfaces:

Comparable<Message>, Serializable

public interface Message
extends Comparable<Message>, Serializable

A message represents an asynchronous event sent across domain boundaries. A message has a unique identifier to mark which message it is as well as data items. Messages can be serialized and sent across a network interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static @interface	Message.Names
static @interface	Message.Types

Method Summary

Modifier and Type	Method	Description
static Message	fromString(Object s)
Object	get(String key)	Access the parameter datum at the specified index.
int	getId()	Get the message number for this message.
UniqueId	getMessageHandle()	Get the unique ID of this message instance.
String	getName()	Get the informal name of this message instance.
Map<String,Object>	getParameterData()
void	put(String key, Object value)

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

get

Object get(String key)

Access the parameter datum at the specified index.

Parameters:

index - The index at which to access the datum.

Returns:

The parameter datum.

put

void put(String key,
 Object value)

getParameterData

Map<String,Object> getParameterData()

getMessageHandle

UniqueId getMessageHandle()

Get the unique ID of this message instance.

Returns:

the message's unique ID.

getName

String getName()

Get the informal name of this message instance.

Returns:

The name of the message.

getId

int getId()

Get the message number for this message. This number uniquely identifies an abstract message in an interface.

fromString

static Message fromString(Object s)