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

Clarify that rcl_take_response() populates request_header (#205)

Browse source 
* Document rcl_take_response() populates the header
This commit is contained in:
Shane Loretz 2018-01-05 14:32:51 -08:00 • committed by GitHub
parent 1612845d36
commit 0d6ec7728c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
rcl/include/rcl/client.h
View file

@ -257,6 +257,8 @@ rcl_send_request(const rcl_client_t * client, const void * ros_request, int64_t
* occur. * occur.
* The request_header is an rmw struct for meta-information about the request * The request_header is an rmw struct for meta-information about the request
* sent (e.g. the sequence number). * sent (e.g. the sequence number).
* The caller must provide a pointer to an allocated struct.
* This function will populate the struct's fields.
* `ros_response` should point to an already allocated ROS response message * `ros_response` should point to an already allocated ROS response message
* struct of the correct type, into which the response from the service will be * struct of the correct type, into which the response from the service will be
* copied. * copied.