From 6c32b805b14b8db044b31fe8152d395927b1467a Mon Sep 17 00:00:00 2001 From: Matthew Stevenson Date: Thu, 5 Sep 2019 13:22:35 -0700 Subject: [PATCH] Modified comments in grpc_security.h, per Sanjay's comments. --- include/grpc/grpc_security.h | 48 ++++++++++++++++++++++-------------- 1 file changed, 30 insertions(+), 18 deletions(-) diff --git a/include/grpc/grpc_security.h b/include/grpc/grpc_security.h index d63802c9782..3918e45aa0b 100644 --- a/include/grpc/grpc_security.h +++ b/include/grpc/grpc_security.h @@ -805,14 +805,19 @@ typedef struct grpc_tls_credential_reload_arg grpc_tls_credential_reload_arg; typedef void (*grpc_tls_on_credential_reload_done_cb)( grpc_tls_credential_reload_arg* arg); -/** A struct containing all information necessary to schedule/cancel - a credential reload request. cb and cb_user_data represent a gRPC-provided - callback and an argument passed to it. key_materials is an in/output - parameter containing currently used/newly reloaded credentials. If - credential reload does not result in a new credential, key_materials should - not be modified. status and error_details are used to hold information about - errors occurred when a credential reload request is scheduled/cancelled. It - is used for experimental purpose for now and subject to change. */ +/** A struct containing all information necessary to schedule/cancel a + credential reload request. + - cb and cb_user_data represent a gRPC-provided + callback and an argument passed to it. + - key_materials_config is an in/output parameter containing currently + used/newly reloaded credentials. If credential reload does not result + in a new credential, key_materials_config should not be modified. + - status and error_details are used to hold information about + errors occurred when a credential reload request is scheduled/cancelled. + - config is a pointer to the unique grpc_tls_credential_reload_config + instance that this argument corresponds to. + It is used for experimental purposes for now and subject to change. +*/ struct grpc_tls_credential_reload_arg { grpc_tls_on_credential_reload_done_cb cb; void* cb_user_data; @@ -864,16 +869,23 @@ typedef void (*grpc_tls_on_server_authorization_check_done_cb)( grpc_tls_server_authorization_check_arg* arg); /** A struct containing all information necessary to schedule/cancel a server - authorization check request. cb and cb_user_data represent a gRPC-provided - callback and an argument passed to it. success will store the result of - server authorization check. That is, if success returns a non-zero value, it - means the authorization check passes and if returning zero, it means the - check fails. target_name is the name of an endpoint the channel is connecting - to and certificate represents a complete certificate chain including both - signing and leaf certificates. status and error_details contain information - about errors occurred when a server authorization check request is - scheduled/cancelled. It is used for experimental purpose for now and subject - to change.*/ + authorization check request. + - cb and cb_user_data represent a gRPC-provided callback and an argument + passed to it. + - success will store the result of server authorization check. That is, + if success returns a non-zero value, it means the authorization check + passes and if returning zero, it means the check fails. + - target_name is the name of an endpoint the channel is connecting to. + - peer_cert represents a complete certificate chain including both + signing and leaf certificates. + - status and error_details contain information + about errors occurred when a server authorization check request is + scheduled/cancelled. + - config is a pointer to the unique + grpc_tls_server_authorization_check_config instance that this argument + corresponds to. + It is used for experimental purpose for now and subject to change. +*/ struct grpc_tls_server_authorization_check_arg { grpc_tls_on_server_authorization_check_done_cb cb; void* cb_user_data;