aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorGravatar Mark D. Roth <roth@google.com>2016-10-12 08:09:30 -0700
committerGravatar Mark D. Roth <roth@google.com>2016-10-12 08:09:30 -0700
commit070a2873c5b19a86a3054c295cba4c20a8640d5d (patch)
tree9b7c4dfa622f0aa78134c17c35007687e24874fb /src
parentc1c38586dedfb4368372a2de03df1645a2a9ee7f (diff)
Improve documentation in method_config.h.
Diffstat (limited to 'src')
-rw-r--r--src/core/ext/client_config/method_config.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/core/ext/client_config/method_config.h b/src/core/ext/client_config/method_config.h
index 04e6bc8141..d228b97948 100644
--- a/src/core/ext/client_config/method_config.h
+++ b/src/core/ext/client_config/method_config.h
@@ -43,7 +43,18 @@
/// Per-method configuration.
typedef struct grpc_method_config grpc_method_config;
+/// Creates a grpc_method_config with the specified parameters.
/// Any parameter may be NULL to indicate that the value is unset.
+///
+/// \a wait_for_ready indicates whether the client should wait until the
+/// request deadline for the channel to become ready, even if there is a
+/// temporary failure before the deadline while attempting to connect.
+///
+/// \a timeout indicates the timeout for calls.
+///
+/// \a max_request_message_bytes and \a max_response_message_bytes
+/// indicate the maximum sizes of the request (checked when sending) and
+/// response (checked when receiving) messages.
grpc_method_config* grpc_method_config_create(
bool* wait_for_ready, gpr_timespec* timeout,
int32_t* max_request_message_bytes, int32_t* max_response_message_bytes);
@@ -51,6 +62,8 @@ grpc_method_config* grpc_method_config_create(
grpc_method_config* grpc_method_config_ref(grpc_method_config* method_config);
void grpc_method_config_unref(grpc_method_config* method_config);
+/// Compares two grpc_method_configs.
+/// The sort order is stable but undefined.
int grpc_method_config_cmp(const grpc_method_config* method_config1,
const grpc_method_config* method_config2);
@@ -84,9 +97,13 @@ grpc_method_config_table* grpc_method_config_table_ref(
grpc_method_config_table* table);
void grpc_method_config_table_unref(grpc_method_config_table* table);
+/// Compares two grpc_method_config_tables.
+/// The sort order is stable but undefined.
int grpc_method_config_table_cmp(const grpc_method_config_table* table1,
const grpc_method_config_table* table2);
+/// Gets the method config for the specified \a path, which should be of
+/// the form "/service/method".
/// Returns NULL if the method has no config.
/// Caller does NOT own a reference to the result.
grpc_method_config* grpc_method_config_table_get_method_config(