Implementation functions

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

Functions Index

void	flush (void) noexcept
	Flush the trace output channel. More...
void	initialise (void) noexcept
	Initialise the trace output channel. More...
ssize_t	write (const void *buf, std::size_t nbyte) noexcept
	Write the given number of bytes to the trace output channel. More...

Description

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

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

Functions

flush()

void micro_os_plus::trace::flush (void)

inline noexcept

Flush the trace output channel.

Parameters

None.

Returns

Nothing.

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

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

248 flush (void) noexcept

249 {

250 detail::tracer<detail::implementation>::flush ();

251 }

Reference micro_os_plus::trace::detail::tracer< T >::flush.

initialise()

void micro_os_plus::trace::initialise (void)

inline noexcept

Initialise the trace output channel.

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.

236 initialise (void) noexcept

237 {

238 detail::tracer<detail::implementation>::initialise ();

239 }

Reference micro_os_plus::trace::detail::tracer< T >::initialise.

write()

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

inline noexcept

Write the given number of bytes to the trace output channel.

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.

242 write (const void* buf, std::size_t nbyte) noexcept

243 {

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

245 }

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

---

Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.17.0.