Skip to content

micro-ROS RMW API reference auto-update 29-09-2021 06:25 #352

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

Merged
pablogs9 merged 1 commit into from
Sep 29, 2021
Merged

micro-ROS RMW API reference auto-update 29-09-2021 06:25 #352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 48 additions & 0 deletions _includes/rmw_doc/Modules/group__rmw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |


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


### function rmw_uros_set_context_entity_creation_session_timeout

```cpp
rmw_ret_t rmw_uros_set_context_entity_creation_session_timeout(
rmw_context_t * context,
int session_timeout
)
```

Sets the DDS-XRCE session spin time for creating entities.

**Parameters**:

* **context** RWM context where the spin time is configured
* **session_timeout** time in milliseconds


**Return**:

* RMW_RET_OK when success.
* RMW_RET_INVALID_ARGUMENT If client is not valid or unexpected arguments.


### function rmw_uros_set_context_entity_destroy_session_timeout

```cpp
rmw_ret_t rmw_uros_set_context_entity_destroy_session_timeout(
rmw_context_t * context,
int session_timeout
)
```

Sets the DDS-XRCE session spin time for destroying entities.

**Parameters**:

* **context** RWM context where the spin time is configured
* **session_timeout** time in milliseconds


**Return**:

* RMW_RET_OK when success.
* RMW_RET_INVALID_ARGUMENT If client is not valid or unexpected arguments.





Expand Down