diff options
Diffstat (limited to 'lib/include/radsec/request.h')
| -rw-r--r-- | lib/include/radsec/request.h | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/lib/include/radsec/request.h b/lib/include/radsec/request.h index 4a540bd..ef422b5 100644 --- a/lib/include/radsec/request.h +++ b/lib/include/radsec/request.h @@ -1,3 +1,6 @@ +/** \file request.h + \brief Public interface for libradsec request's. */ + /* See the file COPYING for licensing information. */ struct rs_request; @@ -6,15 +9,30 @@ struct rs_request; extern "C" { #endif +/** Create a request associated with connection \a conn. */ int rs_request_create(struct rs_connection *conn, struct rs_request **req_out); -void rs_request_add_reqpkt(struct rs_request *req, struct rs_packet *reqpkt); +/** Add RADIUS request message \a req_msg to request \a req. */ +void rs_request_add_reqpkt(struct rs_request *req, struct rs_packet *req_msg); +/** Create a request associated with connection \a conn containing a + RADIUS authentication message with \a user_name and \a user_pw + attributes. \a user_name and _user_pw are optional and can be + NULL. */ int rs_request_create_authn(struct rs_connection *conn, struct rs_request **req_out, const char *user_name, const char *user_pw); -int rs_request_send(struct rs_request *request, struct rs_packet **resp_msg); -void rs_request_destroy(struct rs_request *request); +/** Send request \a req and wait for a matching response. The + response is put in \a resp_msg (if not NULL). NOTE: At present, + no more than one outstanding request to a given realm is + supported. This will change in a future version. */ +int rs_request_send(struct rs_request *req, struct rs_packet **resp_msg); + +/** Free all memory allocated by request \a req including the request + packet and any response package associated with the request. Note + that a request must be freed before its associated connection can + be freed. */ +void rs_request_destroy(struct rs_request *req); #if defined (__cplusplus) } |