Skip to content

Latest commit

 

History

History
125 lines (84 loc) · 5.05 KB

Instructions.md

File metadata and controls

125 lines (84 loc) · 5.05 KB
Raw

Vert.x for Ceylon

Vert.x is a lightweight, high performance application platform for the JVM that's designed for modern mobile, web, and enterprise applications.

The original Vert.x documentation explains how to use Vert.x. This Ceylon module is a port of the Vert.x API to Ceylon, with this API you can:

  • Embed Vert.x in a Ceylon application
  • Use the Vert.x API
  • Verticles are not covered by this API but are managed by the io.vertx.ceylon.platform Ceylon module.

Installation

We suppose $VERTX_HOME points to Vert.x 2.x. Edit $VERTX_HOME/conf/langs.properties lang configuration:

  • declare the Ceylon Verticle Factory with ceylon=io.vertx~lang-ceylon~1.0.1:org.vertx.ceylon.platform.impl.CeylonVerticleFactory
  • declare the file mapping with .ceylon=ceylon

Running a Verticle

Running a Verticle is very easy to achieve and it can be done in several ways.

from a Verticle source

Create a new HelloWorldServer.ceylon source file:

import io.vertx.ceylon.platform { Verticle, Container }
import io.vertx.ceylon.core { Vertx }
import io.vertx.ceylon.core.http { HttpServerRequest }

shared class HelloWorldServer() extends Verticle() {

  shared actual void start(Vertx vertx, Container container) {
    vertx.createHttpServer().requestHandler(void (HttpServerRequest req) {
      req.response.headers { "Content-Type" -> "text/plain" };
      req.response.end("Hello World");
    }).listen(8080);
  }
}

Run this file with the vertx command:

% vertx run HelloWorldServer.ceylon
Module io.vertx~lang-ceylon~1.0.1 successfully installed
Create temporary source path /var/folders/79/mjy6k9xs6l74_cf_zjg8klgc0000gn/T/vertx4695595712845187618ceylon for /Users/julien/java/mod-lang-ceylon/src/examples/ceylon/examples/httphelloworld/HelloWorldServer.ceylon
Compiled module app878754/1.0.0
Succeeded in deploying verticle

from a Ceylon module containing a Verticle

This mode compiles and runs an entire Vert.x module written in Ceylon:

From the previous example, create a directory named httpserververticle and move the HelloWorldServer.ceylon in this folder.

Add a module descriptor module.ceylon:

module httpserververticle "1.0.0" {
  shared import "io.vertx.ceylon" "1.0.0";
}

Add package descriptor package.ceylon::

shared package httpserververticle;

Now at the root of the module source we run the Ceylon module file:

% vertx run httpserververticle/module.ceylon
Compiled module httpserververticle/1.0.0
Succeeded in deploying verticle

A precompiled Verticle

In the previous examples, Vert.x was compiling the module for you, mod-lang-ceylon can also run compiled modules from your Ceylon repository. This means you have compiled this module with the ceylon compile command or Ceylon IDE and installed it in your user repository $HOME/.ceylon:

vertx run ceylon:httpserververticle/1.0.0
Succeeded in deploying verticle

Specifying the main Verticle

A failure will occur when a module contains several verticle instances, because there is an ambiguity about the Verticle to use. A Verticle can deploy other Verticles, so it is valid to have several Verticle, in such situation the io.vertx.ceylon.platform.main annotation can be used to specify the main verticle of this module:

import io.vertx.ceylon.platform { main }

main(`class MainVerticle`)
module myapp "1.0.0" {
  shared import "io.vertx.ceylon.platform" "1.0.0";
}

Deployment options

When running a module, options can be specified, mod-lang-ceylon defines two configuration options:

  • systemRepo: provide an explicit system repository and overrides the default system repository contained in mod-lang-ceylon
  • userRepo: provide an explicit user repository where Ceylon stores compiled modules or look for existing modules, when such repository does not exist, mod-lang-ceylon will create a temporary repository
  • verbose: activate Ceylon verbose option, useful for debugging
  • mainVerticle: specify a Verticle to deploy, usually used when you deploy a module that could contain several verticles. This will override any main annotation

Creating a module

A module is a Ceylon verticle packaged in a zip file with a mod.json descriptor at the root of the zip. Usually a module packages the various libraries required by the module in a lib directory. Ceylon has its own module system and works best with it, therefore for Ceylon only the mod.json file is required and its main entry should contain the name of the Ceylon module prefixed by ceylon, like the precompiled Verticle seen before.

{
   "main": "ceylon:httpserververticle/1.0.0"
}

Then you can run it:

% vertx runmod my~httpserververticle~1.0.0

This module will be resolved in the default module repository of the platform. The userRepo configuration can be used for resolving the module from this location instead, note this is specified at run time:

% echo '{ "userRepo":"/modules" }' > conf.json
% vertx runmod my~httpserververticle~1.0.0 -conf conf.json