merged AI doc, some new pages
This commit is contained in:
@@ -1,3 +1,8 @@
|
||||
//! \~\file piintrospection_threads.h
|
||||
//! \~\ingroup Introspection
|
||||
//! \~\brief
|
||||
//! \~english Thread introspection helpers
|
||||
//! \~russian Вспомогательные средства интроспекции потоков
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Introspection module - interface for threads
|
||||
@@ -26,31 +31,108 @@
|
||||
|
||||
class PIIntrospectionThreads;
|
||||
|
||||
# define PIINTROSPECTION_THREADS (PIIntrospectionThreadsInterface::instance())
|
||||
# define PIINTROSPECTION_THREADS (PIIntrospectionThreadsInterface::instance())
|
||||
|
||||
# define PIINTROSPECTION_THREAD_NEW(t) PIINTROSPECTION_THREADS->threadNew(t);
|
||||
# define PIINTROSPECTION_THREAD_DELETE(t) PIINTROSPECTION_THREADS->threadDelete(t);
|
||||
# define PIINTROSPECTION_THREAD_START(t) PIINTROSPECTION_THREADS->threadStart(t);
|
||||
# define PIINTROSPECTION_THREAD_RUN(t) PIINTROSPECTION_THREADS->threadRun(t);
|
||||
# define PIINTROSPECTION_THREAD_WAIT(t) PIINTROSPECTION_THREADS->threadWait(t);
|
||||
# define PIINTROSPECTION_THREAD_STOP(t) PIINTROSPECTION_THREADS->threadStop(t);
|
||||
# define PIINTROSPECTION_THREAD_RUN_DONE(t, us) PIINTROSPECTION_THREADS->threadRunDone(t, us);
|
||||
# ifdef DOXYGEN
|
||||
|
||||
//! \~\ingroup Introspection
|
||||
//! \relatesalso PIIntrospectionThreadsInterface
|
||||
//! \~\brief
|
||||
//! \~english Registers creation of thread object `t`.
|
||||
//! \~russian Регистрирует создание объекта потока `t`.
|
||||
# define PIINTROSPECTION_THREAD_NEW(t)
|
||||
|
||||
//! \~\ingroup Introspection
|
||||
//! \relatesalso PIIntrospectionThreadsInterface
|
||||
//! \~\brief
|
||||
//! \~english Registers destruction of thread object `t`.
|
||||
//! \~russian Регистрирует уничтожение объекта потока `t`.
|
||||
# define PIINTROSPECTION_THREAD_DELETE(t)
|
||||
|
||||
//! \~\ingroup Introspection
|
||||
//! \relatesalso PIIntrospectionThreadsInterface
|
||||
//! \~\brief
|
||||
//! \~english Marks thread `t` as starting.
|
||||
//! \~russian Помечает поток `t` как запускающийся.
|
||||
# define PIINTROSPECTION_THREAD_START(t)
|
||||
|
||||
//! \~\ingroup Introspection
|
||||
//! \relatesalso PIIntrospectionThreadsInterface
|
||||
//! \~\brief
|
||||
//! \~english Marks thread `t` as running.
|
||||
//! \~russian Помечает поток `t` как выполняющийся.
|
||||
# define PIINTROSPECTION_THREAD_RUN(t)
|
||||
|
||||
//! \~\ingroup Introspection
|
||||
//! \relatesalso PIIntrospectionThreadsInterface
|
||||
//! \~\brief
|
||||
//! \~english Marks thread `t` as waiting.
|
||||
//! \~russian Помечает поток `t` как ожидающий.
|
||||
# define PIINTROSPECTION_THREAD_WAIT(t)
|
||||
|
||||
//! \~\ingroup Introspection
|
||||
//! \relatesalso PIIntrospectionThreadsInterface
|
||||
//! \~\brief
|
||||
//! \~english Marks thread `t` as stopped.
|
||||
//! \~russian Помечает поток `t` как остановленный.
|
||||
# define PIINTROSPECTION_THREAD_STOP(t)
|
||||
|
||||
//! \~\ingroup Introspection
|
||||
//! \relatesalso PIIntrospectionThreadsInterface
|
||||
//! \~\brief
|
||||
//! \~english Reports completed run of thread `t` that took `us` microseconds.
|
||||
//! \~russian Сообщает о завершенном проходе потока `t`, занявшем `us` микросекунд.
|
||||
# define PIINTROSPECTION_THREAD_RUN_DONE(t, us)
|
||||
|
||||
# else
|
||||
|
||||
# define PIINTROSPECTION_THREAD_NEW(t) PIINTROSPECTION_THREADS->threadNew(t);
|
||||
# define PIINTROSPECTION_THREAD_DELETE(t) PIINTROSPECTION_THREADS->threadDelete(t);
|
||||
# define PIINTROSPECTION_THREAD_START(t) PIINTROSPECTION_THREADS->threadStart(t);
|
||||
# define PIINTROSPECTION_THREAD_RUN(t) PIINTROSPECTION_THREADS->threadRun(t);
|
||||
# define PIINTROSPECTION_THREAD_WAIT(t) PIINTROSPECTION_THREADS->threadWait(t);
|
||||
# define PIINTROSPECTION_THREAD_STOP(t) PIINTROSPECTION_THREADS->threadStop(t);
|
||||
# define PIINTROSPECTION_THREAD_RUN_DONE(t, us) PIINTROSPECTION_THREADS->threadRunDone(t, us);
|
||||
|
||||
# endif
|
||||
|
||||
//! \~\ingroup Introspection
|
||||
//! \~\brief
|
||||
//! \~english Entry point for collecting state and timing statistics of \a PIThread objects.
|
||||
//! \~russian Точка входа для сбора статистики состояний и времени выполнения объектов \a PIThread.
|
||||
class PIP_EXPORT PIIntrospectionThreadsInterface {
|
||||
friend class PIIntrospection;
|
||||
|
||||
public:
|
||||
__PIINTROSPECTION_SINGLETON_H__(Threads)
|
||||
|
||||
// clang-format off
|
||||
void threadNew (PIThread * t);
|
||||
void threadDelete (PIThread * t);
|
||||
void threadStart (PIThread * t);
|
||||
void threadRun (PIThread * t);
|
||||
void threadWait (PIThread * t);
|
||||
void threadStop (PIThread * t);
|
||||
//! \~english Registers creation of thread object `t`.
|
||||
//! \~russian Регистрирует создание объекта потока `t`.
|
||||
void threadNew(PIThread * t);
|
||||
|
||||
//! \~english Registers destruction of thread object `t`.
|
||||
//! \~russian Регистрирует уничтожение объекта потока `t`.
|
||||
void threadDelete(PIThread * t);
|
||||
|
||||
//! \~english Updates statistics for thread `t` when it starts.
|
||||
//! \~russian Обновляет статистику потока `t` при его запуске.
|
||||
void threadStart(PIThread * t);
|
||||
|
||||
//! \~english Updates statistics for thread `t` when its run handler begins.
|
||||
//! \~russian Обновляет статистику потока `t`, когда начинается его рабочий проход.
|
||||
void threadRun(PIThread * t);
|
||||
|
||||
//! \~english Marks thread `t` as waiting for the next run.
|
||||
//! \~russian Помечает поток `t` как ожидающий следующего прохода.
|
||||
void threadWait(PIThread * t);
|
||||
|
||||
//! \~english Marks thread `t` as stopped.
|
||||
//! \~russian Помечает поток `t` как остановленный.
|
||||
void threadStop(PIThread * t);
|
||||
|
||||
//! \~english Updates averaged run time of thread `t` in microseconds.
|
||||
//! \~russian Обновляет усредненное время выполнения потока `t` в микросекундах.
|
||||
void threadRunDone(PIThread * t, ullong us);
|
||||
// clang-format on
|
||||
|
||||
private:
|
||||
PIIntrospectionThreadsInterface();
|
||||
|
||||
Reference in New Issue
Block a user