niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rename rcl_shutdown to rcl_fini

Browse source
This commit is contained in:
William Woodall 2015-11-24 03:43:23 -08:00
parent 75fafe948a
commit 9631cba157
2 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

4
rcl/include/rcl/node.h
View file

@ -29,7 +29,7 @@ struct rcl_node_impl_t;
/* This handle can be in one a few stats, which are referred to below:
* - uninitialized: memory allocated, but not initialized to anything
* - invalid: memory allocated but not usable
* - either zero initialized or shutdown (rcl_shutdown() or rcl_node_fini())
* - either zero initialized or shutdown (rcl_fini() or rcl_node_fini())
* - valid: memory allocated and usable
*/
typedef struct rcl_node_t {
@ -55,7 +55,7 @@ rcl_node_t
rcl_get_zero_initialized_node();
/// Initialize a ROS node.
/* Calling this on a rcl_node_t makes it a valid node handle until rcl_shutdown
/* Calling this on a rcl_node_t makes it a valid node handle until rcl_fini
* is called or until rcl_node_fini is called on it.
*
* After calling the ROS node object can be used to create other middleware

10
rcl/include/rcl/rcl.h
View file

@ -29,13 +29,13 @@ extern "C"
/* Unless otherwise noted, this must be called before using any rcl functions.
*
* This function can only be run once after starting the program, and once
* after each call to rcl_shutdown.
* after each call to rcl_fini.
* Repeated calls will fail with RCL_RET_ALREADY_INIT.
* This function is not thread safe.
*
* This function can be called any time after rcl_shutdown is called, but it
* This function can be called any time after rcl_fini is called, but it
* cannot be called from within a callback being executed by an rcl executor.
* For example, you can call rcl_shutdown from within a timer callback, but
* For example, you can call rcl_fini from within a timer callback, but
* you have to return from the callback, and therefore exit any in-progress
* call to a spin function, before calling rcl_init again.
*
@ -71,9 +71,9 @@ rcl_init(int argc, char ** argv);
* RCL_RET_NOT_INIT if rcl_init has not yet been called
*/
rcl_ret_t
rcl_shutdown();
rcl_fini();
/// Return true until rcl_shutdown is called, then false.
/// Return true until rcl_fini is called, then false.
/* This function is thread safe. */
bool
rcl_ok();