Skip to content
This repository

A synonym for node. An evented framework for Common Lisp with API inspiration taken liberally from Node.js

tag: v0.0.1

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 examples
Octocat-spinner-32 make
Octocat-spinner-32 src
Octocat-spinner-32 vendor
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .gitmodules [zmq-socket] ZMQ dep and patches April 23, 2012
Octocat-spinner-32 LICENSE
Octocat-spinner-32 Makefile [master] Make scaffold + ev submod March 18, 2012
Octocat-spinner-32 README.md
Octocat-spinner-32 hinge.asd
README.md

Hinge. A synonym for node.

An evented framework for Common Lisp. Driven by libev, like the cool kids.

Requirements

System level dependencies

Dependencies built outside of quicklisp

These deps are fetched and built with make develop

Concepts and Principles

Event emitters

As introduced and described in the Node.js docs. Event emitters allow you to emit an event named by a string with some parameters and have a chain of callbacks invoked that are expecting that event with the parameters.

The events of hinge are sent and delivered asyncronously so that a long chain of event subscribers will not block the event machine execution.

TCP Servers and Clients

Modeled after the Node.js net.* APIs, provides event emitting classes that abstract network communication to a set of emitted "data" events and a write scheduler that allows IO to be deferred until the socket is ready.

ZMQ Sockets

Wrapped around the implementations of the TCP Socket and Server classes allow the delivery of ZeroMQ messages as emitted "data" events and allows the handling of blocking ZeroMQ socket sends with a callback.

Async parallel work pool(s) with calling-thread-local, event-friendly result callbacks

Allows the submission of work with bound callbacks for the successfull or failed execution of a set of forms in a thead pool. The result or error will be delivered asynchronously to the thread controlling the event loop while the work will be evaluated outside of it.

TODO

Multipart ZeroMQ messages are not supported. They deserve minor special treatment.

The ZeroMQ sockets currently require access to the sock slot to perform non-IO operations such as setting socket options. This is not permanent.

There are some example codes in the examples directory of the project root that have been used to develop the concepts they demonstrate with some comments. They might serve to make some more sense out of how this project could be applied.

Quickstart

Clone and init the project

# Clone the repo
$ git clone https://github.com/sshirokov/hinge.git
$ cd hinge

# Init the enviornment
$ make develop

Once you run make develop you're free to use Hinge in other Lisp systems as long as you don't relocate the project directory.

Fire up the REPL and evaluate the following. It should boot up and keep running an HTTP server on port 4545

(ql:quickload :hinge)
(defpackage :hinge-example
  (:use :cl :hinge :hinge.http))

(in-package :hinge-example)

(let ((server (make-instance 'http-server)))
  (add-listener server "request"
                (lambda (request response)
                  (declare (ignorable request))
                  (write-head response 200 '(("Content-Type" . "text/html")))
                  (end response "Hello world!")))

  (bind server 4545))

(run :default)

You should now be able to throw HTTP requests at localhost:4545 with something like curl and get replies:

$ time curl -i localhost:4545
HTTP/1.1 200 OK
Content-Length: 12
Content-Type: text/html

Hello world!
real    0m0.006s
user    0m0.004s
sys 0m0.000s

You can also throw something like ab at it, which is somewhat mandatory despite being a poor benchmark:

$ ab -c 10 -n 1000 http://localhost:4545/
This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking localhost (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Completed 600 requests
Completed 700 requests
Completed 800 requests
Completed 900 requests
Completed 1000 requests
Finished 1000 requests


Server Software:
Server Hostname:        localhost
Server Port:            4545

Document Path:          /
Document Length:        12 bytes

Concurrency Level:      10
Time taken for tests:   0.397 seconds
Complete requests:      1000
Failed requests:        0
Write errors:           0
Total transferred:      51000 bytes
HTML transferred:       12000 bytes
Requests per second:    2519.51 [#/sec] (mean)
Time per request:       3.969 [ms] (mean)
Time per request:       0.397 [ms] (mean, across all concurrent requests)
Transfer rate:          125.48 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:        0    0   0.0      0       0
Processing:     2    3   9.7      3     214
Waiting:        1    2   9.6      2     213
Total:          2    3   9.7      3     214

Percentage of the requests served within a certain time (ms)
  50%      3
  66%      3
  75%      3
  80%      3
  90%      3
  95%      3
  98%      4
  99%      5
 100%    214 (longest request)
Something went wrong with that request. Please try again.