Skip to content

Commit

Permalink
Added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianReimold committed Dec 16, 2020
1 parent bb444aa commit 09d415e
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions app/sys/sys_core/include/ecalsys/ecal_sys.h
Original file line number Diff line number Diff line change
Expand Up @@ -373,13 +373,30 @@ class EcalSys
*/
void RestartTaskList (const std::list<std::shared_ptr<EcalSysTask>>& task_list, bool request_shutdown, bool kill_process, const std::string& target_override = "", bool by_name = false, std::chrono::nanoseconds wait_for_shutdown = std::chrono::seconds(3));

// TODO: Document
/**
* @brief Start all tasks
*
* Starts all tasks with respect to the options (local-tasks-only and use-localhost-for-all-tasks)
*/
void StartTasks();

// TODO: Document
/**
* @brief Stops all tasks
*
* Stops all tasks while respecting the options (local-tasks-only).
* The Tasks are stopped "normally", i.e. by an eCAL shutdown signal and a
* subsequent task kill
*/
void StopTasks();

// TODO: Document
/**
* @brief Restarts all tasks
*
* Restarts all tasks with respect to the options (local-tasks-only and
* use-localhost-for-all-tasks).
* The Tasks are stopped "normally", i.e. by an eCAL shutdown signal and a
* subsequent task kill
*/
void RestartTasks();

/**
Expand Down

0 comments on commit 09d415e

Please sign in to comment.