diff options
| author | Trumeet <yuuta@yuuta.moe> | 2022-07-20 20:37:37 -0700 |
|---|---|---|
| committer | Trumeet <yuuta@yuuta.moe> | 2022-07-20 20:37:37 -0700 |
| commit | 41ac44c30b9d165dd90255eec5b817fc21b8f7ff (patch) | |
| tree | cf4fb9a61eef24a96365f54409f47e373ff2e3da /client/libacron/include/requests.h | |
| parent | e2452adee6ba683cbfe093301650503a936a1a94 (diff) | |
| download | acron-41ac44c30b9d165dd90255eec5b817fc21b8f7ff.tar acron-41ac44c30b9d165dd90255eec5b817fc21b8f7ff.tar.gz acron-41ac44c30b9d165dd90255eec5b817fc21b8f7ff.tar.bz2 acron-41ac44c30b9d165dd90255eec5b817fc21b8f7ff.zip | |
docs(libacron): add library docs
Signed-off-by: Trumeet <yuuta@yuuta.moe>
Diffstat (limited to 'client/libacron/include/requests.h')
| -rw-r--r-- | client/libacron/include/requests.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/client/libacron/include/requests.h b/client/libacron/include/requests.h index 40742e0..590bb2e 100644 --- a/client/libacron/include/requests.h +++ b/client/libacron/include/requests.h @@ -66,6 +66,14 @@ typedef struct ac_request_set_config { ac_config_t config; } ac_request_set_config_t; +/** + * Send a request to the connection. If this function succeeds, ac_receive() will return a response + * with the same ID later. + * @param connection Must be a non-NULL and connected connection, or it will return AC_E_INVALID_REQUEST. + * @param request A valid ac_request_t. It will left untouched. + * @return AC_E_OK or an error code. + * MT-Unsafe: Must be called on the same thread calling ac_receive(). + */ int ac_request(void *connection, const ac_request_t *request); #endif /* LIBAC_REQUESTS_H */ |