Added doxygen annotation to the prototype

This commit is contained in:
carlosgp143@gmail.com 2018-05-24 08:53:33 +02:00
parent 262cea11f1
commit b50d143966
1 changed files with 8 additions and 0 deletions

View File

@ -65,6 +65,14 @@ struct coap_request_state {
void (*callback)(coap_request_state_t *state);
};
/**
* \brief Send a CoAP request to a remote endpoint
* \param state The state to handle the CoAP request
* \param endpoint The destination endpoint
* \param request The request to be sent
* \param callback callback to execute when the response arrives or the timeout expires
* \return 1 if there is a transaction available to send, 0 otherwise
*/
int coap_send_request(coap_request_state_t *state, coap_endpoint_t *endpoint,
coap_message_t *request,
void (*callback)(coap_request_state_t *state));