Skip to content
Your high performance web application C framework
C Makefile C++ Other
Branch: master
Clone or download

Latest commit

Latest commit 063c9bb May 18, 2020


Type Name Latest commit message Commit time
Failed to load latest commit information.
docs docs May 18, 2020
examples house-keeping Jan 30, 2019
lib/facil less signals, more flags May 18, 2020
scripts pre-release (0.7.0-beta1) housekeeping Nov 13, 2018
tests docs Feb 2, 2019
.clang_complete WIP: mustache padding support Dec 7, 2018
.gitignore hmm... Jan 5, 2019
.gitmodules remove the submodule. Jul 21, 2016
.travis.yml add poll to CI Jan 30, 2019 docs May 18, 2020
CMakeLists.txt cleanup May 18, 2020 docs Feb 2, 2019
Doxyfile Commiting the remastered 0.7.0 to a branch Sep 10, 2018 docs Aug 6, 2018
LICENSE House-keeping Jan 2, 2019
NOTICE Fix links to examples Sep 13, 2019
makefile makefile: fix wrong order of 2>&1 Aug 28, 2019

GitHub Build Status Codacy Badge codecov is a C micro-framework for web applications. includes:

  • A fast HTTP/1.1 and Websocket static file + application server.
  • Support for custom network protocols for both server and client connections.
  • Dynamic types designed with web applications in mind (Strings, Hashes, Arrays etc').
  • Performant JSON parsing and formatting for easy network communication.
  • A pub/sub process cluster engine for local and Websocket pub/sub.
  • Optional connectivity with Redis. provides high performance TCP/IP network services to Linux / BSD (and macOS) by using an evented design (as well as thread pool and forking support) and provides an easy solution to the C10K problem.

You can read more about on the website.

Important to Note

The master branch on the git repo is the development branch and is likely to be broken at any given time (especially when working on major revisions, as I am at the moment).

Please select a release version for any production needs.

Who's running on

An HTTP example

#include "http.h" /* the HTTP extension */

// We'll use this callback in `http_listen`, to handles HTTP requests
void on_request(http_s *request);

// These will contain pre-allocated values that we will use often

// Listen to HTTP requests and start
int main(int argc, char const **argv) {
  // allocating values we use often
  HTTP_X_DATA = fiobj_str_new("X-Data", 6);
  // listen on port 3000 and any available network binding (NULL ==
  http_listen("3000", NULL, .on_request = on_request, .log = 1);
  // start the server
  facil_run(.threads = 1);
  // deallocating the common values

// Easy HTTP handling
void on_request(http_s *request) {
  http_set_cookie(request, .name = "my_cookie", .name_len = 9, .value = "data",
                  .value_len = 4);
  http_set_header(request, HTTP_HEADER_CONTENT_TYPE,
                  http_mimetype_find("txt", 3));
  http_set_header(request, HTTP_X_DATA, fiobj_str_new("my data", 7));
  http_send_body(request, "Hello World!\r\n", 14);

Using in your project

It's possible to either start a new project with or simply add it to an existing one. GNU make is the default build system and CMake is also supported. should be C99 compatible.

Starting a new project with

To start a new project using the framework, run the following command in the terminal (change appname to whatever you want):

 $ bash <(curl -s appname

You can review the script here. In short, it will create a new folder, download a copy of the stable branch, add some demo boiler plate code and run make clean (which is required to build the tmp folder structure).

Next, edit the makefile to remove any generic features you don't need, such as the DUMP_LIB feature, the DEBUG flag or the DISAMS disassembler and start development.

Credit to @benjcal for suggesting the script.

Notice: The master branch is the development branch. Please select the latest release tag for the latest stable release version.

Adding to an existing project is a source code library, so it's easy to copy the source code into an existing project and start using the library right away.

The make libdump command will dump all the relevant files in a single folder called libdump, and you can copy them all or divide them into header ands source files.

It's also possible to compile the library separately using the make lib command.

Using as a CMake submodule also supports both git and CMake submodules. Credit to @OwenDelahoy (PR#8).

First, add the repository as a submodule using git:

git submodule add

Then add the following line the project's CMakeLists.txt


More Examples

The examples folder includes code examples for a telnet echo protocol, a Simple Hello World server, an example for Websocket pub/sub with (optional) Redis, etc'.

You can find more information on the website

Forking, Contributing and all that Jazz

The contribution guide can be found here.

Sure, why not. If you can add Solaris or Windows support to evio and sock, that could mean facil would become available for use on these platforms as well.

If you encounter any issues, open an issue (or, even better, a pull request with a fix) - that would be great :-)

Hit me up if you want to:

  • Write tests... I always need more tests...

  • Help me write HPACK / HTTP2 protocol support.

  • Help me design / write a generic HTTP routing helper library for the http_s struct.

  • If you want to help me write a new SSL/TLS library or have an SSL/TLS solution we can fit into facil (as source code)... Note: SSL/TLS solutions should fit both client and server modes.

  • If you want to help promote the library, that would be great as well. Perhaps publish benchmarks or share your story.

  • Writing documentation into the website would be great. I keep the source code documentation fairly updated, but the documentation should be copied to the docs folder to get the documentation website up and running.

You can’t perform that action at this time.