li.cil.oc.api.network

Interface Message

public interface Message

This type is used to deliver messages sent in a component network.

We use an extra class to deliver messages to nodes to make the cancel logic more clear (returning a boolean can get annoying very fast).

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Stop further propagation of a broadcast message.
java.lang.Object[]	data() The values passed along in the message.
java.lang.String	name() The name of this message.
Node	source() The node that sent the message.

Method Detail

source

Node source()

The node that sent the message.

Returns:

the source node.

name

java.lang.String name()

The name of this message.

Returns:

the name of the message.

data

java.lang.Object[] data()

The values passed along in the message.

Returns:

the message data.

cancel

void cancel()

Stop further propagation of a broadcast message.

This can be used to stop further distributing messages when either serving a message to a specific address and there are multiple nodes with that address, or when serving a broadcast message.