Skip to content

Commit

Permalink
Update comments for helper functions
Browse files Browse the repository at this point in the history
Signed-off-by: Barry Xu <Barry.Xu@sony.com>
  • Loading branch information
Barry-Xu-2018 committed May 14, 2020
1 parent bf65de2 commit d32e435
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions rcl/test/rcl/wait_for_entity_helpers.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,43 +19,43 @@
#include "rcl/service.h"
#include "rcl/rcl.h"

/// Wait a server to be available for a client with a node
/// by a maximum trying times and a milliseconds period
/// Wait for a server to be available for `client`, by trying at most `max_tries` times
/// with a `period_ms` period.
bool
wait_for_server_to_be_available(
rcl_node_t * node,
rcl_client_t * client,
size_t max_tries,
int64_t period_ms);

/// Wait a client to be ready with a context
/// by a maximum trying times and a milliseconds period
/// Wait for `client` to be ready, i.e. a response is available to be handled.
/// It's tried at most `max_tries` times with a period of `period_ms`.
bool
wait_for_client_to_be_ready(
rcl_client_t * client,
rcl_context_t * context,
size_t max_tries,
int64_t period_ms);

/// Wait a service to be ready with a context
/// by a maximum trying times and a milliseconds period
/// Wait for service to be ready, i.e. a request is available to be handled.
/// It's tried at most `max_tries` times with a period of `period_ms`.
bool
wait_for_service_to_be_ready(
rcl_service_t * service,
rcl_context_t * context,
size_t max_tries,
int64_t period_ms);

/// Wait a publisher to get one or more established subscriptions
/// by a maximum trying times and a milliseconds period
/// Wait for a publisher to get one or more established subscriptions
/// by trying at most `max_tries` times with a `period_ms` period.
bool
wait_for_established_subscription(
const rcl_publisher_t * publisher,
size_t max_tries,
int64_t period_ms);

/// Wait a subscription to be ready with a context
/// by a maximum trying times and a milliseconds period
/// Wait a subscription to be ready, i.e. a message is ready to be handled,
/// by trying at least `max_tries` times with a `period_ms` period.
bool
wait_for_subscription_to_be_ready(
rcl_subscription_t * subscription,
Expand Down

0 comments on commit d32e435

Please sign in to comment.