aruna::log::channel_t Struct Reference

#include <log.h>

Public Member Functions
	channel_t (const char *name, level_t level=default_level)
	~channel_t ()
int	verbose (const char *format,...)
	log verbose message More...
int	debug (const char *format,...)
	log debug message More...
int	info (const char *format,...)
	log info message More...
int	warning (const char *format,...)
	log warning message More...
int	error (const char *format,...)
	log error message More...
int	dump (level_t level, uint8_t *bin, size_t size)
	dump array of bin data More...
bool	operator< (const channel_t &b) const
bool	operator== (const char *name) const

Public Attributes
const char *	name
	Channel name, used to identify. More...
level_t	level = default_level
	max log level of channel More...
err_t	startup_status = err_t::NOT_STARTED
	Contains the error happens at construction. More...

Private Member Functions
int	print (level_t level, const char *format)
int	out (const char *format,...)
unsigned long	epoch ()

Detailed Description

Definition at line 25 of file log.h.

Constructor & Destructor Documentation

channel_t()

aruna::log::channel_t::channel_t	(	const char *	name,
		level_t	level = default_level
	)

Definition at line 112 of file log.cpp.

                                                            : name(name), level(level) {
            this->startup_status = aruna::err_t::OK;
            if (!register_channel(this))
                this->startup_status = aruna::err_t::CHANNEL_EXISTS;
        }

Here is the call graph for this function:

~channel_t()

aruna::log::channel_t::~channel_t

(

)

Definition at line 178 of file log.cpp.

                              {
            channels()->erase(this);
        }

Here is the call graph for this function:

Member Function Documentation

debug()

int aruna::log::channel_t::debug	(	const char *	format,
			...
	)

log debug message

Parameters

format,char	array
...	insert extra variables

Returns

how many bytes have been written.

Definition at line 51 of file log.cpp.

                                                    {
            char buffer[256];
            int n = 0;
            va_list argptr;

            va_start(argptr, format);
            vsprintf(buffer, format, argptr);
            n = print(level_t::DEBUG, buffer);
            va_end(argptr);

            return n;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

dump()

int aruna::log::channel_t::dump	(	level_t	level,
		uint8_t *	bin,
		size_t	size
	)

dump array of bin data

Parameters

level	log level
bin	pointer to array
size	size of array

Returns

bytes written

Definition at line 135 of file log.cpp.

                                                                    {
//       TODO   this if statement is copied two times, there should be a function that implements it
            if (((int) level > (int) this->level) || ((int) level > (int) max_level) || level == level_t::NONE) {
                return 0;
            }
#if defined (__unix__) || (defined (__APPLE__) && defined (__MACH__))
            char level_c[5];
            level_t_to_char(level, level_c);
//          TODO formatting should be staderlized
            out("%s (%u) %s, 0x%X  ", level_c, epoch(), name, bin);
            for (int i = 0; i < size ; ++i) {
                out("%02X ", bin[i]);
            }
            out("\n");
            return size;
#elif defined(ESP_PLATFORM)
            esp_log_level_t esp_log_level;
            switch (level) {
                case level_t::VERBOSE:
                    esp_log_level = ESP_LOG_VERBOSE;
                    break;
                case level_t::DEBUG:
                    esp_log_level = ESP_LOG_DEBUG;
                    break;
                case level_t::INFO:
                    esp_log_level = ESP_LOG_INFO;
                    break;
                case level_t::WARNING:
                    esp_log_level = ESP_LOG_WARN;
                    break;
                case level_t::ERROR:
                    esp_log_level = ESP_LOG_ERROR;
                    break;
                default:
                case log::level_t::NONE:
                    esp_log_level = ESP_LOG_NONE;
                    break;
            }
            ESP_LOG_BUFFER_HEXDUMP(name, bin, size, esp_log_level);
            return size;
#endif
        }

Here is the call graph for this function:

Here is the caller graph for this function:

epoch()

unsigned long aruna::log::channel_t::epoch ( )

private

Definition at line 118 of file log.cpp.

                                       {
#if defined (__unix__) || (defined (__APPLE__) && defined (__MACH__))
            return ::time(NULL);
#elif defined(ESP_PLATFORM)
            return esp_log_timestamp();
#endif
        }

Here is the caller graph for this function:

error()

int aruna::log::channel_t::error	(	const char *	format,
			...
	)

log error message

Parameters

format,char	array
...	insert extra variables

Returns

how many bytes have been written.

Definition at line 90 of file log.cpp.

                                                    {
            char buffer[256];
            int n = 0;
            va_list argptr;

            va_start(argptr, format);
            vsprintf(buffer, format, argptr);
            n = print(level_t::ERROR, buffer);
            va_end(argptr);

            return n;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

info()

int aruna::log::channel_t::info	(	const char *	format,
			...
	)

log info message

Parameters

format,char	array
...	insert extra variables

Returns

how many bytes have been written.

Definition at line 64 of file log.cpp.

                                                   {
            char buffer[256];
            int n = 0;
            va_list argptr;

            va_start(argptr, format);
            vsprintf(buffer, format, argptr);
            n = print(level_t::INFO, buffer);
            va_end(argptr);

            return n;
        }

Here is the call graph for this function:

operator<()

bool aruna::log::channel_t::operator< ( const channel_t &  b ) const

inline

Definition at line 89 of file log.h.

                                                 {
            return this->name < b.name;
        }

operator==()

bool aruna::log::channel_t::operator== ( const char *  name ) const

inline

Definition at line 93 of file log.h.

                                                {
            return this->name == name;
        }

Here is the call graph for this function:

out()

int aruna::log::channel_t::out ( const char *  format,   ...  )

private

Definition at line 126 of file log.cpp.

                                                  {
            va_list list;
            int n;
            va_start(list, format);
            n = print_function(format, list);
            va_end(list);
            return n;
        }

Here is the caller graph for this function:

print()

int aruna::log::channel_t::print ( level_t  level, const char *  format  )

private

Definition at line 103 of file log.cpp.

                                                              {
            char level_txt[5];
            if (((int) level > (int) this->level) || ((int) level > (int) max_level) || level == level_t::NONE) {
                return 0;
            }
            level_t_to_char(level, level_txt);
            return out("%s (%u) %s, %s\n", level_txt, epoch(), name, format);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

verbose()

int aruna::log::channel_t::verbose	(	const char *	format,
			...
	)

log verbose message

Parameters

format,char	array
...	insert extra variables

Returns

how many bytes have been written.

Definition at line 38 of file log.cpp.

                                                      {
            char buffer[256];
            int n = 0;
            va_list argptr;

            va_start(argptr, format);
            vsprintf(buffer, format, argptr);
            n = print(level_t::VERBOSE, buffer);
            va_end(argptr);

            return n;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

warning()

int aruna::log::channel_t::warning	(	const char *	format,
			...
	)

log warning message

Parameters

format,char	array
...	insert extra variables

Returns

how many bytes have been written.

Definition at line 77 of file log.cpp.

                                                      {
            char buffer[256];
            int n = 0;
            va_list argptr;

            va_start(argptr, format);
            vsprintf(buffer, format, argptr);
            n = print(level_t::WARNING, buffer);
            va_end(argptr);

            return n;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

level

level_t aruna::log::channel_t::level = default_level

max log level of channel

Definition at line 34 of file log.h.

name

const char* aruna::log::channel_t::name

Channel name, used to identify.

Definition at line 29 of file log.h.

startup_status

err_t aruna::log::channel_t::startup_status = err_t::NOT_STARTED

Contains the error happens at construction.

Definition at line 43 of file log.h.

---

The documentation for this struct was generated from the following files:

• include/aruna/log.h
• src/log/log.cpp