0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-26 08:42:34 +01:00
construct/include/ircd
2018-06-02 11:44:53 -07:00
..
buffer ircd::buffer: Minor cleanup/simplify. 2018-05-29 09:33:07 -07:00
ctx ircd::ctx: Assert release sequence is happening on ctx. 2018-06-01 12:36:46 -07:00
db ircd::db: Convert rocksdb::port from pthread to ircd::ctx. 2018-06-01 12:36:46 -07:00
fs ircd::fs: Add prefetch(). 2018-06-02 11:44:53 -07:00
js Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
json ircd::json: Add non-const iov::at(); minor cleanup. 2018-05-25 17:45:49 -07:00
m fixup! ircd:Ⓜ️ Rework visibility interface for empty mxid's as part of a public test. 2018-05-31 05:45:08 -07:00
mods ircd::mods: Fix sym_ptr boolean test. 2018-05-25 23:47:59 -07:00
net ircd::net: Add conf item for default close opts. 2018-06-01 04:08:20 -07:00
server ircd::server: Rename peer::interrupt() to peer::cancel(). 2018-05-29 11:53:37 -07:00
util ircd::util: Add output iterator bounded pointers transform. 2018-05-08 14:28:43 -07:00
.gitignore What is the Matrix? Control. 2017-03-10 17:51:18 -08:00
allocator.h ircd::allocator: Minor remove unused declaration. 2018-05-29 02:52:47 -07:00
asio.h Update Copyrastafaris. 2018-02-05 21:24:34 -08: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: Add various missing top-level \briefs. 2018-05-21 03:01:50 -07:00
color.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
conf.h ircd::conf: Add conf::exists(key); minor cleanup. 2018-05-25 20:45:30 -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::ctx: Add special termination interruption to yanagiba the stack. 2018-05-06 02:06:08 -07:00
fmt.h ircd::fmt: Internalize specifier related; various cleanup. 2018-05-30 09:05:15 -07:00
hash.h ircd:#️⃣ Fix static constexpr linkages. 2018-05-10 21:01:23 -07:00
http.h ircd::http: Add 504 Gateway Timeout status. 2018-05-21 15:56:13 -07:00
info.h ircd::info: Distill out the logdump from init. 2018-04-20 15:22:50 -07:00
ios.h ircd: Remove ircd::error_code typedef with more local typedefs. 2018-03-08 10:08:38 -08:00
iov.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
ircd.h ircd: Add function to return daemon's uptime. 2018-04-14 17:15:06 -07:00
js.h Update Copyrastafaris. 2018-02-05 21:24:34 -08:00
lex_cast.h Update Copyrastafaris. 2018-02-05 21:24:34 -08: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: Add namespace \brief. 2018-02-22 20:32:10 -08:00
Makefile.am Checkpoint reorganization. 2017-11-30 12:30:19 -08:00
nacl.h ircd: Add various missing top-level \briefs. 2018-05-21 03:01:50 -07:00
openssl.h ircd::openssl: Add stringify x509 to JSON. 2018-03-12 11:16:49 -07:00
parse.h ircd::parse: Add deprecation notice to this subsystem. 2018-05-30 09:09:48 -07:00
rand.h ircd::rand: Modernize interface. 2018-02-15 12:53:00 -08:00
README.md ircd: Clarify namespaces in include README. 2018-01-23 15:07:05 -08:00
resource.h ircd: Add various missing top-level \briefs. 2018-05-21 03:01:50 -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: Missing typedefs. 2018-03-18 21:18:00 -07:00
stdinc.h ircd::db: Condition to check database from ircd::checkdb via -checkdb command line option. 2018-05-31 12:47:37 -07:00
string_view.h ircd: Fix proper default constexpr ctor. 2018-03-06 03:51:51 -08:00
stringops.h ircd: Add various missing top-level \briefs. 2018-05-21 03:01:50 -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/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.