Руслан Урядинский / libuavcan

Dependents:   UAVCAN UAVCAN_Subscriber

Embed: (wiki syntax)

« Back to documentation index

IEventTracer Class Reference

This interface allows the application to trace events that happen in the server. More...

#include <event.hpp>

Inherited by EventTracer, and FileEventTracer.

Public Member Functions

virtual void onEvent (TraceCode event_code, int64_t event_argument)=0
 The server invokes this method every time it believes that a noteworthy event has happened.

Static Public Member Functions

static const char * getEventName (TraceCode code)
 It is safe to call this function with any argument.

Detailed Description

This interface allows the application to trace events that happen in the server.

Definition at line 90 of file event.hpp.


Member Function Documentation

static const char* getEventName ( TraceCode  code ) [static]

It is safe to call this function with any argument.

If the event code is out of range, an assertion failure will be triggered and an error text will be returned.

Definition at line 98 of file event.hpp.

virtual void onEvent ( TraceCode  event_code,
int64_t  event_argument 
) [pure virtual]

The server invokes this method every time it believes that a noteworthy event has happened.

It is guaranteed that event code values will never change, but new ones can be added in future. This ensures full backward compatibility.

Parameters:
event_codeEvent code, see the sources for the enum with values.
event_argumentValue associated with the event; its meaning depends on the event code.