0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-28 16:34:13 +01:00
construct/include/ircd
2018-01-22 00:54:51 -08:00
..
ctx ircd::ctx: Eliminate the shared_ptr in pool::async; minor cleanup. 2018-01-18 06:05:56 -08:00
db ircd::db: Split up / reorg database/env related. 2018-01-18 17:59:22 -08:00
fs ircd::fs: Simplify API/AIO by eliminating callback: ctx yield only for now. 2018-01-15 03:12:56 -08:00
js ircd: Rename ircd::scope to ircd::unwind. 2017-09-24 18:16:41 -07:00
json ircd::json: Add recursion depth checking. 2018-01-18 06:05:56 -08:00
m ircd:Ⓜ️ Rework/cleanup request/session related. 2018-01-20 13:58:24 -08:00
net ircd: Adjust some default timeouts. 2018-01-22 00:54:51 -08:00
server ircd::server: Add content buffer deduction from single in buffer. 2018-01-20 02:30:20 -08:00
util ircd::util: Fix bswap() to not rely on data()/size() et al. 2018-01-14 20:45:30 -08:00
.gitignore
allocator.h
array_view.h
asio.h ircd::net: Move acceptor into header; minor cleanup. 2018-01-19 06:55:48 -08:00
base.h ircd: Add Base58 support. 2018-01-22 00:54:51 -08:00
buffer.h ircd::buffer: Fix reverse iterations. 2018-01-20 13:59:24 -08:00
byte_view.h
client.h ircd: Adjust some default timeouts. 2018-01-22 00:54:51 -08:00
color.h ircd: Minor housekeeping fixes. 2018-01-12 03:22:57 -08:00
date.h ircd: Use address of ::gettimeofday to resolve error in g++-7. 2018-01-17 21:38:18 -08:00
ed25519.h
exception.h ircd: Utils for std::system_error related; minor cleanup. 2018-01-10 21:43:49 -08:00
fmt.h ircd::fmt: Add this overdue conversion. 2018-01-20 02:28:03 -08:00
hash.h
http.h ircd::http: Remove the URI composition from the http::request construction. 2018-01-20 02:29:03 -08:00
info.h ircd::info: Add additional line of information in debug log. 2018-01-17 21:38:17 -08:00
ios.h ircd: Expose utilities for boost errors. 2018-01-12 15:04:30 -08:00
iov.h
ircd.h fixup! Pin boost to 1.66.0. 2017-12-29 15:53:39 -07:00
js.h
lex_cast.h ircd: Split base64 from lexical. 2018-01-18 18:17:02 -08:00
localee.h
logger.h
Makefile.am
mapi.h
mods.h
nacl.h
openssl.h ircd::openssl: Add function to print subject of certificate. 2018-01-12 15:31:58 -08:00
params.h
parse.h
rand.h ircd: Minor housekeeping fixes. 2018-01-12 03:22:57 -08:00
README.md ircd: Update namespace list in include README. 2018-01-19 04:07:12 -08:00
resource.h ircd: Reorg client; add class members; pointer to current request; conf, etc. 2018-01-13 17:58:11 -08:00
rfc1035.h ircd: Add preliminary RFC1035 support. 2018-01-14 20:45:30 -08:00
rfc1459.h ircd: Minor cleanup of rfc1459 header. 2018-01-12 13:13:37 -08:00
rfc3986.h
spirit.h ircd::json: Add recursion depth checking. 2018-01-18 06:05:56 -08:00
stdinc.h ircd: Add Base58 support. 2018-01-22 00:54:51 -08:00
string_view.h
stringops.h ircd: Remove legacy stringops. 2018-01-19 02:47:08 -08:00
tokens.h
vector_view.h

IRCd Library API

Project Namespaces

  • IRCD_ Preprocessor #define and macro namespace.
  • RB_ Preprocessor #define and macro namespace (legacy / low-level).
  • ircd_ C namespace and demangled bindings.
  • ircd:: C++ namespace scope.
  • X-IRCd- HTTP header key namespace.
  • ircd. Matrix event type namespace.

What To Include

libircd headers are organized into several aggregates groups

As a C++ project there are a lot of header files. Header files depend on other header files. We don't expect the developer of a compilation unit to figure out an exact list of header files necessary to include for that unit. Instead we have aggregated groups of header files which are then precompiled. These aggregations are mostly oriented around a specific project dependency.

Note: The term 'stack' may be found in place of the preferred term 'group' in other documentation.

  • Standard Include group <ircd/ircd.h> is the main header group. This group involves the standard library and most of libircd. This is what an embedder will be working with. These headers will expose our own interfaces wrapping 3rd party dependencies which are not included there.

    There are actually two files in play here: <ircd/stdinc.h> and <ircd/ircd.h>. We have to offer two different pre-compilations: one with -fPIC and one without. Therefor the contents are in <ircd/stdinc.h> and the preprocessor determination for which is in <ircd/ircd.h>.

  • Boost ASIO include group <ircd/asio.h> is a header group exposing the boost::asio library. We only involve this header in compilation units working directly with asio for networking et al. Involving this header file slows down compilation compared with the standard group.

  • Boost Spirit include group <ircd/spirit.h> is a header group exposing the spirit parser framework to compilation units which involve formal grammars. Involving this header is a monumental slowdown when compiling.

  • JavaScript include group <ircd/js/js.h> is a header group exposing symbols from the SpiderMonkey JS engine. Alternatively, <ircd/js.h> is part of the standard include group which includes any wrapping to hide SpiderMonkey.

  • MAPI include group <ircd/mapi.h> is the standard header group for modules. This group is an extension to the standard include group but has specific tools for pluggable modules which are not part of the libircd core.