Skip to content

Commit d1d0cae

Browse files
micro-ROS RMW API reference auto-update 29-09-2021 06:25 (#352)
Co-authored-by: pablogs9 <pablogs9@users.noreply.github.com>
1 parent d9fd640 commit d1d0cae

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

_includes/rmw_doc/Modules/group__rmw.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
| rmw_ret_t | **[rmw_uros_set_publisher_session_timeout](#function-rmw_uros_set_publisher_session_timeout)**(rmw_publisher_t * publisher, int session_timeout)<br>Sets the DDS-XRCE session spin time in reliable publication. |
2222
| rmw_ret_t | **[rmw_uros_set_service_session_timeout](#function-rmw_uros_set_service_session_timeout)**(rmw_service_t * service, int session_timeout)<br>Sets the DDS-XRCE session spin time in reliable service server. |
2323
| rmw_ret_t | **[rmw_uros_set_client_session_timeout](#function-rmw_uros_set_client_session_timeout)**(rmw_client_t * client, int session_timeout)<br>Sets the DDS-XRCE session spin time in reliable service client. |
24+
| rmw_ret_t | **[rmw_uros_set_context_entity_creation_session_timeout](#function-rmw_uros_set_context_entity_creation_session_timeout)**(rmw_context_t * context, int session_timeout)<br>Sets the DDS-XRCE session spin time for creating entities. |
25+
| rmw_ret_t | **[rmw_uros_set_context_entity_destroy_session_timeout](#function-rmw_uros_set_context_entity_destroy_session_timeout)**(rmw_context_t * context, int session_timeout)<br>Sets the DDS-XRCE session spin time for destroying entities. |
2426

2527

2628
## Functions Documentation
@@ -411,6 +413,52 @@ Sets the DDS-XRCE session spin time in reliable service client.
411413
* RMW_RET_INVALID_ARGUMENT If client is not valid or unexpected arguments.
412414

413415

416+
### function rmw_uros_set_context_entity_creation_session_timeout
417+
418+
```cpp
419+
rmw_ret_t rmw_uros_set_context_entity_creation_session_timeout(
420+
rmw_context_t * context,
421+
int session_timeout
422+
)
423+
```
424+
425+
Sets the DDS-XRCE session spin time for creating entities.
426+
427+
**Parameters**:
428+
429+
* **context** RWM context where the spin time is configured
430+
* **session_timeout** time in milliseconds
431+
432+
433+
**Return**:
434+
435+
* RMW_RET_OK when success.
436+
* RMW_RET_INVALID_ARGUMENT If client is not valid or unexpected arguments.
437+
438+
439+
### function rmw_uros_set_context_entity_destroy_session_timeout
440+
441+
```cpp
442+
rmw_ret_t rmw_uros_set_context_entity_destroy_session_timeout(
443+
rmw_context_t * context,
444+
int session_timeout
445+
)
446+
```
447+
448+
Sets the DDS-XRCE session spin time for destroying entities.
449+
450+
**Parameters**:
451+
452+
* **context** RWM context where the spin time is configured
453+
* **session_timeout** time in milliseconds
454+
455+
456+
**Return**:
457+
458+
* RMW_RET_OK when success.
459+
* RMW_RET_INVALID_ARGUMENT If client is not valid or unexpected arguments.
460+
461+
414462

415463

416464

0 commit comments

Comments
 (0)