Flow 1.0.0
Flow project: Public API.
Classes | Namespaces | Macros | Typedefs | Enumerations | Variables
common.hpp File Reference

Classes

class  flow::Function< Result(Args...)>
 Intended as the polymorphic function wrapper of choice for Flow, internally and externally; to be used instead of std::function or boost::function. More...
 

Namespaces

namespace  flow
 Catch-all namespace for the Flow project: A collection of various production-quality modules written in modern C++17, originally by ygoldfel.
 

Macros

#define FLOW_OS_LINUX
 Macro that is defined if and only if the compiling environment is Linux.
 
#define FLOW_OS_MAC
 Macro that is defined if and only if the compiling environment is Mac OS X or higher macOS (not iOS and such!).
 
#define FLOW_OS_WIN
 Macro that is defined if and only if the compiling environment is Windows.
 

Typedefs

using flow::uint8_t = unsigned char
 Byte. Best way to represent a byte of binary data. This is 8 bits on all modern systems.
 
using flow::int8_t = signed char
 Signed byte. Prefer to use uint8_t when representing binary data. This is 8 bits on all modern systems.
 
using flow::Fine_clock = boost::chrono::high_resolution_clock
 Clock used for delicate time measurements, such that the now() method gets the current time relative to some unknown but constant epoch (reference point). More...
 
using flow::Fine_time_pt = Fine_clock::time_point
 A high-res time point as returned by Fine_clock::now() and suitable for precise time math in general.
 
using flow::Fine_duration = Fine_clock::duration
 A high-res time duration as computed from two Fine_time_pts.
 
using flow::Error_code = boost::system::error_code
 Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and a pointer through which to obtain a statically stored message string); this is how Flow modules report errors to the user; and we humbly recommended all C++ code use the same techniques. More...
 

Enumerations

enum class  flow::Flow_log_component { flow::S_END_SENTINEL }
 The flow::log::Component payload enumeration comprising various log components used by Flow's own internal logging. More...
 

Variables

const boost::unordered_multimap< Flow_log_component, std::string > flow::S_FLOW_LOG_COMPONENT_NAME_MAP
 The map generated by flow::log macro magic that maps each enumerated value in flow::Flow_log_component to its string representation as used in log output and verbosity config. More...