File List

Here is a list of all documented files with brief descriptions:

[detail level 1234]

lib
quick-event
src
bench.h	Mainly used for testing, these functions allow you to benchmark everything and anything and output it in a format readble by Jenkins
buffer.h	Provides a pool of buffers you can use whenever you need a quick buffer
cleanup.h	For data that lives the life of the server, this provides a quick way to create and forget about freeing them
config.h	Handles configuration for the entire server and exposes a remote-management/monitoring interface
fair.h	Helps with determining if resources can be fairly allocated given current conditions
http.h	Useful utilities for doing asynchronous HTTP requests and parsing HTTP responses
job.h	Provides a simple interface for running jobs in multiple threads at once
json.h	QJSON is a minimal, in-place, zero-allocation JSON packer and unpacker
latch.h	Provides a latch that you can wait on
list.h	Provides a highly-concurrent, optionally resizable, optimized-for-inserts list
lock.h	Provides a read-write spin lock
log.h	Provides some useful logging shortcuts
mock.h	Allows for mocking any function call (typically used for syscalls) to see how they operate in failure conditions
pool.h	Provides a thread-local / globally shared pool of objects
qev.h	Provides all the qev_* functions that are needed for creating an event loop
queue.h	Provides a multiple-producer, multiple-consumer queue
rsock.h	Provides a buffered socket that reconnects on errors
safe.h	Provides safe math operations that won't overflow
stats.h	Provides stats aggregation and multiple sinks for collected stats
strfuncs.h	Optimizations to GLib's string functions
src
apps.h	Handles applications running inside the server
atomic.h	Some more atomic operations that aren't implemented alsewhere
client.h	Provides all utility client functions
compat.h	For older versions of libraries, adds helpers for things that don't exist
config.h	Every configuration option that QIO has
evs.h	Handles routing all events to their proper handlers
evs_qio.h	The default event handlers for QIO
evs_query.h	For doing fast lookups of ev_path -> handler
periodic.h	Periodically runs tasks on every client
protocols.h	Manages all of the protocols that clients may speak
protocols_flash.h	Handles sending the flash socket policy file back on flash connections
protocols_http.h	Provides support for HTTP long polling
protocols_raw.h	Allows communication with QIO without any framing
protocols_rfc6455.h	The QuickIO protocol over websockets (rfc6455)
protocols_util.h	Support functions for various protocol needs
quickio.h	Every header, definition, and whatnot QuickIO needs to run
sub.h	Controls the memory around subscriptions
test
check_compat.h	Older versions of check don't support the new macros; this file just monkeys them onto it
test.h	Utilities for running tests