Implementation functions

User-supplied back-end primitives that define the trace channel. More...

Functions
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.
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

The following functions must be implemented by the user and are specific to each individual trace channel.

Function Documentation

flush()

void micro_os_plus::trace::flush ( void )

inlinenoexcept

Parameters

None.

Returns

Nothing.

Thin wrapper over tracer<T>::flush().

Definition at line 248 of file cpp-api-inlines.h.

  {
    detail::tracer<detail::implementation>::flush ();
  }

References micro_os_plus::trace::detail::tracer< T >::flush().

initialise()

void micro_os_plus::trace::initialise ( void )

inlinenoexcept

Parameters

None.

Returns

Nothing.

Thin wrapper over tracer<T>::initialise(). Called during startup to enable the trace channel.

Definition at line 236 of file cpp-api-inlines.h.

  {
    detail::tracer<detail::implementation>::initialise ();
  }

References micro_os_plus::trace::detail::tracer< T >::initialise().

write()

ssize_t micro_os_plus::trace::write ( const void * buf, std::size_t nbyte )

inlinenoexcept

Parameters

buf	An array of bytes.
nbyte	The number of bytes in the array.

Returns

The number of bytes actually written, or -1 if error.

Thin wrapper over tracer<T>::write().

Definition at line 242 of file cpp-api-inlines.h.

  {
    return detail::tracer<detail::implementation>::write (buf, nbyte);
  }

References micro_os_plus::trace::detail::tracer< T >::write().

Referenced by micro_os_plus::trace::detail::tracer< T >::putchar(), micro_os_plus::trace::detail::tracer< T >::puts(), and micro_os_plus::trace::detail::tracer< T >::vprintf().