0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-06-10 22:18:54 +02:00
construct/include/ircd
2020-04-26 17:02:21 -07:00
..
buffer ircd::buffer: non-call copy and move. 2020-04-25 00:28:39 -07:00
cbor ircd::cbor: Reconstitute head reader and utils. 2019-12-26 11:43:01 -08:00
ctx ircd::ctx: Profile peak stack usage at slice leave event. 2020-04-23 12:41:39 -07:00
db ircd::db: Increase the default target file size and multiplier; regression a68b96f5e3 2020-03-18 17:13:33 -07:00
fs ircd::fs: Refactor base paths into conf::items. 2020-04-19 06:13:23 -07:00
http2
js
json ircd::json::tuple: Fix type=NUMBER serial=true tuple assignment. 2020-04-22 05:34:12 -07:00
m ircd:Ⓜ️:fed: Use single codepath for request target; use canonize rewrite. 2020-04-26 16:19:37 -07:00
mods ircd::mods::ldso: Add loaded check using the dlfcn method. 2020-03-08 18:55:33 -07:00
net ircd::net::dns::cache: Move cache waiter calling out of module. 2020-04-25 00:28:39 -07:00
prof ircd::prof: Move ctx::syscall_usage_warning into prof. 2020-03-06 15:43:24 -08:00
resource ircd::resource: Add doxygen brief for suite; also note abstraction leak. 2019-12-02 17:50:11 -08:00
server ircd::server: Additional convenience query for linked peers. 2020-04-25 19:30:21 -07:00
util ircd::util: Add overload for what() on std::exception value-type. 2020-04-23 04:19:53 -07:00
.gitignore Abstract ircd::resource from ircd:Ⓜ️:resource; fix header stack. 2019-09-29 14:00:02 -07:00
allocator.h
asio.h ircd::ios: Employ the asio::executor abstraction w/ backward-compat. 2020-02-27 12:44:57 -08:00
assert.h configure: Disable all __assert_fail() overrides unless explicit --with-assert option. 2020-04-11 15:11:43 -07:00
backtrace.h ircd: Add interface to backtrace(3). 2019-09-19 22:07:41 -07:00
base.h
byte_view.h
client.h
cmp.h
color.h
conf.h ircd::conf: Improve item maximum related constants. 2019-07-27 18:49:26 -07:00
crh.h
demangle.h ircd: Move demangle() out of util. 2019-09-19 16:37:45 -07:00
ed25519.h ircd::ed25519: Use string_view for path ctor. 2019-10-02 18:16:55 -07:00
exception.h ircd::run: Place out-of-line default ctor/dtor definitions. 2020-02-28 12:36:45 -08:00
fmt.h ircd::fmt: Introduce the format string literal operator. 2019-10-02 18:16:55 -07:00
globular.h ircd: Add missing globular_imatch. 2020-04-26 17:02:21 -07:00
grammar.h
http.h ircd::http: Add X-Forwarded-For support to request header. 2020-04-22 23:39:56 -07:00
info.h ircd::info: Remove the fixed-rlimit sample section here. 2020-03-20 09:56:58 -07:00
ios.h ircd::ios: Employ the asio::executor abstraction w/ backward-compat. 2020-02-27 12:44:57 -08:00
iov.h
ircd.h Add -defaults program option to restore from broken configurations. 2020-04-24 21:58:57 -07:00
js.h
leb128.h ircd::leb128: Add RB_GENERIC condition on platform intrinsics. 2019-12-21 14:37:41 -08:00
lex_cast.h ircd: Rename try_lex_cast to lex_castable. 2020-03-12 21:09:56 -07:00
locale.h ircd: Rename formerly conflicting header files. 2020-04-19 16:45:30 -07:00
logger.h ircd::logger: Remove noreturn attribute. 2020-04-22 01:51:55 -07:00
magic.h ircd::fs::base: Make all items have persist=false behavior. 2020-04-19 17:53:22 -07:00
magick.h
Makefile.am fixed lookup of boost headers 2020-03-10 13:16:42 -04:00
matrix.h Abstract ircd::resource from ircd:Ⓜ️:resource; fix header stack. 2019-09-29 14:00:02 -07:00
nacl.h
openssl.h ircd::openssl: Add getters for X509 from SSL_CTX. 2019-09-30 14:23:28 -07:00
panic.h ircd: Split panic/terminate exception related into header. 2020-02-26 14:17:43 -08:00
parse.h
pbc.h ircd: Add PBC stub. 2020-02-11 15:47:18 -08:00
portable.h ircd: Add portable macro for __has_builtin(). 2020-04-24 21:58:57 -07:00
rand.h
README.md
rfc1035.h
rfc1459.h
rfc3986.h ircd::rfc3986: Refactor uri encoder/decoder related; reorg. 2020-03-28 23:39:13 -07:00
run.h ircd::run: Add a convenience barrier template tool. 2020-03-16 16:56:07 -07:00
simd.h ircd: Add additional vector convenience typedefs. 2020-03-14 15:21:58 -07:00
spirit.h ircd::spirit: Import the expect parser directive. 2020-04-17 18:58:17 -07:00
stats.h
stdinc.h ircd: Split stdinc into additional macros header. 2020-02-21 12:22:56 -08:00
string_view.h ircd: Apply noexcept on various constexpr callstacks. 2019-08-15 00:05:48 -07:00
stringops.h ircd::stringops: Minor cleanup; formatting/consistency. 2020-04-05 13:02:20 -07:00
strl.h
strn.h ircd: Add strncpy++ tool. 2019-09-18 09:50:14 -07:00
time.h ircd: Rename formerly conflicting header files. 2020-04-19 16:45:30 -07:00
tokens.h
vector_view.h ircd::vector_view: Add constructor for reasonable implicit const conversion of value_type. 2020-04-21 23:05:28 -07:00

IRCd Library API

Project Namespaces

  • IRCD_ Preprocessor #define and macros.
  • RB_ Build system related preprocessor #defines and macros (legacy).
  • ircd_ C namespace and demangled bindings.
  • ircd:: C++ namespace scope.
  • X-IRCd- HTTP header key namespace.
  • ircd. Matrix event type namespace.
  • ircd_ Environmental variables (see: conf.h).

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/ircd.h> and <ircd/ircd.pic.h>. The latter is generated dynamically and will not exist until make creates it. We have to offer two different pre-compilations: one with -fPIC and one without.

  • 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.

Invocation

libircd is not thread-safe. It does not protect exposed interfaces with locks. Embedders must access libircd from a single thread.

Initialize the library with a call to ircd::init().