summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2018-02-13 16:21:52 +0100
committerNikos Mavrogiannopoulos <nmav@redhat.com>2018-02-13 16:21:52 +0100
commit330f61911c2127a27e1e11c05864e55f88da876c (patch)
tree4539b75a94ebbfb176248d4a124c0d7bade4343e
parent87c569c75a4cd79483fd6a963be4a2ce4ef54c48 (diff)
downloadgnutls-330f61911c2127a27e1e11c05864e55f88da876c.tar.gz
doc: updated text on gnutls_handshake_set_hook_function
Signed-off-by: Nikos Mavrogiannopoulos <nmav@redhat.com>
-rw-r--r--lib/includes/gnutls/gnutls.h.in6
-rw-r--r--lib/state.c12
2 files changed, 9 insertions, 9 deletions
diff --git a/lib/includes/gnutls/gnutls.h.in b/lib/includes/gnutls/gnutls.h.in
index deca22ab22..93cddb98c0 100644
--- a/lib/includes/gnutls/gnutls.h.in
+++ b/lib/includes/gnutls/gnutls.h.in
@@ -1577,7 +1577,7 @@ time_t gnutls_db_check_entry_time(gnutls_datum_t * entry);
* gnutls_handshake_hook_func:
* @session: the current session
* @htype: the type of the handshake message (%gnutls_handshake_description_t)
- * @post: non zero if this is a post-process/generation call and zero otherwise
+ * @when: non zero if this is a post-process/generation call and zero otherwise
* @incoming: non zero if this is an incoming message and zero if this is an outgoing message
* @msg: the (const) data of the handshake message without the handshake headers.
*
@@ -1592,11 +1592,11 @@ time_t gnutls_db_check_entry_time(gnutls_datum_t * entry);
typedef int (*gnutls_handshake_hook_func) (gnutls_session_t,
unsigned int htype,
- unsigned post,
+ unsigned when,
unsigned int incoming,
const gnutls_datum_t *msg);
void gnutls_handshake_set_hook_function(gnutls_session_t session,
- unsigned int htype, int post,
+ unsigned int htype, int when,
gnutls_handshake_hook_func func);
#define gnutls_handshake_post_client_hello_func gnutls_handshake_simple_hook_func
diff --git a/lib/state.c b/lib/state.c
index 3a4d80ffc3..2056dd2438 100644
--- a/lib/state.c
+++ b/lib/state.c
@@ -1089,21 +1089,21 @@ gnutls_handshake_set_random(gnutls_session_t session,
* gnutls_handshake_set_hook_function:
* @session: is a #gnutls_session_t type
* @htype: the %gnutls_handshake_description_t of the message to hook at
- * @post: %GNUTLS_HOOK_* depending on when the hook function should be called
+ * @when: %GNUTLS_HOOK_* depending on when the hook function should be called
* @func: is the function to be called
*
* This function will set a callback to be called after or before the specified
* handshake message has been received or generated. This is a
* generalization of gnutls_handshake_set_post_client_hello_function().
*
- * To call the hook function prior to the message being sent/generated use
- * %GNUTLS_HOOK_PRE as @post parameter, %GNUTLS_HOOK_POST to call
+ * To call the hook function prior to the message being generated or processed
+ * use %GNUTLS_HOOK_PRE as @when parameter, %GNUTLS_HOOK_POST to call
* after, and %GNUTLS_HOOK_BOTH for both cases.
*
* This callback must return 0 on success or a gnutls error code to
* terminate the handshake.
*
- * Note to hook at all handshake messages use an @htype of %GNUTLS_HANDSHAKE_ANY.
+ * To hook at all handshake messages use an @htype of %GNUTLS_HANDSHAKE_ANY.
*
* Warning: You should not use this function to terminate the
* handshake based on client input unless you know what you are
@@ -1113,12 +1113,12 @@ gnutls_handshake_set_random(gnutls_session_t session,
void
gnutls_handshake_set_hook_function(gnutls_session_t session,
unsigned int htype,
- int post,
+ int when,
gnutls_handshake_hook_func func)
{
session->internals.h_hook = func;
session->internals.h_type = htype;
- session->internals.h_post = post;
+ session->internals.h_post = when;
}
/**