0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-02 20:09:16 +01:00
construct/include/ircd
2018-09-29 17:15:45 -07:00
..
buffer ircd::buffer: Deconflict buffers templates in separate namespace. 2018-09-13 05:12:10 -07:00
cbor ircd: Move preliminary cbor into directory. 2018-08-11 00:42:08 -07:00
ctx ircd::ctx::queue: Remove exception assertion on pops. 2018-09-19 01:44:13 -07:00
db ircd::db: Add per-cache statistics. 2018-09-26 18:00:18 -07:00
fs Add datadir (share) configure, Makefile and ircd::fs related. 2018-09-13 22:02:52 -07:00
js ircd::js: Remove xdr. 2018-08-11 00:42:08 -07:00
json ircd: Various fixes for resolution of constexpr string_view & hash related; cleanup. 2018-09-16 21:28:46 -07:00
m ircd:Ⓜ️:feds: Add central interface linkage for feds head. 2018-09-25 17:14:48 -07:00
mods ircd: Move m::import to mods::import where it is more appropriate. 2018-09-13 18:19:27 -07:00
net ircd::net: Expose interface to get socket counter as an ID. 2018-09-29 17:15:45 -07:00
server ircd: Simplify/cleanup the coarse controls for client/server subsystems. 2018-09-17 16:47:36 -07:00
util ircd::util: Support comparator in instance_multimap template. 2018-09-29 16:46:55 -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::allocator: Add state::available(n) query. 2018-08-25 18:46:54 -07:00
asio.h ircd: Remove ircd::strand related. 2018-07-06 00:44:24 -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 ircd::client: Simplify instance_multimap related; keep state for local/remote addrs in client. 2018-09-29 16:52:54 -07:00
color.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
conf.h ircd::conf: Enforce a max length on name strings. 2018-09-15 02:20:48 -07:00
date.h ircd:📅 Use the standard snprintf() here. 2018-06-01 14:24:45 -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::exception: Update comment. 2018-09-04 21:09:12 -07:00
fmt.h ircd::fmt: Internalize specifier related; various cleanup. 2018-05-30 09:05:15 -07:00
hash.h ircd: Various fixes for resolution of constexpr string_view & hash related; cleanup. 2018-09-16 21:28:46 -07:00
http.h ircd::http: Simplify interface; DRY. 2018-08-30 19:00:07 -07:00
info.h ircd::info: Fix some informational timestamps. 2018-09-05 23:32:52 -07:00
ios.h ircd: Remove ircd::strand related. 2018-07-06 00:44:24 -07:00
iov.h ircd::iov: Make node emplacement conditional. 2018-06-05 10:34:30 -07:00
ircd.h construct: Add program option to disable direct IO. 2018-09-03 07:59:05 -07:00
js.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
lex_cast.h ircd: Improve human readable unit tool suite. 2018-09-24 23:56:29 -07:00
localee.h ircd: Add various missing top-level \briefs. 2018-05-21 03:01:50 -07:00
logger.h configure.ac/ircd: Add granular configure-time log level control. 2018-05-21 16:59:28 -07:00
magics.h ircd::magic: Minor cleanup. 2018-08-11 00:42:08 -07:00
Makefile.am include/Makefile: Add other flags vars. 2018-09-17 18:52:26 -07:00
nacl.h ircd: Add various missing top-level \briefs. 2018-05-21 03:01:50 -07:00
openssl.h ircd::openssl/ircd::net: Add presupplied rfc3526 DH parameters. 2018-08-29 16:16:55 -07:00
parse.h ircd::parse: Add deprecation notice to this subsystem. 2018-05-30 09:09:48 -07:00
rand.h ircd::rand: Add note to rand::integer(). 2018-08-22 17:19:18 -07:00
README.md ircd: Consolidate stdinc.h and ircd.h and fix precompiled headers. 2018-06-15 16:13:18 -06:00
resource.h ircd::resource: Internalize the buffering boilerplate used with json::stack. 2018-09-04 22:03:12 -07:00
rfc1035.h ircd::rfc1035: Provide remaining default construction values. 2018-04-28 18:33:57 -07:00
rfc1459.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
rfc3986.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
spirit.h ircd::spirit: Import locals into namespace; minor cleanup. 2018-07-01 19:11:13 -07:00
stdinc.h ircd: Add missing minutes chrono import. 2018-09-16 18:19:23 -07:00
string_view.h ircd: Various fixes for resolution of constexpr string_view & hash related; cleanup. 2018-09-16 21:28:46 -07:00
stringops.h ircd: Add ihas() case insensitive string searching. 2018-09-14 07:44:44 -07:00
tokens.h ircd: Fix allocator construction in tokens template. 2018-04-24 17:08:43 -07:00
vector_view.h ircd: Add various missing top-level \briefs. 2018-05-21 03:01:50 -07:00

IRCd Library API

Project Namespaces

  • IRCD_ Preprocessor #define, macro, and environmental variables.
  • 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.

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.