From 751c36d64b78be64fd41c4c5a6ba8ae393bb91f8 Mon Sep 17 00:00:00 2001 From: Linus Nordberg Date: Mon, 14 Mar 2011 00:26:05 +0100 Subject: Add rs_request_get_reqmsg() and update documentation. --- lib/include/radsec/request.h | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) (limited to 'lib/include') diff --git a/lib/include/radsec/request.h b/lib/include/radsec/request.h index ef422b5..e914164 100644 --- a/lib/include/radsec/request.h +++ b/lib/include/radsec/request.h @@ -11,29 +11,34 @@ extern "C" { /** Create a request associated with connection \a conn. */ int rs_request_create(struct rs_connection *conn, struct rs_request **req_out); -/** Add RADIUS request message \a req_msg to request \a req. */ + +/** Add RADIUS request message \a req_msg to request \a req. + FIXME: Rename to rs_request_add_reqmsg? */ 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. */ + newly created RADIUS authentication message, possibly 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); + /** 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. */ +/** Free all memory allocated by request \a req including any request + packet 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); +/** Return request message in request \a req. */ +struct rs_packet *rs_request_get_reqmsg(const struct rs_request *req); + #if defined (__cplusplus) } #endif -- cgit v1.1