trace-cpp-api.h File Reference

C++ header file with the declarations for the C++ trace API. More...

#include <sys/types.h>
#include <cstddef>
#include <cstdarg>
#include <concepts>
#include "inlines/trace-cpp-api-inlines.h"

Go to the source code of this file.

Classes
class	micro_os_plus::trace::detail::implementation
	Policy class for the production trace instance. More...
class	micro_os_plus::trace::detail::tracer< T >
	Tracing API bound to a given policy class. More...

Namespaces
namespace	micro_os_plus
	The primary namespace for the µOS++ framework.
namespace	micro_os_plus::trace
	Tracing support namespace.
namespace	micro_os_plus::trace::detail
	Implementation details namespace.

Concepts
concept	micro_os_plus::trace::detail::trace_policy
	Concept constraining the policy class T used by tracer<T>.

Functions
void	micro_os_plus::trace::dump_args (int argc, char *argv[], const char *name="main") noexcept
	Send the argv[] array to the trace output channel.
void	micro_os_plus::trace::flush (void) noexcept
	Flush the trace output channel.
void	micro_os_plus::trace::initialise (void) noexcept
	Initialise the trace output channel.
int	micro_os_plus::trace::printf (const char *format,...) noexcept
	Write a formatted string to the trace output channel.
int	micro_os_plus::trace::putchar (int c) noexcept
	Write the single character to the trace output channel.
int	micro_os_plus::trace::puts (const char *s="") noexcept
	Write the string and a line terminator to the trace output channel.
int	micro_os_plus::trace::vprintf (const char *format, std::va_list arguments) noexcept
	Write a formatted variable arguments list to the trace output channel.
ssize_t	micro_os_plus::trace::write (const void *buf, std::size_t nbyte) noexcept
	Write the given number of bytes to the trace output channel.

Detailed Description

Declarations for the tracer class template and the trace_policy concept.

Inline method definitions are located in trace-cpp-api-inlines.h, included at the bottom of this file. This file is included by <micro-os-plus/diag/trace.h>, which should be used instead of including this file directly.

Definition in file trace-cpp-api.h.