Vert.x clojure language module API documentation

vertx.embed.platform documentation

Functions for running Vert.x embedded with a platform manager.

Deploys the module with the given name to platform-manager.

Takes the following keyword arguments [default]:

:config     A configuration map for the module [{}]
:ha?        If true then the module is enabled for ha and will
            failover to any other vert.x instances with the
            same group in the cluster [false]
:handler    Either be a two-arity fn that will be passed
            the exception-map (if any) and module id from the
            result of the deploy call, or a
            org.vertx.java.core.Handler that will be
            called with the AsyncResult object that wraps
            the exception and id [nil]
:instances  The number of instances of the module to
            deploy [1]

Deploys a module from the classpath to platform-manager.
The classpath must contain a single mod.json and the resources for
that module only.

Takes the following keyword arguments [default]:

:classpath  The classpath to use for the verticle as a
            sequence of URLs ['()]
:config     A configuration map for the module [{}]
:handler    Either be a two-arity fn that will be passed
            the exception-map (if any) and module id from the
            result of the deploy call, or a
            org.vertx.java.core.Handler that will be
            called with the AsyncResult object that wraps
            the exception and id [nil]
:instances  The number of instances of the module to
            deploy [1]

Deploys the module from the given zip file to platform-manager.
The zip must contain a valid Vert.x module. Vert.x will
automatically install the module from the zip into the local mods
dir or the system mods dir (if it's a system module), or VERTX_MODS
if set, and then deploy the module.

Takes the following keyword arguments [default]:

:config     A configuration map for the module [{}]
:ha?        If true then the module is enabled for ha and will
            failover to any other vert.x instances with the
            same group in the cluster [false]
:handler    Either be a two-arity fn that will be passed
            the exception-map (if any) and module id from the
            result of the deploy call, or a
            org.vertx.java.core.Handler that will be
            called with the AsyncResult object that wraps
            the exception and id [nil]
:instances  The number of instances of the module to
            deploy [1]

Deploys the verticle with the given main file path using platform-manager.
main must be on the effective classpath.

Takes the following keyword arguments [default]:

:classpath  The classpath to use for the verticle as a
            sequence of URLs ['()]
:config     A configuration map for the verticle [{}]
:handler    Either be a two-arity fn that will be passed
            the exception (if any) and verticle id from the
            result of the deploy call, or a
            org.vertx.java.core.Handler that will be
            called with the AsyncResult object that wraps
            the exception and id [nil]
:includes   A sequence of modules to include [nil]
:instances  The number of instances of the verticle to
            deploy [1]

Deploys the worker verticle with the given main file path using platform-manager.
main must be on the effective classpath.

Takes the following keyword arguments [default]:

:classpath        The classpath to use for the verticle as a
                  sequence of URLs ['()]
:config           A configuration map for the verticle [{}]
:handler          Either be a two-arity fn that will be passed
                  the exception-map (if any) and verticle id from the
                  result of the deploy call, or a
                  org.vertx.java.core.Handler that will be
                  called with the AsyncResult object that wraps
                  the exception and id [nil]
:includes         A sequence of modules to include [nil]
:instances        The number of instances of the verticle to
                  deploy [1]
:multi-threaded?  When true, the verticle will be accessed
                  by multiple threads concurrently [false]

Downloads and installs the named module locally.
handler can either be a single-arity fn that will be passed the
exception (if any) from the result of the install call, or a
org.vertx.java.core.Handler that will be called with the
AsyncResult object that wraps the exception.

Returns a map of deployment ids to number of instances.

Create a fat executable jar which includes the Vert.x binaries and
the module so it can be run directly with java without having to
pre-install Vert.x. e.g.: java -jar mymod~1.0-fat.jar
handler can either be a single-arity fn that will be passed the
exception (if any) from the result of the call, or a
org.vertx.java.core.Handler that will be called with the
AsyncResult object that wraps the exception.

Register a handler that will be called when the platform exits.
handler can either be a zero-arity fn or a Handler instance.

Creates a platform manager.
cluster-port and cluster-host specify the port and host to use for
clustering, respectively. If not provided, clustering is disabled.
quorum-size specify the minimum number of nodes in the cluster
before deployments in this platform manager will be activated. If
not provided, ha is disabled. ha-group specifies the group name in
which this platform manager participates. If nil, "__DEFAULT__"
is used.

Pull in all the dependencies (the 'includes' and the 'deploys'
fields in mod.json) and copy them into an internal mods directory
in the module. This allows a self contained module to be created.
handler can either be a single-arity fn that will be passed the
exception (if any) from the result of the call, or a
org.vertx.java.core.Handler that will be called with the
AsyncResult object that wraps the exception.

Undeploys the deployment identified by id from platform-manager.
handler can either be a single-arity fn that will be passed the
exception (if any) from the result of the undeploy call, or a
org.vertx.java.core.Handler that will be called with the
AsyncResult object that wraps the exception.

Undeploys the all deployments from platform-manager.
handler can either be a single-arity fn that will be passed the
exception (if any) from the result of the undeploy call, or a
org.vertx.java.core.Handler that will be called with the
AsyncResult object that wraps the exception.

Removes the module from the local installation.
handler can either be a single-arity fn that will be passed the
exception (if any) from the result of the uninstall call, or a
org.vertx.java.core.Handler that will be called with the
AsyncResult object that wraps the exception.