The nitcorn Web server framework creates server-side Web apps in Nit

The main classes are:

  • Action to answer to requests.
  • Route to represent a path to an action.
  • VirtualHost to listen on a specific interface and behave accordingly
  • HttpFactory which is the base dispatcher class.

Basic usage example:

class MyAction
    super Action

    redef fun answer(http_request, turi)
    do
        var response = new HttpResponse(200)
        response.body = """
<!DOCTYPE html>
<head>
    <meta charset="utf-8">
    <title>Hello World</title>
</head>
<body>
    <p>Hello World</p>
</body>
</html>"""
        return response
    end
end

# Listen to port 8080 on all interfaces
var vh = new VirtualHost("0.0.0.0:8080")

# Serve index.html with our custom handler
vh.routes.add new Route("/index.html", new MyAction)

# Serve everything else with a standard `FileServer`
vh.routes.add new Route(null, new FileServer("/var/www/"))

var factory = new HttpFactory.and_libevent
factory.config.virtual_hosts.add vh
factory.run

All class definitions

package_diagram nitcorn::nitcorn nitcorn nitcorn::file_server file_server nitcorn::nitcorn->nitcorn::file_server nitcorn::signal_handler signal_handler nitcorn::nitcorn->nitcorn::signal_handler nitcorn::reactor reactor nitcorn::file_server->nitcorn::reactor nitcorn::sessions sessions nitcorn::file_server->nitcorn::sessions nitcorn::media_types media_types nitcorn::file_server->nitcorn::media_types nitcorn::http_errors http_errors nitcorn::file_server->nitcorn::http_errors nitcorn::signal_handler->nitcorn::reactor ...nitcorn::reactor ... ...nitcorn::reactor->nitcorn::reactor ...nitcorn::sessions ... ...nitcorn::sessions->nitcorn::sessions ...nitcorn::media_types ... ...nitcorn::media_types->nitcorn::media_types ...nitcorn::http_errors ... ...nitcorn::http_errors->nitcorn::http_errors github::hooks hooks github::hooks->nitcorn::nitcorn popcorn::pop_routes pop_routes popcorn::pop_routes->nitcorn::nitcorn nitcorn::pthreads pthreads nitcorn::pthreads->nitcorn::nitcorn nitcorn::restful restful nitcorn::restful->nitcorn::nitcorn nitcorn::htcpcp_server htcpcp_server nitcorn::htcpcp_server->nitcorn::nitcorn nitcorn::nitcorn_hello_world nitcorn_hello_world nitcorn::nitcorn_hello_world->nitcorn::nitcorn nitcorn::simple_file_server simple_file_server nitcorn::simple_file_server->nitcorn::nitcorn a_star-m a_star-m a_star-m->github::hooks a_star-m->nitcorn::htcpcp_server a_star-m->nitcorn::nitcorn_hello_world a_star-m->nitcorn::simple_file_server a_star-m... ... a_star-m...->a_star-m popcorn::pop_handlers pop_handlers popcorn::pop_handlers->popcorn::pop_routes popcorn::pop_handlers... ... popcorn::pop_handlers...->popcorn::pop_handlers nitcorn::restful_annot restful_annot nitcorn::restful_annot->nitcorn::pthreads nitcorn::restful_annot->nitcorn::restful nitcorn::restful_annot... ... nitcorn::restful_annot...->nitcorn::restful_annot

Ancestors

module abstract_collection

core :: abstract_collection

Abstract collection classes and services.
module abstract_text

core :: abstract_text

Abstract class for manipulation of sequences of characters
module array

core :: array

This module introduces the standard array structure.
module base64

base64 :: base64

Offers the base 64 encoding and decoding algorithms
module bitset

core :: bitset

Services to handle BitSet
module bytes

core :: bytes

Services for byte streams and arrays
module caching

serialization :: caching

Services for caching serialization engines
module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.
module codec_base

core :: codec_base

Base for codecs to use with streams
module codecs

core :: codecs

Group module for all codec-related manipulations
module collection

core :: collection

This module define several collection classes.
module core

core :: core

Standard classes and methods used by default by Nit programs and libraries.
module engine_tools

serialization :: engine_tools

Advanced services for serialization engines
module environ

core :: environ

Access to the environment variables of the process
module error

core :: error

Standard error-management infrastructure.
module exec

core :: exec

Invocation and management of operating system sub-processes.
module file

core :: file

File manipulations (create, read, write, etc.)
module fixed_ints

core :: fixed_ints

Basic integers of fixed-precision
module fixed_ints_text

core :: fixed_ints_text

Text services to complement fixed_ints
module flat

core :: flat

All the array-based text representations
module gc

core :: gc

Access to the Nit internal garbage collection mechanism
module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.
module http_errors

nitcorn :: http_errors

Offers ErrorTemplate to display error pages
module http_request

nitcorn :: http_request

Provides the HttpRequest class and services to create it
module http_request_buffer

nitcorn :: http_request_buffer

Http request parsing for buffered inputs.
module http_response

nitcorn :: http_response

Provides the HttpResponse class and http_status_codes
module inspect

serialization :: inspect

Refine Serializable::inspect to show more useful information
module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O
module kernel

core :: kernel

Most basic classes and methods.
module libevent

libevent :: libevent

Low-level wrapper around the libevent library to manage events on file descriptors
module list

core :: list

This module handle double linked lists
module math

core :: math

Mathematical operations
module md5

md5 :: md5

Native MD5 digest implementation as Text::md5
module media_types

nitcorn :: media_types

Services to identify Internet media types (or MIME types, Content-types)
module meta

meta :: meta

Simple user-defined meta-level to manipulate types of instances as object.
module more_collections

more_collections :: more_collections

Highly specific, but useful, collections-related classes.
module native

core :: native

Native structures for text and bytes
module numeric

core :: numeric

Advanced services for Numeric types
module poset

poset :: poset

Pre order sets and partial order set (ie hierarchies)
module protocol

core :: protocol

module queue

core :: queue

Queuing data structures and wrappers
module range

core :: range

Module for range of discrete objects.
module re

core :: re

Regular expression support for all services based on Pattern
module reactor

nitcorn :: reactor

Core of the nitcorn project, provides HttpFactory and Action
module ropes

core :: ropes

Tree-based representation of a String.
module serialization

serialization :: serialization

General serialization services
module serialization_core

serialization :: serialization_core

Abstract services to serialize Nit objects to different formats
module server_config

nitcorn :: server_config

Classes and services to configure the server
module sessions

nitcorn :: sessions

Automated session management
module sorter

core :: sorter

This module contains classes used to compare things and sorts arrays.
module stream

core :: stream

Input and output streams of characters
module template

template :: template

Basic template system
module text

core :: text

All the classes and methods related to the manipulation of text entities
module time

core :: time

Management of time and dates
module token

nitcorn :: token

Simple generate_token service, independent of the rest of the nitcorn framework
module union_find

core :: union_find

union–find algorithm using an efficient disjoint-set data structure
module utf8

core :: utf8

Codec for UTF-8 I/O
module vararg_routes

nitcorn :: vararg_routes

Routes with parameters.

Parents

module file_server

nitcorn :: file_server

Provides the FileServer action, which is a standard and minimal file server
module signal_handler

nitcorn :: signal_handler

Handle SIGINT and SIGTERM to close the server after all active events

Children

module hooks

github :: hooks

Github hook event listening with nitcorn.
module htcpcp_server

nitcorn :: htcpcp_server

A server that implements HTCPCP. At the moment there are no additions.
module nitcorn_hello_world

nitcorn :: nitcorn_hello_world

Hello World Web server example
module pop_routes

popcorn :: pop_routes

Internal routes representation.
module pthreads

nitcorn :: pthreads

Activate the use of pthreads with nitcorn
module restful

nitcorn :: restful

Support module for the nitrestful tool and the restful annotation
module simple_file_server

nitcorn :: simple_file_server

Basic file server on port 80 by default, may require root to execute

Descendants

module a_star-m

a_star-m

module example_angular

popcorn :: example_angular

This is an example of how to use angular.js with popcorn
module loader

github :: loader

module pop_auth

popcorn :: pop_auth

Authentification handlers.
module pop_handlers

popcorn :: pop_handlers

Route handlers.
module pop_json

popcorn :: pop_json

Introduce useful services for JSON REST API handlers.
module pop_sessions

popcorn :: pop_sessions

Session handlers
module pop_tasks

popcorn :: pop_tasks

Popcorn threaded tasks
module pop_templates

popcorn :: pop_templates

Template rendering for popcorn
module pop_tests

popcorn :: pop_tests

Popcorn testing services
module popcorn

popcorn :: popcorn

Application server abstraction on top of nitcorn.
module restful_annot

nitcorn :: restful_annot

Example for the restful annotation documented at lib/nitcorn/restful.nit
# The nitcorn Web server framework creates server-side Web apps in Nit
#
# The main classes are:
# * `Action` to answer to requests.
# * `Route` to represent a path to an action.
# * `VirtualHost` to listen on a specific interface and behave accordingly
# * `HttpFactory` which is the base dispatcher class.
#
# Basic usage example:
# ~~~~
# class MyAction
#     super Action
#
#     redef fun answer(http_request, turi)
#     do
#         var response = new HttpResponse(200)
#         response.body = """
# <!DOCTYPE html>
# <head>
#     <meta charset="utf-8">
#     <title>Hello World</title>
# </head>
# <body>
#     <p>Hello World</p>
# </body>
# </html>"""
#         return response
#     end
# end
#
# # Listen to port 8080 on all interfaces
# var vh = new VirtualHost("0.0.0.0:8080")
#
# # Serve index.html with our custom handler
# vh.routes.add new Route("/index.html", new MyAction)
#
# # Serve everything else with a standard `FileServer`
# vh.routes.add new Route(null, new FileServer("/var/www/"))
#
# var factory = new HttpFactory.and_libevent
# factory.config.virtual_hosts.add vh
# factory.run
# ~~~~
module nitcorn

import reactor
import file_server
import sessions
import signal_handler
lib/nitcorn/nitcorn.nit:17,1--65,21