Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add setter and getter for domain_id in rcl_init_options_t #678

Merged
merged 4 commits into from
Jun 29, 2020
Merged

Add setter and getter for domain_id in rcl_init_options_t #678

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ca5263
add rcl_init_options_get/set_domain_id.
fujitatomoya Jun 15, 2020
52eed8d
fix description in docblocks.
fujitatomoya Jun 21, 2020
17e0336
add minimal test for rcl_init_options_get/set_domain_id().
fujitatomoya Jun 23, 2020
76adfa9
call rcl_reset_error() after expected failure cases.
fujitatomoya Jun 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions rcl/include/rcl/init_options.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,50 @@ RCL_WARN_UNUSED
rcl_ret_t
rcl_init_options_fini(rcl_init_options_t * init_options);

/// Return the domain_id stored in the init options.
/**
* Get the domain id from the specified rcl_init_options_t object.
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Thread-Safe | Yes
* Uses Atomics | No
* Lock-Free | Yes
*
* \param[in] init_options object from which the domain id should be retrieved.
* \param[out] domain_id domain id to be set in init_options object.
* \return `RCL_RET_OK` if successful, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid.
*/
RCL_PUBLIC
RCL_WARN_UNUSED
rcl_ret_t
rcl_init_options_get_domain_id(rcl_init_options_t * init_options, size_t * domain_id);

/// Set a domain id in the init options provided.
/**
* Store the domain id in the specified init_options object.
*
* <hr>
* Attribute | Adherence
* ------------------ | -------------
* Allocates Memory | No
* Thread-Safe | Yes
* Uses Atomics | No
* Lock-Free | Yes
*
* \param[in] init_options objects in which to set the specified domain id.
* \param[in] domain_id domain id to be set in init_options object.
* \return `RCL_RET_OK` if successful, or
* \return `RCL_RET_INVALID_ARGUMENT` if any arguments are invalid.
*/
RCL_PUBLIC
RCL_WARN_UNUSED
rcl_ret_t
rcl_init_options_set_domain_id(rcl_init_options_t * init_options, size_t domain_id);

/// Return the rmw init options which are stored internally.
/**
* This function can fail and return `NULL` if:
Expand Down
19 changes: 19 additions & 0 deletions rcl/src/rcl/init_options.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,25 @@ rcl_init_options_fini(rcl_init_options_t * init_options)
return RCL_RET_OK;
}

rcl_ret_t
rcl_init_options_get_domain_id(rcl_init_options_t * init_options, size_t * domain_id)
{
RCL_CHECK_ARGUMENT_FOR_NULL(init_options, RCL_RET_INVALID_ARGUMENT);
RCL_CHECK_ARGUMENT_FOR_NULL(init_options->impl, RCL_RET_INVALID_ARGUMENT);
RCL_CHECK_ARGUMENT_FOR_NULL(domain_id, RCL_RET_INVALID_ARGUMENT);
*domain_id = init_options->impl->rmw_init_options.domain_id;
return RCL_RET_OK;
}

rcl_ret_t
rcl_init_options_set_domain_id(rcl_init_options_t * init_options, size_t domain_id)
{
RCL_CHECK_ARGUMENT_FOR_NULL(init_options, RCL_RET_INVALID_ARGUMENT);
RCL_CHECK_ARGUMENT_FOR_NULL(init_options->impl, RCL_RET_INVALID_ARGUMENT);
init_options->impl->rmw_init_options.domain_id = domain_id;
return RCL_RET_OK;
}

rmw_init_options_t *
rcl_init_options_get_rmw_init_options(rcl_init_options_t * init_options)
{
Expand Down
22 changes: 22 additions & 0 deletions rcl/test/rcl/test_init.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,8 +298,30 @@ TEST_F(CLASSNAME(TestRCLFixture, RMW_IMPLEMENTATION), test_rcl_init_options_acce
const rcl_allocator_t * options_allocator = rcl_init_options_get_allocator(&init_options);
EXPECT_TRUE(rcutils_allocator_is_valid(options_allocator));

size_t domain_id;
ret = rcl_init_options_get_domain_id(NULL, &domain_id);
ASSERT_EQ(RCL_RET_INVALID_ARGUMENT, ret) << rcl_get_error_string().str;
ret = rcl_init_options_get_domain_id(&init_options, NULL);
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
ASSERT_EQ(RCL_RET_INVALID_ARGUMENT, ret) << rcl_get_error_string().str;
ret = rcl_init_options_get_domain_id(NULL, NULL);
ASSERT_EQ(RCL_RET_INVALID_ARGUMENT, ret) << rcl_get_error_string().str;
ret = rcl_init_options_set_domain_id(NULL, domain_id);
ASSERT_EQ(RCL_RET_INVALID_ARGUMENT, ret) << rcl_get_error_string().str;

ret = rcl_init_options_get_domain_id(&init_options, &domain_id);
ASSERT_EQ(RCL_RET_OK, ret) << rcl_get_error_string().str;
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
EXPECT_EQ(RCL_DEFAULT_DOMAIN_ID, domain_id);
ret = rcl_init_options_set_domain_id(&init_options, (size_t) 0);
fujitatomoya marked this conversation as resolved.
Show resolved Hide resolved
ASSERT_EQ(RCL_RET_OK, ret) << rcl_get_error_string().str;
ret = rcl_init_options_get_domain_id(&init_options, &domain_id);
ASSERT_EQ(RCL_RET_OK, ret) << rcl_get_error_string().str;
EXPECT_EQ(0U, domain_id);

rcl_init_options_t init_options_dst = rcl_get_zero_initialized_init_options();
EXPECT_EQ(RCL_RET_OK, rcl_init_options_copy(&init_options, &init_options_dst));
ret = rcl_init_options_get_domain_id(&init_options_dst, &domain_id);
ASSERT_EQ(RCL_RET_OK, ret) << rcl_get_error_string().str;
EXPECT_EQ(0U, domain_id);
EXPECT_EQ(RCL_RET_ALREADY_INIT, rcl_init_options_copy(&init_options, &init_options_dst));
EXPECT_EQ(RCL_RET_OK, rcl_init_options_fini(&init_options_dst));
}