Rivoreo Source Code Repositories
src.rivoreo.one / net / facil.io / d34c0de98537e715df88f19894c593eacfbbd1ca / . / docs / 0.6.x / facil.html
blob: c0e3a462f1a881aab1e0d428cb18fda2256c8372 [file] [log] [blame] [raw]
<!DOCTYPE html><html><head><meta charset="utf-8" /><meta content="IE=edge" http-equiv="X-UA-Compatible" /><meta content="width=device-width, initial-scale=1, maximum-scale=2.0, user-scalable=yes, minimal-ui=yes" name="viewport" /><title>facil.io - Core API</title><meta content="facil.io - Core API" name="description" /><link href="https://fonts.googleapis.com/css?family=Montserrat|Quicksand|Karla" rel="stylesheet" type="text/css" /><script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script><link href="/assets/styles/main.css" rel="stylesheet" type="text/css" /><script type="application/ld+json">{"@context":"http://schema.org","@type":"WebSite","url":"http://facil.io","name":"facil.io","description":"facil.io - a light web application framework in C, with support for HTTP, WebSockets and Pub/Sub out of the box.","keywords":"C, web, framework, websockets, websocket, realtime, real-time, easy","image":"http://facil.io/website/logo/facil-io.svg","author":[{"@type":"Person","name":"Bo (Myst)","url":"http://stackoverflow.com/users/4025095/myst","email":"bo(at)facil.io"}],"sourceOrganization":{"@context":"http://schema.org","@type":"Organization","name":"Plezi","url":"http://facil.io","description":"facil.io - a light web application framework in C, with support for HTTP, WebSockets and Pub/Sub out of the box.","logo":"http://facil.io/website/logo/facil-io.svg","image":"http://facil.io/website/logo/facil-io.svg","email":"bo(at)facil.io","member":[{"@type":"Person","name":"Bo (Myst)","url":"http://stackoverflow.com/users/4025095/myst","email":"bo(at)facil.io"}]}}</script><meta content="facil.io" name="apple-mobile-web-app-title" /><meta content="facil.io - the C Web Application Framework" name="application-name" /><meta content="#b91d47" name="msapplication-TileColor" /><meta content="/mstile-144x144.png" name="msapplication-TileImage" /><meta content="#ffffff" name="theme-color" /></head><body><a href="/" id="logo"></a><input id="show_nav" type="checkbox" /><nav id="top_nav"><ul><li><a href="/0.7.x/index">Latest Docs</a></li><li><a href="https://github.com/boazsegev/facil.io" target="_blank">Source Code</a></li><li><a href="javascript: change_themes();" id="theme">Night Theme</a></li></ul></nav><input id="show_sidebar" type="checkbox" /><nav id="side_bar"><h2 id="version-0-6-x"><a href="/0.6.x/index">Version 0.6.x</a></h2>
<ul>
<li><a href="/0.6.x/api">API Overview</a></li>
<li><a href="/0.6.x/modules">The Modules</a></li>
</ul>
<h3 id="core-api"><a href="/0.6.x/facil">Core API</a></h3>
<ul>
<li><a href="/0.6.x/defer">Event scheduling</a></li>
<li><a href="/0.6.x/evio">Low Level Polling</a></li>
<li><a href="/0.6.x/sock">Low Level Sockets</a></li>
<li><a href="/0.6.x/fio_mem">Memory Allocation</a></li>
</ul>
<h3 id="extensions">Extensions</h3>
<ul>
<li><a href="/0.6.x/http">HTTP</a></li>
<li><a href="/0.6.x/websockets">WebSockets</a></li>
<li><a href="/0.6.x/pubsub">Pub/Sub</a></li>
<li><a href="/0.6.x/fio_cli">CLI (command line)</a></li>
</ul>
<h3 id="the-fiobj-types"><a href="/0.6.x/fiobj">The FIOBJ types</a></h3>
<ul>
<li><a href="/0.6.x/fiobj_primitives">Primitives</a></li>
<li><a href="/0.6.x/fiobj_numbers">Numbers</a></li>
<li><a href="/0.6.x/fiobj_str">Strings</a></li>
<li><a href="/0.6.x/fiobj_ary">Array</a></li>
<li><a href="/0.6.x/fiobj_hash">HashMap</a></li>
<li><a href="/0.6.x/fiobj_json">JSON</a></li>
</ul>
<h3 id="core-types"><a href="/0.6.x/types">Core Types</a></h3>
<ul>
<li><a href="/0.6.x/fio_ary">C Arrays</a></li>
<li><a href="/0.6.x/fio_hashmap">C HashMap</a></li>
<li><a href="/0.6.x/fio_llist">Linked Lists</a></li>
</ul>
</nav><div id="md_container"><div class='toc'><ul>
<li>
<a href="#facil-io-a-dynamic-protocol-network-services-library">Facil.io - a dynamic protocol network services library</a>
<ul>
<li>
<a href="#core-concepts-and-a-quick-example">Core Concepts And A Quick Example</a>
<ul>
<li>
<a href="#the-protocol-how-network-services-communicate">The Protocol: How Network Services Communicate</a>
</li>
<li>
<a href="#more-documentation-coming-soon">More documentation coming soon.</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div><h1 id="facil-io-a-dynamic-protocol-network-services-library">Facil.io - a dynamic protocol network services library</h1>
<p><code>facil.h</code> is &quot;A Library (or mini-framework) for Dynamic Protocol based Network Services&quot;:</p>
<ul>
<li><p>A Library (or a mini framework): meaning, closer to the metal, abstracting only what is required for API simplicity, security, error protection and performance. <code>facil.io</code> doesn&#39;t enforce any external dependencies.</p></li>
<li><p>For Dynamic Protocol: meaning services can change protocols mid-stream. Example use-case would be the HTTP/1.1 upgrade request to Websockets or HTTP/2. HTTP/2 isn&#39;t supported just yet, but the current design is easily extendable.</p></li>
<li><p>Network services: meaning implementing client-server or peer2peer network applications, such as web applications, micro-services, etc&#39;.</p></li>
</ul>
<p><code>facil.h</code> utilizes <code>evio.h</code>, <code>defer.h</code> and <code>sock.h</code> to create a simple API wrapper around these minimalistic libraries and managing the &quot;glue&quot; that makes them work together for a whole that&#39;s greater than the sum of it&#39;s parts.</p>
<p>It&#39;s simple, it&#39;s awesome, and I love it. It&#39;s also open-source, MIT licensed and you can test it yourself ;-)</p>
<h2 id="core-concepts-and-a-quick-example">Core Concepts And A Quick Example</h2>
<p>facil.io aims to provide a simple API, so that developers can focus on developing their applications rather then learning new APIs.</p>
<p>However, server applications are not the simplest of beasts, so if you encounter some minor complexity, I hope this documentation can help elevate the situation.</p>
<h3 id="the-protocol-how-network-services-communicate">The Protocol: How Network Services Communicate</h3>
<p>By nature, network services implement higher layer protocols to communicate (higher then TCP/IP). The HTTP protocol is a common example.</p>
<p>Typically, server applications &quot;react&quot;, they read incoming data (known as a request), perform a task and send output (a response).</p>
<p>The base type to handle the demands of protocols is <code>protocol_s</code>. This is no more then a struct with information about the callbacks that should be invoked on network events (incoming data, disconnection etc&#39;).</p>
<p>Protocol object instances must be unique per connection, and so they are usually dynamically allocated.</p>
<pre><code class='highlight'><span class="k">typedef</span> <span class="k">struct</span> <span class="p">{</span>
<span class="k">const</span> <span class="kt">char</span> <span class="o">*</span><span class="n">service</span><span class="p">;</span> <span class="cm">/** A pointer / string to identify the protocol (i.e. "http"). */</span>
<span class="kt">void</span> <span class="p">(</span><span class="o">*</span><span class="n">on_data</span><span class="p">)(</span><span class="kt">intptr_t</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">protocol_s</span> <span class="o">*</span><span class="n">protocol</span><span class="p">);</span> <span class="cm">/** called when a data is available */</span>
<span class="kt">void</span> <span class="p">(</span><span class="o">*</span><span class="n">on_ready</span><span class="p">)(</span><span class="kt">intptr_t</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">protocol_s</span> <span class="o">*</span><span class="n">protocol</span><span class="p">);</span> <span class="cm">/** called when the socket is ready to be written to. */</span>
<span class="kt">void</span> <span class="p">(</span><span class="o">*</span><span class="n">on_shutdown</span><span class="p">)(</span><span class="kt">intptr_t</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">protocol_s</span> <span class="o">*</span><span class="n">protocol</span><span class="p">);</span> <span class="cm">/** called when the server is shutting down */</span>
<span class="kt">void</span> <span class="p">(</span><span class="o">*</span><span class="n">on_close</span><span class="p">)(</span><span class="n">protocol_s</span> <span class="o">*</span><span class="n">protocol</span><span class="p">);</span> <span class="cm">/** called after the connection was closed */</span>
<span class="kt">void</span> <span class="p">(</span><span class="o">*</span><span class="n">ping</span><span class="p">)(</span><span class="kt">intptr_t</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">protocol_s</span> <span class="o">*</span><span class="n">protocol</span><span class="p">);</span> <span class="cm">/** called when a connection's timeout was reached */</span>
<span class="kt">size_t</span> <span class="n">rsv</span><span class="p">;</span> <span class="cm">/** private metadata used by facil. */</span>
<span class="p">}</span> <span class="n">protocol_s</span><span class="p">;</span> <span class="c1">///*</span>
</code></pre>
<p>Protocol object instances should be initiated per connection, since <code>facil.io</code> uses a locking mechanism that prevents the same protocol object from running it&#39;s callbacks concurrently.</p>
<p>By reviewing the HTTP and Websocket examples in the facil.io codebase, it&#39;s easy to see that the <code>protocol_s</code> &quot;class&quot; can be easily extended to add more data / features that might be required. &quot;C&quot; objects can use a typecasting style of inheritance which comes very handy when implementing network protocols.</p>
<hr>
<h3 id="more-documentation-coming-soon">More documentation coming soon.</h3>
<p>For now, the comments in the header files should provide great documentation and they can be used with Doxygen (or any documentation creation tool).</p>
</div><a href="/" id="sign"></a><div class="hidden" id="notice"><a class="notice_close" onclick="hide_notice()">X</a><div id="notice_text"></div></div><script>function change_themes() {
if(localStorage.getItem("theme") == 'dark') {
localStorage.setItem("theme", "light");
} else {
localStorage.setItem("theme", "dark");
}
$('body')[0].className = localStorage.getItem("theme");
set_theme_link();
$('#show_nav').attr('checked', false);
return false;
};
function sidebar_name() { return window.location.pathname.slice(0, window.location.pathname.lastIndexOf("/")); }
function on_sidebar_link(e) {
sessionStorage.setItem("sidebar.expect", sidebar_name());
sessionStorage.setItem("sidebar.pos", document.getElementById("side_bar").scrollTop);
}
function load_sidebar_pos() {
var e = document.getElementById("side_bar");
if(!e) {
console.warn("No sidebar detected");
return;
}
var expect = sidebar_name();
if(sessionStorage.getItem("sidebar.expect") == expect) {
e.scrollTo(0, parseInt(sessionStorage.getItem("sidebar.pos")));
} else {
sessionStorage.setItem("sidebar.expect", false);
sessionStorage.setItem("sidebar.pos", 0);
}
if(e) {
// add link callbacks
var links = document.links;
var count = links.length;
for (var i = 0; i < count; i++) {
var href = links[i].href;
if(href.startsWith(document.location.origin)) {
href = href.slice(document.location.origin.length);
}
if(href.startsWith(expect)) {
/* add link event */
links[i].addEventListener("click", on_sidebar_link);
}
}
}
};
load_sidebar_pos();
function set_theme_link() {
$("#theme").html( ( (localStorage.getItem("theme") == 'dark') ? "Day" : "Night") + " Theme" );
}
$('body')[0].className = (localStorage.getItem("theme") == 'dark') ? "dark" : "light";
set_theme_link();
function show_notice() { document.getElementById("notice").classList.remove('hidden'); };
function hide_notice() { document.getElementById("notice").classList.add('hidden'); };
$('#toc').on("touchstart", function (e) { return true; } );
$('#toc').on("hover", function (e) { return true; } );
// hljs.initHighlighting();
// Google Analytics
// if(location.hostname != "localhost") {
// (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
// (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
// m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
// })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
// ga('create', 'UA-69931401-1', 'auto');
// ga('send', 'pageview');
// }</script></body></html>