net.kuujo.vertigo.java

Class ComponentVerticle

java.lang.Object

org.vertx.java.platform.Verticle

net.kuujo.vertigo.java.ComponentVerticle

public abstract class ComponentVerticle
extends org.vertx.java.platform.Verticle

Base class for Java vertigo component verticle implementations.

To create a Vertigo component simply extend this base class.

 public class MyComponent extends ComponentVerticle {
 
   public void start() {
     output.port("out").send("Hello world!");
   }
 
 }
 

The component verticle works exactly the same way as all normal Vert.x verticles. When the {@link ComponentVerticle#start()} method is called, the the component and the network to which it belongs have been completely started, so it's perfectly fine to begin sending messages.

The component also contains a reference to the cluster in which the network is deployed. The cluster can be used to deploy additional modules or verticles or access cluster-wide shared data. For instance, if the network was deployed to a Xync cluster, the cluster will be a {@link net.kuujo.vertigo.cluster.HazelcastCluster} which can be used to access Hazelcast data structures.

The component also has a special logger which is a {@link net.kuujo.vertigo.io.logging.logger.PortLogger} that is specific to the component instance. The port logger will log any messages to the underlying Vert.x {@link org.vertx.java.core.logging.Logger} as well as the corresponding output port.

Author:

Jordan Halterman

Field Summary

Fields

Modifier and Type	Field and Description
protected Cluster	cluster
protected InstanceContext	context
protected InputCollector	input
protected org.vertx.java.core.logging.Logger	logger
protected OutputCollector	output
protected Vertigo	vertigo

Fields inherited from class org.vertx.java.platform.Verticle

container, vertx

Constructor Summary

Constructors

Constructor and Description
ComponentVerticle()

Method Summary

Methods

Modifier and Type	Method and Description
void	start(org.vertx.java.core.Future<Void> startResult)

Methods inherited from class org.vertx.java.platform.Verticle

getContainer, getVertx, setContainer, setVertx, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

vertigo

protected Vertigo vertigo

context

protected InstanceContext context

cluster

protected Cluster cluster

logger

protected org.vertx.java.core.logging.Logger logger

input

protected InputCollector input

output

protected OutputCollector output

Constructor Detail

ComponentVerticle

public ComponentVerticle()

Method Detail

start

public void start(org.vertx.java.core.Future<Void> startResult)

Overrides:

start in class org.vertx.java.platform.Verticle