li/cil/oc/api/INetworkMessage.java

package li.cil.oc.api;

/**
 * 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).
 */
public interface INetworkMessage {
  /**
   * The node that sent the message.
   * 
   * @return the source node.
   */
  INetworkNode getSource();

  /**
   * The name of this message.
   * 
   * @return the name of the message.
   */
  String getName();

  /**
   * The values passed along in the message.
   * 
   * @return the message data.
   */
  Object[] getData();

  /**
   * Stop further propagation of a broadcast message.
   * 
   * <p>
   * 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. (<tt>sendToAll</tt>).
   * </p>
   */
  void cancel();
}