ZIO
Python and C++ interface to ZeroMQ and Zyre
Public Types | Public Member Functions | List of all members
zio::Outbox< NATIVE > Class Template Reference

output objects of a fixed native type with levels expressed as methods. More...

#include <outbox.hpp>

Public Types

typedef NATIVE native_type
 
typedef std::function< void(zio::level::MessageLevel lvl, const native_type &)> sender_type
 

Public Member Functions

 Outbox (const sender_type &sender)
 
virtual ~Outbox ()
 
void operator() (level::MessageLevel lvl, const native_type &nat)
 
virtual void send (level::MessageLevel lvl, const native_type &nat)
 
void trace (const native_type &nat)
 
void verbose (const native_type &nat)
 
void debug (const native_type &nat)
 
void info (const native_type &nat)
 
void summary (const native_type &nat)
 
void warning (const native_type &nat)
 
void error (const native_type &nat)
 
void fatal (const native_type &nat)
 

Detailed Description

template<typename NATIVE>
class zio::Outbox< NATIVE >

output objects of a fixed native type with levels expressed as methods.

An Outbox provides a "logger" like object to simplfy use in code to send out messages of a fixed type.

It is templated on a native type and given a functional object to handle actual sending. This object should convert from native type to Message.

Definition at line 22 of file outbox.hpp.

Member Typedef Documentation

◆ native_type

template<typename NATIVE >
typedef NATIVE zio::Outbox< NATIVE >::native_type

Definition at line 24 of file outbox.hpp.

◆ sender_type

template<typename NATIVE >
typedef std::function<void(zio::level::MessageLevel lvl, const native_type&)> zio::Outbox< NATIVE >::sender_type

Definition at line 26 of file outbox.hpp.

Constructor & Destructor Documentation

◆ Outbox()

template<typename NATIVE >
zio::Outbox< NATIVE >::Outbox ( const sender_type sender)
inlineexplicit

Definition at line 28 of file outbox.hpp.

◆ ~Outbox()

template<typename NATIVE >
virtual zio::Outbox< NATIVE >::~Outbox ( )
inlinevirtual

Definition at line 29 of file outbox.hpp.

Member Function Documentation

◆ debug()

template<typename NATIVE >
void zio::Outbox< NATIVE >::debug ( const native_type nat)
inline

Definition at line 43 of file outbox.hpp.

◆ error()

template<typename NATIVE >
void zio::Outbox< NATIVE >::error ( const native_type nat)
inline

Definition at line 51 of file outbox.hpp.

◆ fatal()

template<typename NATIVE >
void zio::Outbox< NATIVE >::fatal ( const native_type nat)
inline

Definition at line 53 of file outbox.hpp.

◆ info()

template<typename NATIVE >
void zio::Outbox< NATIVE >::info ( const native_type nat)
inline

Definition at line 45 of file outbox.hpp.

◆ operator()()

template<typename NATIVE >
void zio::Outbox< NATIVE >::operator() ( level::MessageLevel  lvl,
const native_type nat 
)
inline

Definition at line 31 of file outbox.hpp.

◆ send()

template<typename NATIVE >
virtual void zio::Outbox< NATIVE >::send ( level::MessageLevel  lvl,
const native_type nat 
)
inlinevirtual

Definition at line 34 of file outbox.hpp.

◆ summary()

template<typename NATIVE >
void zio::Outbox< NATIVE >::summary ( const native_type nat)
inline

Definition at line 47 of file outbox.hpp.

◆ trace()

template<typename NATIVE >
void zio::Outbox< NATIVE >::trace ( const native_type nat)
inline

Definition at line 39 of file outbox.hpp.

◆ verbose()

template<typename NATIVE >
void zio::Outbox< NATIVE >::verbose ( const native_type nat)
inline

Definition at line 41 of file outbox.hpp.

◆ warning()

template<typename NATIVE >
void zio::Outbox< NATIVE >::warning ( const native_type nat)
inline

Definition at line 49 of file outbox.hpp.


The documentation for this class was generated from the following file: