0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-26 08:42:34 +01:00
construct/include/ircd
2019-06-07 04:56:23 -07:00
..
buffer configure: Define HAVE_SODIUM in config.h on pkg found. 2019-06-06 03:54:37 -07:00
ctx ircd::ctx: Rename function; add overload for total value. 2019-05-26 02:49:24 -07:00
db ircd::db: Expose subroutines from db::init. 2019-06-06 18:47:44 -07:00
fs ircd::fs: Add ability to change basepath values at runtime. 2019-06-06 17:38:12 -07:00
js ircd: Remove the legacy AFP() / AFGP() macros. 2018-12-08 13:51:33 -08:00
json ircd::json: Fix cause of STB_GNU_UNIQUE emission after use of at() template. 2019-05-16 22:36:19 -07:00
m ircd:Ⓜ️:room: Expose bootstrap to interface. 2019-06-07 04:56:23 -07:00
mods ircd::mods::ldso: Add a DT_NEEDED iterator. 2019-06-04 03:18:03 -07:00
net ircd::net::acceptor: Elide the accepting list for single-accept [revertible]. 2019-06-01 17:10:49 -07:00
resource ircd::resource: Reduce m:: type dependency in request structure. 2019-05-06 11:16:44 -07:00
server ircd::server:🔗 Add noexcept on handlers. 2019-05-02 15:35:26 -07:00
util ircd::util: Add a weak interface for the test trigger stub. 2019-05-24 18:24:33 -07:00
.gitignore ircd: Consolidate stdinc.h and ircd.h and fix precompiled headers. 2018-06-15 16:13:18 -06:00
allocator.h ircd: Add interface for core valgrind hypercalls. 2019-05-28 20:46:40 -07:00
asio.h ircd: Add visibility pragma in stdinc.h 2019-05-02 16:45:27 -07:00
assert.h ircd: Add conditioned debugtrap() utility in assert suite. 2019-05-28 16:55:41 -07:00
base.h ircd: Add b64 <-> b58 convenience conversion suite. 2018-04-22 14:24:37 -07:00
byte_view.h ircd: Relax assertion. 2018-05-19 18:49:03 -07:00
client.h Eliminate friend-injection. 2019-02-15 18:48:59 -08:00
color.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
conf.h ircd::conf: Add more elaborate double-fault handling. 2019-03-11 12:53:22 -07:00
crh.h ircd::crh: Add HMAC support. 2019-01-19 13:20:58 -08:00
date.h ircd: Tweak smalldate fmt. 2019-05-05 20:00:52 -07:00
demangle.h ircd: Consolidate demangle related into interface / unit. 2018-03-23 22:17:09 -07:00
ed25519.h ircd: Add various missing top-level \briefs. 2018-05-21 03:01:50 -07:00
exception.h ircd: Deinline exception::what(). 2019-05-27 03:07:59 -07:00
fmt.h ircd::fmt: Minor simplify; cleanup. 2018-12-14 15:51:12 -08:00
grammar.h ircd: Add comment in spirit header. 2019-05-06 10:42:11 -07:00
http.h ircd::http: Add cloudflare 521 code. 2019-06-07 00:09:58 -07:00
info.h ircd::info: Get more extended feature bits; various cleanup. 2019-06-05 14:27:36 -07:00
ios.h ircd: Apply uniform info::versions for all dependency version identification. 2019-05-31 16:15:01 -07:00
iov.h ircd::iov: Make node emplacement conditional. 2018-06-05 10:34:30 -07:00
ircd.h ircd: Add infrastructure to handle continuation notification after suspending. 2019-06-05 15:06:16 -07:00
js.h ircd: Disperse accumulated global options as conf items in namespaces. 2018-12-08 15:36:34 -08:00
lex_cast.h ircd: Reduce the size of the lex_cast ringbuffer; deinline the sizes. 2019-03-01 11:47:13 -08:00
localee.h ircd: Add various missing top-level \briefs. 2018-05-21 03:01:50 -07:00
logger.h ircd: Move smalldate() to date.h from logger unit. 2019-04-17 19:27:26 -07:00
magick.h ircd: Apply uniform info::versions for all dependency version identification. 2019-05-31 16:15:01 -07:00
magics.h ircd: Apply uniform info::versions for all dependency version identification. 2019-05-31 16:15:01 -07:00
Makefile.am include/ircd: Add header file installer. 2019-05-06 13:18:51 -07:00
nacl.h ircd: Apply uniform info::versions for all dependency version identification. 2019-05-31 16:15:01 -07:00
openssl.h ircd::openssl: Add conditional LibreSSL versions instance. 2019-06-04 14:01:33 -07:00
parse.h ircd: Rename and refactor ircd::assertion interface into ircd::panic. 2019-01-13 16:37:31 -08:00
prof.h ircd::prof: Various optimizations. 2019-05-08 05:19:04 -07:00
rand.h ircd::rand: Add note to rand::integer(). 2018-08-22 17:19:18 -07:00
README.md ircd::conf: Update doc related to conf item env vars and the related namespace. 2018-12-28 13:36:23 -08:00
rfc1035.h ircd::rfc1035: Rename constant. 2019-05-26 18:37:40 -07:00
rfc1459.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
rfc3986.h ircd::rfc1035: Rename constant. 2019-05-26 18:37:40 -07:00
run.h ircd: Add restart support w/ console cmd. 2019-03-02 14:20:52 -08:00
spirit.h ircd: Add comment in spirit header. 2019-05-06 10:42:11 -07:00
stats.h ircd::stats: Additional arithmetic/access operators on item. 2019-05-05 19:12:54 -07:00
stdinc.h ircd: Add ulong typedef on FreeBSD. 2019-06-05 23:54:02 -07:00
string_view.h ircd::buffer: Always inline fundamental buffer template utils. 2019-05-08 05:19:04 -07:00
stringops.h ircd: Add #ifdefs around potentially conflicting BSD stringops. 2019-06-06 02:59:57 -07:00
tokens.h ircd::tokens: Add token_exists() set membership test. 2019-03-09 17:03:52 -08:00
vector_view.h ircd::vector_view: Add front() and back() convenience accessors. 2019-06-06 17:02:39 -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().