From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- ...assarmnn_1_1profiling_1_1_command_handler.xhtml | 362 +++++++++++++++++++++ 1 file changed, 362 insertions(+) create mode 100644 21.02/classarmnn_1_1profiling_1_1_command_handler.xhtml (limited to '21.02/classarmnn_1_1profiling_1_1_command_handler.xhtml') diff --git a/21.02/classarmnn_1_1profiling_1_1_command_handler.xhtml b/21.02/classarmnn_1_1profiling_1_1_command_handler.xhtml new file mode 100644 index 0000000000..223b7bed19 --- /dev/null +++ b/21.02/classarmnn_1_1profiling_1_1_command_handler.xhtml @@ -0,0 +1,362 @@ + + + + + + + + + + + + + +ArmNN: CommandHandler Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
CommandHandler Class Reference
+
+
+ +

#include <CommandHandler.hpp>

+ + + + + + + + + + + + + + + + +

+Public Member Functions

 CommandHandler (uint32_t timeout, bool stopAfterTimeout, arm::pipe::CommandHandlerRegistry &commandHandlerRegistry, arm::pipe::PacketVersionResolver &packetVersionResolver)
 
 ~CommandHandler ()
 
void SetTimeout (uint32_t timeout)
 
void SetStopAfterTimeout (bool stopAfterTimeout)
 
void Start (IProfilingConnection &profilingConnection)
 
void Stop ()
 
bool IsRunning () const
 
+

Detailed Description

+
+

Definition at line 22 of file CommandHandler.hpp.

+

Constructor & Destructor Documentation

+ +

◆ CommandHandler()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CommandHandler (uint32_t timeout,
bool stopAfterTimeout,
arm::pipe::CommandHandlerRegistry & commandHandlerRegistry,
arm::pipe::PacketVersionResolver & packetVersionResolver 
)
+ 		+inline
+
+ +

Definition at line 25 of file CommandHandler.hpp.

+
29  : m_Timeout(timeout),
30  m_StopAfterTimeout(stopAfterTimeout),
31  m_IsRunning(false),
32  m_KeepRunning(false),
33  m_CommandThread(),
34  m_CommandHandlerRegistry(commandHandlerRegistry),
35  m_PacketVersionResolver(packetVersionResolver)
36  {}
+
+
+ +

◆ ~CommandHandler()

+ +
+
+ + + + + +
+ + + + + + + +
~CommandHandler ()
+ 		+inline
+
+ +

Definition at line 37 of file CommandHandler.hpp.

+ +

References CommandHandler::Stop().

+
37 { Stop(); }
+
+
+
+

Member Function Documentation

+ +

◆ IsRunning()

+ +
+
+ + + + + +
+ + + + + + + +
bool IsRunning () const
+ 		+inline
+
+ +

Definition at line 44 of file CommandHandler.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), and CommandHandler::Start().

+
44 { return m_IsRunning.load(); }
+
+
+ +

◆ SetStopAfterTimeout()

+ +
+
+ + + + + +
+ + + + + + + + +
void SetStopAfterTimeout (bool stopAfterTimeout)
+ 		+inline
+
+ +

Definition at line 40 of file CommandHandler.hpp.

+ +

References CommandHandler::Start(), and CommandHandler::Stop().

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
40 { m_StopAfterTimeout.store(stopAfterTimeout); }
+
+
+ +

◆ SetTimeout()

+ +
+
+ + + + + +
+ + + + + + + + +
void SetTimeout (uint32_t timeout)
+ 		+inline
+
+ +

Definition at line 39 of file CommandHandler.hpp.

+
39 { m_Timeout.store(timeout); }
+
+
+ +

◆ Start()

+ +
+
+ + + + + + + + +
void Start (IProfilingConnection & profilingConnection)
+
+ +

Definition at line 17 of file CommandHandler.cpp.

+ +

References CommandHandler::IsRunning().

+ +

Referenced by BOOST_AUTO_TEST_CASE(), CommandHandler::SetStopAfterTimeout(), and ProfilingService::Update().

+
18 {
19  if (IsRunning())
20  {
21  return;
22  }
23 
24  if (m_CommandThread.joinable())
25  {
26  m_CommandThread.join();
27  }
28 
29  m_IsRunning.store(true);
30  m_KeepRunning.store(true);
31  m_CommandThread = std::thread(&CommandHandler::HandleCommands, this, std::ref(profilingConnection));
32 }
+
+
+
+ +

◆ Stop()

+ +
+
+ + + + + + + +
void Stop ()
+
+ +

Definition at line 34 of file CommandHandler.cpp.

+ +

References ARMNN_ASSERT, ARMNN_LOG, IProfilingConnection::IsOpen(), IProfilingConnection::ReadPacket(), armnn::warning, and Exception::what().

+ +

Referenced by BOOST_AUTO_TEST_CASE(), ProfilingService::GetSendTimelinePacket(), CommandHandler::SetStopAfterTimeout(), ProfilingService::Update(), and CommandHandler::~CommandHandler().

+
35 {
36  m_KeepRunning.store(false);
37 
38  if (m_CommandThread.joinable())
39  {
40  m_CommandThread.join();
41  }
42 }
+
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1