net.kuujo.vertigo.component

Interface InstanceContext

All Superinterfaces:

Context<InstanceContext>, JsonSerializable, Observable<InstanceContext>

All Known Implementing Classes:

DefaultInstanceContext

public interface InstanceContext
extends Context<InstanceContext>

A component instance context which contains information regarding a specific component (module or verticle) instance within a network.

The instance context is the primary immutable configuration used by each instance of a component verticle or module to construct its input and output ports/connections. Note that the context is observable, and component instance observe the context for changes within the cluster in order to support runtime network configuration changes by automatically updating their input and output connections when the context changes.

Author:

Jordan Halterman

Method Summary

Methods

Modifier and Type	Method and Description
String	address() Returns the instance address.
<T extends ComponentContext> T	component() Returns the parent component context.
InputContext	input() Returns the instance input context.
int	number() Returns the instance number.
OutputContext	output() Returns the instance output context.
String	status() Returns the instance status address.

Methods inherited from interface net.kuujo.vertigo.util.Observable

notify, registerObserver, unregisterObserver

Method Detail

number

int number()

Returns the instance number.

Returns:

The instance number.

address

String address()

Returns the instance address.

This is simply a unique identifier used to identify the component across all networks.

Specified by:

address in interface Context<InstanceContext>

Returns:

The instance address.

status

String status()

Returns the instance status address.

The status address is used by the component instance to notify the network and other components within the network of its current status. This is used by the network manager to coordinate startup of components across a network.

Returns:

The instance status address.

input

InputContext input()

Returns the instance input context.

Returns:

The instance input context.

output

OutputContext output()

Returns the instance output context.

Returns:

The instance output context.

component

<T extends ComponentContext> T component()

Returns the parent component context.

Returns:

The parent component context.