diag-trace 4.2.1
The µOS++ Tracing Infrastructure
Loading...
Searching...
No Matches
Implementation functions

Functions

void micro_os_plus::trace::flush (void)
 Flush the trace output channel.
 
void micro_os_plus::trace::initialize (void)
 Initialize the trace output channel.
 
ssize_t micro_os_plus::trace::write (const void *buf, std::size_t nbyte)
 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 )

Flush the trace output channel.

Parameters
None.
Returns
Nothing.
Note
Must be implemented by the application.

For buffered trace channels, this function should guarantee that the entire buffer is sent to the channel.

For character mode channels, this function can be left empty.

◆ initialize()

void micro_os_plus::trace::initialize ( void )

Initialize the trace output channel.

Parameters
None.
Returns
Nothing.
Note
Must be implemented by the application.

◆ write()

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

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

Parameters
[in]bufAn array of bytes.
[in]nbyteThe number of bytes in the array.
Returns
The number of characters actually written, or -1 if error.
Note
Must be implemented by the application.

This function is called during startup, as early as possible, to enable the tracing channel.

After this function, all tracing functions are available.