Skip to content

Commit

Permalink
Minor review correction
Browse files Browse the repository at this point in the history
Signed-off-by: Javier Gil Aviles <javiergil@eprosima.com>
  • Loading branch information
Javgilavi committed Jan 23, 2025
1 parent 87a3f1a commit d73e7f1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
// Copyright 2025 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ class OrchestratorNode
* @param [in] task_id id identifier of the task that has new data available
* @param [in] node_id id identifier of the node that triggered the new status
* @param [in,out] data pointer that will be redirected to the data
* @return RetCode_t indicating the result of the operation
*/
RetCode_t get_task_data(
const types::TaskId& task_id,
Expand All @@ -126,7 +127,7 @@ class OrchestratorNode
* @brief Get the node status from DB given node identifier.
* @param [in] node_id id identifier of the node that triggered the new status
* @param [in,out] status pointer that will be redirected to the status data
*
* @return RetCode_t indicating the result of the operation
*/
RetCode_t get_node_status(
const NodeID& node_id,
Expand All @@ -136,6 +137,7 @@ class OrchestratorNode
* @brief This method reserves a new Task cache in the DB and returns the place
* where to fill the UserInput entry structure.
* @note It must be called before start_task()
* @return A pair containing the TaskId and a pointer to the UserInput structure.
*/
std::pair<types::TaskId, types::UserInput*> prepare_new_task();

Expand All @@ -144,6 +146,7 @@ class OrchestratorNode
* where to fill the UserInput entry structure.
* @param [in] task_id identifier of the previous task from which to iterate
* @note It must be called before start_task()
* @return A pair containing the TaskId and a pointer to the UserInput structure.
*/
std::pair<types::TaskId, types::UserInput*> prepare_new_iteration(
const types::TaskId& task_id);
Expand Down Expand Up @@ -177,13 +180,15 @@ class OrchestratorNode
/**
* @brief This method sends a request to node via service for changing its configuration and returns the response.
* @param [in] req configuration request, contain which node and configuration file
* @return The response type indicating the result of the configuration request.
*/
types::ResponseType configuration_request(
const types::RequestType& req);

/**
* @brief Public method to get the mutex in order to correctly synchronise user
* handle calls.
* @return A reference to the mutex.
*/
inline std::mutex& get_mutex()
{
Expand All @@ -192,6 +197,7 @@ class OrchestratorNode

/**
* @brief Used to retrieve the associated OrchestratorNodeHandle.
* @return A pointer to the OrchestratorNodeHandle.
*/
inline OrchestratorNodeHandle* get_handler() const
{
Expand Down

0 comments on commit d73e7f1

Please sign in to comment.