Classes and services to configure the server

The classes of interest are VirtualHost, Interface, Route and Action

Introduced classes

abstract class Action

nitcorn :: Action

Action executed to answer a request
class Interface

nitcorn :: Interface

An interface composed of a name:port
class Interfaces

nitcorn :: Interfaces

A list of interfaces with dynamic port listeners
class Route

nitcorn :: Route

A route to an Action according to a path
class Routes

nitcorn :: Routes

A list of routes with the search method []
class ServerConfig

nitcorn :: ServerConfig

Server instance configuration
class VirtualHost

nitcorn :: VirtualHost

A VirtualHost configuration
class VirtualHosts

nitcorn :: VirtualHosts

A list of virtual hosts with dynamic port listeners

All class definitions

abstract class Action

nitcorn $ Action

Action executed to answer a request
class Interface

nitcorn $ Interface

An interface composed of a name:port
class Interfaces

nitcorn $ Interfaces

A list of interfaces with dynamic port listeners
class Route

nitcorn $ Route

A route to an Action according to a path
class Routes

nitcorn $ Routes

A list of routes with the search method []
class ServerConfig

nitcorn $ ServerConfig

Server instance configuration
class VirtualHost

nitcorn $ VirtualHost

A VirtualHost configuration
class VirtualHosts

nitcorn $ VirtualHosts

A list of virtual hosts with dynamic port listeners
package_diagram nitcorn::server_config server_config core core nitcorn::server_config->core nitcorn::vararg_routes vararg_routes nitcorn::vararg_routes->nitcorn::server_config nitcorn::sessions sessions nitcorn::sessions->nitcorn::server_config nitcorn::reactor reactor nitcorn::reactor->nitcorn::vararg_routes nitcorn::reactor... ... nitcorn::reactor...->nitcorn::reactor nitcorn::file_server file_server nitcorn::file_server->nitcorn::sessions nitcorn::file_server... ... nitcorn::file_server...->nitcorn::file_server

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 bitset

core :: bitset

Services to handle BitSet
module bytes

core :: bytes

Services for byte streams and arrays
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 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 iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O
module kernel

core :: kernel

Most basic classes and methods.
module list

core :: list

This module handle double linked lists
module math

core :: math

Mathematical operations
module native

core :: native

Native structures for text and bytes
module numeric

core :: numeric

Advanced services for Numeric types
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 ropes

core :: ropes

Tree-based representation of a String.
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 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 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

Parents

module core

core :: core

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

Children

module sessions

nitcorn :: sessions

Automated session management
module vararg_routes

nitcorn :: vararg_routes

Routes with parameters.

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 file_server

nitcorn :: file_server

Provides the FileServer action, which is a standard and minimal file server
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 loader

github :: loader

module log

nitcorn :: log

Services inserting a timestamp in all prints and to log each requests
module nitcorn

nitcorn :: nitcorn

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

nitcorn :: nitcorn_hello_world

Hello World Web server example
module nitcorn_reverse_proxy

nitcorn :: nitcorn_reverse_proxy

Minimal example using a ProxyAction
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_routes

popcorn :: pop_routes

Internal routes representation.
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 proxy

nitcorn :: proxy

Provides the ProxyAction action, which redirects requests to another interface
module pthreads

nitcorn :: pthreads

Activate the use of pthreads with nitcorn
module reactor

nitcorn :: reactor

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

nitcorn :: restful

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

nitcorn :: restful_annot

Example for the restful annotation documented at lib/nitcorn/restful.nit
module signal_handler

nitcorn :: signal_handler

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

nitcorn :: simple_file_server

Basic file server on port 80 by default, may require root to execute
# Classes and services to configure the server
#
# The classes of interest are `VirtualHost`, `Interface`, `Route` and `Action`
module server_config

# Server instance configuration
class ServerConfig
	# `VirtualHost`s served by this server
	var virtual_hosts = new VirtualHosts(self)

	# Default `VirtualHost` to respond to requests not handled by any of the `virtual_hosts`
	var default_virtual_host: nullable VirtualHost = null is writable
end

# A `VirtualHost` configuration
class VirtualHost
	# Back reference to the associated server configuration
	var server_config: nullable ServerConfig = null

	# Interfaces on which `self` is active
	var interfaces = new Interfaces(self)

	# Routes and thus `Action`s active on `self`
	var routes = new Routes(self)

	# Create a virtual host from interfaces as strings
	init(interfaces: String ...) is old_style_init do
		for i in interfaces do self.interfaces.add_from_string i
	end
end

# An interface composed of a `name`:`port`
class Interface
	# Name of this interface (such as "localhost", "example.org", etc.)
	var name: String

	# The port to open
	var port: Int

	redef fun to_s do return "{name}:{port}"
end

# A route to an `Action` according to a `path`
class Route
	# Path to this action present in the URI
	var path: nullable String

	init
	do
		var path = path
		if path != null then self.path = "/" / path
	end

	# `Action` to activate when this route is traveled
	var handler: Action
end

# Action executed to answer a request
abstract class Action
end

### Intelligent lists ###

# A list of interfaces with dynamic port listeners
class Interfaces
	super Array[Interface]

	# Back reference to the associtated `VirtualHost`
	var virtual_host: VirtualHost

	# Add an `Interface` described by `text` formatted as `interface.name.com:port`
	fun add_from_string(text: String)
	do
		assert text.chars.count(':') <= 1

		var words = text.split(':')
		var name = words[0]
		var port
		if words.length > 1 then
			port = words[1].to_i
		else port = 80

		add new Interface(name, port)
	end
end

# A list of virtual hosts with dynamic port listeners
class VirtualHosts
	super Array[VirtualHost]

	# Back reference to the server config
	var config: ServerConfig

	redef fun add(e)
	do
		super

		e.server_config = config
	end
end

# A list of routes with the search method `[]`
class Routes
	# Back reference to the config of the virtual host
	var config: VirtualHost

	# Internal routes array.
	protected var routes = new Array[Route]

	# Add `e` to `self`
	fun add(e: Route) do routes.add e

	# Remove `e` from `self`
	fun remove(e: Route) do routes.remove e

	# Get the first `Route` than has `key` as prefix to its path
	fun [](key: String): nullable Route
	do
		for route in routes do
			var path = route.path
			if path == null or key.has_prefix(path) then return route
		end
		return null
	end
end
lib/nitcorn/server_config.nit:17,1--141,3