0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-05-19 11:23:45 +02:00
construct/include/ircd
2023-03-05 12:05:13 -08:00
..
allocator
buffer
cl
ctx ircd::ctx::pool: Add option for dispatch strategy; behavior changed by default. 2023-02-20 20:15:44 -08:00
db ircd::db: Add conf items to connect database options to ircd::conf. 2023-02-27 21:52:27 -08:00
fs
gpt ircd::gpt: Add micro-benchmark start/stop probes. 2023-02-16 21:13:18 -08:00
http2
ios
js
json ircd::json::stack: Split into directory; inlines; abi simplification. 2023-02-18 21:30:11 -08:00
m ircd:Ⓜ️:fed: Upgrade to v2 send_join. 2023-03-03 15:15:38 -08:00
math
mods ircd::mapi: Annotate noexcept; non-dynamic alloc; codegen reduction all modules. 2023-03-05 12:05:13 -08:00
net ircd::net: Add TCP_CORK support to socket options interface. 2023-03-02 19:03:19 -08:00
prof ircd: Fix -Wdeprecated-copy-with-user-provided-dtor or remove empty dtors. 2023-02-17 16:51:54 -08:00
resource ircd::resource::method: Add method flag to cork response. 2023-03-02 19:08:05 -08:00
server ircd: Internalize various loghead utils; remove legacy ostream operators. 2023-02-09 11:41:11 -08:00
simd ircd::util: Add popcount wrapping; consolidate callsites. 2023-02-07 20:04:26 -08:00
simt
spirit
util ircd::util: Add blackwhite::list tool. 2023-02-27 23:58:08 -08:00
.gitignore
asio.h ircd::asio: Interpose workaround for bug in io_uring_service::get_sqe() boost 1.81. 2023-02-20 10:31:13 -08:00
assert.h ircd: Attribute nodebug on assert frames, artificial ineffective for clang. 2023-02-09 11:11:01 -08:00
b58.h
b64.h ircd::b64: Add target clones list. 2023-03-05 12:05:13 -08:00
backtrace.h
beep.h
byte_view.h
cbor.h
client.h ircd::client: Add conf item for pool dispatch flags. 2023-02-21 10:40:00 -08:00
cmp.h
color.h
conf.h ircd::conf: Add reference to conf::item in setter callbacks. 2023-02-27 15:29:16 -08:00
crh.h
demangle.h
ed25519.h
exception.h
exec.h
fmt.h
fpe.h
globular.h ircd::util: Generalize util::boolean into returns template. 2023-02-09 19:17:45 -08:00
grammar.h
http.h ircd::http: Recognize additional proxy related headers for now. #189 2023-02-23 19:03:29 -08:00
icu.h
info.h
iov.h
ircd.h ircd::util: Add popcount wrapping; consolidate callsites. 2023-02-07 20:04:26 -08:00
js.h
leb128.h
lex_cast.h
logger.h
magic.h
magick.h
Makefile.am
matrix.h
nacl.h
openssl.h
panic.h
parse.h
pbc.h
png.h
portable.h configure: Add --enable-clones for dynamic function multi-versioning. 2023-03-05 12:05:13 -08:00
rand.h
README.md
rfc1035.h
rfc1459.h
rfc3986.h
run.h
spirit.h
stats.h
stdinc.h
stduse.h
string_view.h
stringops.h
strl.h
strn.h
sys.h
terminate.h
time.h
tokens.h
utf8.h
utf16.h
vector_view.h
versions.h
vg.h

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().