ScalaVerticle

io.vertx.lang.scala.ScalaVerticle
See theScalaVerticle companion object
abstract class ScalaVerticle

Base class for verticle implementations.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def asJava: Verticle
def asyncStart: Future[Unit]

Start the verticle. This is called by Vert.x when the verticle instance is deployed. Don't call it yourself.

Start the verticle. This is called by Vert.x when the verticle instance is deployed. Don't call it yourself.

If your verticle does things in its startup which take some time then you can override this method and return a concurrent.Future completed with the start up is complete. Propagating a failure fails the deployment of the verticle

Attributes

Returns

a concurrent.Future, completed when the start up completes, or failed if the verticle cannot be started.

def asyncStop: Future[Unit]

Stop the verticle. This is called by Vert.x when the verticle instance is un-deployed. Don't call it yourself.

Stop the verticle. This is called by Vert.x when the verticle instance is un-deployed. Don't call it yourself.

If your verticle does things in its shut-down which take some time then you can override this method and return a concurrent.Future completed when the clean-up is complete.

Attributes

Returns

a concurrent.Future completed when the clean-up completes, or failed if the verticle cannot be stopped gracefully.

def config: JsonObject

Get the configuration of the verticle.

Get the configuration of the verticle.

This can be specified when the verticle is deployed.

Attributes

Returns

the configuration

def deploymentID: String

Get the deployment ID of the verticle deployment

Get the deployment ID of the verticle deployment

Attributes

Returns

the deployment ID

def init(vertx: Vertx, context: Context, verticle: AbstractVerticle): Unit

Initialise the verticle.

Initialise the verticle.

This is called by Vert.x when the verticle instance is deployed. Don't call it yourself.

Value parameters

context

the context of the verticle

vertx

the deploying Vert.x instance

Attributes

def start(): Unit

Start the verticle.

Start the verticle.

Attributes

def start(promise: Promise[Unit]): Unit

Start the verticle.

Start the verticle.

Attributes

def stop(): Unit

Stop the verticle.

Stop the verticle.

Attributes

def stop(promise: Promise[Unit]): Unit

Stop the verticle.

Stop the verticle.

Attributes

Deprecated methods

def processArgs: Buffer[String]

Get the arguments used when deploying the Vert.x process.

Get the arguments used when deploying the Vert.x process.

Attributes

Returns

the list of arguments

Deprecated

As of version 5, Vert.x is no longer tightly coupled to the CLI

Givens

Givens