org.vertx.scala.platform

Container

final class Container extends AnyVal

This class represents a Verticle's view of the container in which it is running.

An instance of this class will be created by the system and made available to a running Verticle.

It contains methods to programmatically deploy other verticles, undeploy verticles, deploy modules, get the configuration for a verticle and get the logger for a verticle, amongst other things.

Linear Supertypes
AnyVal, NotNull, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Container
  2. AnyVal
  3. NotNull
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  2. final def ##(): Int

    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. val asJava: java.platform.Container

  6. def config(): JsonObject

    Get the verticle configuration

    Get the verticle configuration

    returns

    a JSON object representing the configuration

  7. def deployModule(name: String, config: JsonObject = Json.emptyObj(), instances: Int = 1, handler: (AsyncResult[String]) ⇒ Unit = ar: AsyncResult[String] =>): Unit

    Deploy a module programmatically

    Deploy a module programmatically

    name

    The main of the module to deploy

    config

    JSON config to provide to the module

    instances

    The number of instances to deploy (defaults to 1)

    handler

    The handler will be called passing in the unique deployment id when deployment is complete

  8. def deployVerticle(name: String, config: JsonObject = Json.emptyObj(), instances: Int = 1, handler: (AsyncResult[String]) ⇒ Unit = ar: AsyncResult[String] =>): Unit

    Deploy a verticle programmatically

    Deploy a verticle programmatically

    name

    The main of the verticle

    config

    JSON config to provide to the verticle

    instances

    The number of instances to deploy (defaults to 1)

    handler

    The handler will be called passing in the unique deployment id when deployment is complete

  9. def deployWorkerVerticle(name: String, config: JsonObject = Json.emptyObj(), instances: Int = 1, multiThreaded: Boolean = false, handler: (AsyncResult[String]) ⇒ Unit = ar: AsyncResult[String] =>): Unit

    Deploy a worker verticle programmatically

    Deploy a worker verticle programmatically

    name

    The main of the verticle

    config

    JSON config to provide to the verticle (defaults to empty JSON)

    instances

    The number of instances to deploy (defaults to 1)

    multiThreaded

    if true then the verticle will be deployed as a multi-threaded worker (default is false)

    handler

    The handler will be called passing in the unique deployment id when deployment is complete

  10. def env(): Map[String, String]

    Get an umodifiable map of system, environment variables.

    Get an umodifiable map of system, environment variables.

    returns

    The map

  11. def exit(): Unit

    Cause the container to exit

  12. def getClass(): Class[_ <: AnyVal]

    Definition Classes
    AnyVal → Any
  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  14. def logger(): Logger

    Get the verticle logger

    Get the verticle logger

    returns

    The logger

  15. def toString(): String

    Definition Classes
    Any
  16. def undeployModule(deploymentID: String, handler: () ⇒ Unit): Unit

    Undeploy a module

    Undeploy a module

    deploymentID

    The deployment ID

    handler

    The handler will be called when undeployment is complete

  17. def undeployVerticle(deploymentID: String, handler: () ⇒ Unit): Unit

    Undeploy a module

    Undeploy a module

    deploymentID

    The deployment ID

    handler

    The handler will be called when undeployment is complete

Inherited from AnyVal

Inherited from NotNull

Inherited from Any

Ungrouped