Lines Matching full:doc

169 #[doc = " The various compression algorithms supported by gRPC (not sorted by"]
170 #[doc = " compression level)"]
180 #[doc = " Compression levels allow a party with knowledge of its peer's accepted"]
181 #[doc = " encodings to request compression in an abstract way. The level-algorithm"]
182 #[doc = " mapping is performed internally and depends on the peer's supported"]
183 #[doc = " compression algorithms."]
195     #[doc = " All algs are enabled by default. This option corresponds to the channel"]
196     #[doc = " argument key behind \\a GRPC_COMPRESSION_CHANNEL_ENABLED_ALGORITHMS_BITSET"]
201 #[doc = " The default compression level. It'll be used in the absence of call"]
202 #[doc = " specific settings. This option corresponds to the channel"]
203 #[doc = " argument key behind \\a GRPC_COMPRESSION_CHANNEL_DEFAULT_LEVEL. If present,"]
204 #[doc = " takes precedence over \\a default_algorithm."]
205 #[doc = " TODO(dgq): currently only available for server channels."]
212 #[doc = " The default message compression algorithm. It'll be used in the absence of"]
213 #[doc = " call specific settings. This option corresponds to the channel argument key"]
214 #[doc = " behind \\a GRPC_COMPRESSION_CHANNEL_DEFAULT_ALGORITHM."]
226 #[doc = " A grpc_slice s, if initialized, represents the byte range"]
227 #[doc = "s.bytes[0..s.length-1]."]
228 #[doc = ""]
229 #[doc = "It can have an associated ref count which has a destruction routine to be run"]
230 #[doc = "when the ref count reaches zero (see grpc_slice_new() and grp_slice_unref())."]
231 #[doc = "Multiple grpc_slice values may share a ref count."]
232 #[doc = ""]
233 #[doc = "If the slice does not have a refcount, it represents an inlined small piece"]
234 #[doc = "of data that is copied by value."]
274 #[doc = " Represents an expandable array of slices, to be interpreted as a"]
275 #[doc = "single item."]
279     #[doc = " This is for internal use only. External users (i.e any code outside grpc"]
280     #[doc = " core) MUST NOT use this field"]
282     #[doc = " slices in the array (Points to the first valid grpc_slice in the array)"]
284     #[doc = " the number of slices in the array"]
286     #[doc = " the number of slices allocated in the array. External users (i.e any code"]
287     #[doc = " outside grpc core) MUST NOT use this field"]
289     #[doc = " the combined length of all slices in the array"]
291     #[doc = " inlined elements to avoid allocations"]
300 #[doc = " The clocks we support."]
303     #[doc = " Monotonic clock. Epoch undefined. Always moves forwards."]
305     #[doc = " Realtime clock. May jump forwards or backwards. Settable by"]
306     #[doc = "the system administrator. Has its epoch at 0:00:00 UTC 1 Jan 1970."]
308     #[doc = " CPU cycle time obtained by rdtsc instruction on x86 platforms. Epoch"]
309     #[doc = "undefined. Degrades to GPR_CLOCK_REALTIME on other platforms."]
311     #[doc = " Unmeasurable clock type: no base, created by taking the difference"]
312     #[doc = "between two times"]
315 #[doc = " Analogous to struct timespec. On some machines, absolute times may be in"]
316 #[doc = " local time."]
322     #[doc = " Against which clock was this time measured? (or GPR_TIMESPAN if"]
323     #[doc = "this is a relative time measure)"]
328     #[doc = " Adds \\a delta to \\a *value, clamping the result to the range specified"]
329     #[doc = "by \\a min and \\a max.  Returns the new value."]
353     #[doc = " Initialize *ev."]
357     #[doc = " Set *ev so that gpr_event_get() and gpr_event_wait() will return value."]
358     #[doc = "Requires:  *ev initialized; value != NULL; no prior or concurrent calls to"]
359     #[doc = "gpr_event_set(ev, ...) since initialization."]
363     #[doc = " Return the value set by gpr_event_set(ev, ...), or NULL if no such call has"]
364     #[doc = "completed.  If the result is non-NULL, all operations that occurred prior to"]
365     #[doc = "the gpr_event_set(ev, ...) set will be visible after this call returns."]
366     #[doc = "Requires:  *ev initialized.  This operation is faster than acquiring a mutex"]
367     #[doc = "on most platforms."]
371     #[doc = " Wait until *ev is set by gpr_event_set(ev, ...), or abs_deadline is"]
372     #[doc = "exceeded, then return gpr_event_get(ev).  Requires:  *ev initialized.  Use"]
373     #[doc = "abs_deadline==gpr_inf_future for no deadline.  When the event has been"]
374     #[doc = "signalled before the call, this operation is faster than acquiring a mutex"]
375     #[doc = "on most platforms."]
382     #[doc = " Initialize *r to value n."]
386     #[doc = " Increment the reference count *r.  Requires *r initialized."]
390     #[doc = " Increment the reference count *r.  Requires *r initialized."]
391     #[doc = "Crashes if refcount is zero"]
395     #[doc = " Increment the reference count *r by n.  Requires *r initialized, n > 0."]
399     #[doc = " Decrement the reference count *r and return non-zero iff it has reached"]
400     #[doc = "zero. .  Requires *r initialized."]
404     #[doc = " Return non-zero iff the reference count of *r is one, and thus is owned"]
405     #[doc = "by exactly one object."]
409     #[doc = " Initialize *c to the value n."]
413     #[doc = " *c += inc.  Requires: *c initialized."]
417     #[doc = " Return *c.  Requires: *c initialized."]
421     #[doc = " Increment the refcount of s. Requires slice is initialized."]
422     #[doc = "Returns s."]
426     #[doc = " Decrement the ref count of s.  If the ref count of s reaches zero, all"]
427     #[doc = "slices sharing the ref count are destroyed, and considered no longer"]
428     #[doc = "initialized.  If s is ultimately derived from a call to grpc_slice_new(start,"]
429     #[doc = "len, dest) where dest!=NULL , then (*dest)(start) is called, else if s is"]
430     #[doc = "ultimately derived from a call to grpc_slice_new_with_len(start, len, dest)"]
431     #[doc = "where dest!=NULL , then (*dest)(start, len).  Requires s initialized."]
435     #[doc = " Copy slice - create a new slice that contains the same data as s"]
439     #[doc = " Create a slice pointing at some data. Calls malloc to allocate a refcount"]
440     #[doc = "for the object, and arranges that destroy will be called with the pointer"]
441     #[doc = "passed in at destruction."]
449     #[doc = " Equivalent to grpc_slice_new, but with a separate pointer that is"]
450     #[doc = "passed to the destroy function.  This function can be useful when"]
451     #[doc = "the data is part of a larger structure that must be destroyed when"]
452     #[doc = "the data is no longer needed."]
461     #[doc = " Equivalent to grpc_slice_new, but with a two argument destroy function that"]
462     #[doc = "also takes the slice length."]
472     #[doc = " Equivalent to grpc_slice_new(malloc(len), len, free), but saves one malloc()"]
473     #[doc = "call."]
474     #[doc = "Aborts if malloc() fails."]
481     #[doc = " Intern a slice:"]
482     #[doc = ""]
483     #[doc = "The return value for two invocations of this function with  the same sequence"]
484     #[doc = "of bytes is a slice which points to the same memory."]
488     #[doc = " Create a slice by copying a string."]
489     #[doc = "Does not preserve null terminators."]
490     #[doc = "Equivalent to:"]
491     #[doc = "size_t len = strlen(source);"]
492     #[doc = "grpc_slice slice = grpc_slice_malloc(len);"]
493     #[doc = "memcpy(slice->data, source, len);"]
497     #[doc = " Create a slice by copying a buffer."]
498     #[doc = "Equivalent to:"]
499     #[doc = "grpc_slice slice = grpc_slice_malloc(len);"]
500     #[doc = "memcpy(slice->data, source, len);"]
507     #[doc = " Create a slice pointing to constant memory"]
511     #[doc = " Create a slice pointing to constant memory"]
518     #[doc = " Return a result slice derived from s, which shares a ref count with \\a s,"]
519     #[doc = "where result.data==s.data+begin, and result.length==end-begin. The ref count"]
520     #[doc = "of \\a s is increased by one. Do not assign result back to \\a s."]
521     #[doc = "Requires s initialized, begin <= end, begin <= s.length, and"]
522     #[doc = "end <= source->length."]
526     #[doc = " The same as grpc_slice_sub, but without altering the ref count"]
530     #[doc = " Splits s into two: modifies s to be s[0:split], and returns a new slice,"]
531     #[doc = "sharing a refcount with s, that contains s[split:s.length]."]
532     #[doc = "Requires s initialized, split <= s.length"]
543     #[doc = " The same as grpc_slice_split_tail, but with an option to skip altering"]
544     #[doc = " refcounts (grpc_slice_split_tail_maybe_ref(..., true) is equivalent to"]
545     #[doc = " grpc_slice_split_tail(...))"]
553     #[doc = " Splits s into two: modifies s to be s[split:s.length], and returns a new"]
554     #[doc = "slice, sharing a refcount with s, that contains s[0:split]."]
555     #[doc = "Requires s initialized, split <= s.length"]
571     #[doc = " Returns <0 if a < b, ==0 if a == b, >0 if a > b"]
572     #[doc = "The order is arbitrary, and is not guaranteed to be stable across different"]
573     #[doc = "versions of the API."]
583     #[doc = " return non-zero if the first blen bytes of a are equal to b"]
591     #[doc = " return the index of the last instance of \\a c in \\a s, or -1 if not found"]
598     #[doc = " return the index of the first occurrence of \\a needle in \\a haystack, or -1"]
599     #[doc = "if it's not found"]
606     #[doc = " Do two slices point at the same memory, with the same length"]
607     #[doc = "If a or b is inlined, actually compares data"]
611     #[doc = " Return a slice pointing to newly allocated memory that has the same contents"]
612     #[doc = " as \\a s"]
616     #[doc = " Return a copy of slice as a C string. Offers no protection against embedded"]
617     #[doc = "NULL's. Returned string must be freed with gpr_free."]
621     #[doc = " Return if an algorithm is message compression algorithm."]
627     #[doc = " Return if an algorithm is stream compression algorithm."]
633     #[doc = " Parses the \\a slice as a grpc_compression_algorithm instance and updating \\a"]
634     #[doc = " algorithm. Returns 1 upon success, 0 otherwise."]
641     #[doc = " Updates \\a name with the encoding name corresponding to a valid \\a"]
642     #[doc = " algorithm. Note that \\a name is statically allocated and must *not* be freed."]
643     #[doc = " Returns 1 upon success, 0 otherwise."]
650     #[doc = " Returns the compression algorithm corresponding to \\a level for the"]
651     #[doc = " compression algorithms encoded in the \\a accepted_encodings bitset."]
661     #[doc = " Mark \\a algorithm as enabled in \\a opts."]
668     #[doc = " Mark \\a algorithm as disabled in \\a opts."]
675     #[doc = " Returns true if \\a algorithm is marked as enabled in \\a opts."]
683     #[doc = " Not an error; returned on success"]
685     #[doc = " The operation was cancelled (typically by the caller)."]
687     #[doc = " Unknown error.  An example of where this error may be returned is"]
688     #[doc = "if a Status value received from another address space belongs to"]
689     #[doc = "an error-space that is not known in this address space.  Also"]
690     #[doc = "errors raised by APIs that do not return enough error information"]
691     #[doc = "may be converted to this error."]
693     #[doc = " Client specified an invalid argument.  Note that this differs"]
694     #[doc = "from FAILED_PRECONDITION.  INVALID_ARGUMENT indicates arguments"]
695     #[doc = "that are problematic regardless of the state of the system"]
696     #[doc = "(e.g., a malformed file name)."]
698     #[doc = " Deadline expired before operation could complete.  For operations"]
699     #[doc = "that change the state of the system, this error may be returned"]
700     #[doc = "even if the operation has completed successfully.  For example, a"]
701     #[doc = "successful response from a server could have been delayed long"]
702     #[doc = "enough for the deadline to expire."]
704     #[doc = " Some requested entity (e.g., file or directory) was not found."]
706     #[doc = " Some entity that we attempted to create (e.g., file or directory)"]
707     #[doc = "already exists."]
709     #[doc = " The caller does not have permission to execute the specified"]
710     #[doc = "operation.  PERMISSION_DENIED must not be used for rejections"]
711     #[doc = "caused by exhausting some resource (use RESOURCE_EXHAUSTED"]
712     #[doc = "instead for those errors).  PERMISSION_DENIED must not be"]
713     #[doc = "used if the caller can not be identified (use UNAUTHENTICATED"]
714     #[doc = "instead for those errors)."]
716     #[doc = " The request does not have valid authentication credentials for the"]
717     #[doc = "operation."]
719     #[doc = " Some resource has been exhausted, perhaps a per-user quota, or"]
720     #[doc = "perhaps the entire file system is out of space."]
722     #[doc = " Operation was rejected because the system is not in a state"]
723     #[doc = "required for the operation's execution.  For example, directory"]
724     #[doc = "to be deleted may be non-empty, an rmdir operation is applied to"]
725     #[doc = "a non-directory, etc."]
726     #[doc = ""]
727     #[doc = "A litmus test that may help a service implementor in deciding"]
728     #[doc = "between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE:"]
729     #[doc = "(a) Use UNAVAILABLE if the client can retry just the failing call."]
730     #[doc = "(b) Use ABORTED if the client should retry at a higher-level"]
731     #[doc = "(e.g., restarting a read-modify-write sequence)."]
732     #[doc = "(c) Use FAILED_PRECONDITION if the client should not retry until"]
733     #[doc = "the system state has been explicitly fixed.  E.g., if an \"rmdir\""]
734     #[doc = "fails because the directory is non-empty, FAILED_PRECONDITION"]
735     #[doc = "should be returned since the client should not retry unless"]
736     #[doc = "they have first fixed up the directory by deleting files from it."]
737     #[doc = "(d) Use FAILED_PRECONDITION if the client performs conditional"]
738     #[doc = "REST Get/Update/Delete on a resource and the resource on the"]
739     #[doc = "server does not match the condition. E.g., conflicting"]
740     #[doc = "read-modify-write on the same resource."]
742     #[doc = " The operation was aborted, typically due to a concurrency issue"]
743     #[doc = "like sequencer check failures, transaction aborts, etc."]
744     #[doc = ""]
745     #[doc = "See litmus test above for deciding between FAILED_PRECONDITION,"]
746     #[doc = "ABORTED, and UNAVAILABLE."]
748     #[doc = " Operation was attempted past the valid range.  E.g., seeking or"]
749     #[doc = "reading past end of file."]
750     #[doc = ""]
751     #[doc = "Unlike INVALID_ARGUMENT, this error indicates a problem that may"]
752     #[doc = "be fixed if the system state changes. For example, a 32-bit file"]
753     #[doc = "system will generate INVALID_ARGUMENT if asked to read at an"]
754     #[doc = "offset that is not in the range [0,2^32-1], but it will generate"]
755     #[doc = "OUT_OF_RANGE if asked to read from an offset past the current"]
756     #[doc = "file size."]
757     #[doc = ""]
758     #[doc = "There is a fair bit of overlap between FAILED_PRECONDITION and"]
759     #[doc = "OUT_OF_RANGE.  We recommend using OUT_OF_RANGE (the more specific"]
760     #[doc = "error) when it applies so that callers who are iterating through"]
761     #[doc = "a space can easily look for an OUT_OF_RANGE error to detect when"]
762     #[doc = "they are done."]
764     #[doc = " Operation is not implemented or not supported/enabled in this service."]
766     #[doc = " Internal errors.  Means some invariants expected by underlying"]
767     #[doc = "system has been broken.  If you see one of these errors,"]
768     #[doc = "something is very broken."]
770     #[doc = " The service is currently unavailable.  This is a most likely a"]
771     #[doc = "transient condition and may be corrected by retrying with"]
772     #[doc = "a backoff. Note that it is not always safe to retry non-idempotent"]
773     #[doc = "operations."]
774     #[doc = ""]
775     #[doc = "WARNING: Although data MIGHT not have been transmitted when this"]
776     #[doc = "status occurs, there is NOT A GUARANTEE that the server has not seen"]
777     #[doc = "anything. So in general it is unsafe to retry on this status code"]
778     #[doc = "if the call is non-idempotent."]
779     #[doc = ""]
780     #[doc = "See litmus test above for deciding between FAILED_PRECONDITION,"]
781     #[doc = "ABORTED, and UNAVAILABLE."]
783     #[doc = " Unrecoverable data loss or corruption."]
785     #[doc = " Force users to include a default branch:"]
873 #[doc = " Type specifier for grpc_arg"]
894 #[doc = " A single argument... each argument has a key and a value"]
895 #[doc = ""]
896 #[doc = "A note on naming keys:"]
897 #[doc = "Keys are namespaced into groups, usually grouped by library, and are"]
898 #[doc = "keys for module XYZ are named XYZ.key1, XYZ.key2, etc. Module names must"]
899 #[doc = "be restricted to the regex [A-Za-z][_A-Za-z0-9]{,15}."]
900 #[doc = "Key names must be restricted to the regex [A-Za-z][_A-Za-z0-9]{,47}."]
901 #[doc = ""]
902 #[doc = "GRPC core library keys are prefixed by grpc."]
903 #[doc = ""]
904 #[doc = "Library authors are strongly encouraged to \\#define symbolic constants for"]
905 #[doc = "their keys so that it's possible to change them in the future."]
941 #[doc = " An array of arguments that can be passed around."]
942 #[doc = ""]
943 #[doc = "Used to set optional channel-level configuration."]
944 #[doc = "These configuration options are modelled as key-value pairs as defined"]
945 #[doc = "by grpc_arg; keys are strings to allow easy backwards-compatible extension"]
946 #[doc = "by arbitrary parties. All evaluation is performed at channel creation"]
947 #[doc = "time (i.e. the keys and values in this structure need only live through the"]
948 #[doc = "creation invocation)."]
949 #[doc = ""]
950 #[doc = "However, if one of the args has grpc_arg_type==GRPC_ARG_POINTER, then the"]
951 #[doc = "grpc_arg_pointer_vtable must live until the channel args are done being"]
952 #[doc = "used by core (i.e. when the object for use with which they were passed"]
953 #[doc = "is destroyed)."]
954 #[doc = ""]
955 #[doc = "See the description of the \\ref grpc_arg_keys \"available args\" for more"]
956 #[doc = "details."]
964 #[doc = " Result of a grpc call. If the caller satisfies the prerequisites of a"]
965 #[doc = "particular operation, the grpc_call_error returned will be GRPC_CALL_OK."]
966 #[doc = "Receiving any other value listed here is an indication of a bug in the"]
967 #[doc = "caller."]
970     #[doc = " everything went ok"]
972     #[doc = " something failed, we don't know what"]
974     #[doc = " this method is not available on the server"]
976     #[doc = " this method is not available on the client"]
978     #[doc = " this method must be called before server_accept"]
980     #[doc = " this method must be called before invoke"]
982     #[doc = " this method must be called after invoke"]
984     #[doc = " this call is already finished"]
985     #[doc = "(writes_done or write_status has already been called)"]
987     #[doc = " there is already an outstanding read/write operation on the call"]
989     #[doc = " the flags value was illegal for this call"]
991     #[doc = " invalid metadata was passed to this call"]
993     #[doc = " invalid message was passed to this call"]
995     #[doc = " completion queue for notification has not been registered"]
996     #[doc = " with the server"]
998     #[doc = " this batch of operations leads to more operations than allowed"]
1000     #[doc = " payload type requested is not the type registered"]
1002     #[doc = " completion queue has been shutdown"]
1005 #[doc = " A single metadata element"]
1009     #[doc = " the key, value values are expected to line up with grpc_mdelem: if"]
1010     #[doc = "changing them, update metadata.h at the same time."]
1016 #[doc = " The following fields are reserved for grpc internal use."]
1017 #[doc = "There is no need to initialize them, and they will be set to garbage"]
1018 #[doc = "during calls to grpc."]
1034 #[doc = " The type of completion (for grpc_event)"]
1037     #[doc = " Shutting down"]
1039     #[doc = " No event before timeout"]
1041     #[doc = " Operation completion"]
1044 #[doc = " The result of an operation."]
1045 #[doc = ""]
1046 #[doc = "Returned by a completion queue when the operation started with tag."]
1050     #[doc = " The type of the completion."]
1052     #[doc = " If the grpc_completion_type is GRPC_OP_COMPLETE, this field indicates"]
1053     #[doc = "whether the operation was successful or not; 0 in case of failure and"]
1054     #[doc = "non-zero in case of success."]
1055     #[doc = "If grpc_completion_type is GRPC_QUEUE_SHUTDOWN or GRPC_QUEUE_TIMEOUT, this"]
1056     #[doc = "field is guaranteed to be 0"]
1058     #[doc = " The tag passed to grpc_call_start_batch etc to start this operation."]
1059     #[doc = "Only* GRPC_OP_COMPLETE has a tag. For all other grpc_completion_type"]
1060     #[doc = "values, tag is uninitialized."]
1087     #[doc = " Send initial metadata: one and only one instance MUST be sent for each"]
1088     #[doc = "call, unless the call was cancelled - in which case this can be skipped."]
1089     #[doc = "This op completes after all bytes of metadata have been accepted by"]
1090     #[doc = "outgoing flow control."]
1092     #[doc = " Send a message: 0 or more of these operations can occur for each call."]
1093     #[doc = "This op completes after all bytes for the message have been accepted by"]
1094     #[doc = "outgoing flow control."]
1096     #[doc = " Send a close from the client: one and only one instance MUST be sent from"]
1097     #[doc = "the client, unless the call was cancelled - in which case this can be"]
1098     #[doc = "skipped. This op completes after all bytes for the call"]
1099     #[doc = "(including the close) have passed outgoing flow control."]
1101     #[doc = " Send status from the server: one and only one instance MUST be sent from"]
1102     #[doc = "the server unless the call was cancelled - in which case this can be"]
1103     #[doc = "skipped. This op completes after all bytes for the call"]
1104     #[doc = "(including the status) have passed outgoing flow control."]
1106     #[doc = " Receive initial metadata: one and only one MUST be made on the client,"]
1107     #[doc = "must not be made on the server."]
1108     #[doc = "This op completes after all initial metadata has been read from the"]
1109     #[doc = "peer."]
1111     #[doc = " Receive a message: 0 or more of these operations can occur for each call."]
1112     #[doc = "This op completes after all bytes of the received message have been"]
1113     #[doc = "read, or after a half-close has been received on this call."]
1115     #[doc = " Receive status on the client: one and only one must be made on the client."]
1116     #[doc = "This operation always succeeds, meaning ops paired with this operation"]
1117     #[doc = "will also appear to succeed, even though they may not have. In that case"]
1118     #[doc = "the status will indicate some failure."]
1119     #[doc = "This op completes after all activity on the call has completed."]
1121     #[doc = " Receive close on the server: one and only one must be made on the"]
1122     #[doc = "server. This op completes after the close has been received by the"]
1123     #[doc = "server. This operation always succeeds, meaning ops paired with"]
1124     #[doc = "this operation will also appear to succeed, even though they may not"]
1125     #[doc = "have."]
1128 #[doc = " Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT"]
1129 #[doc = "which has no arguments)"]
1133     #[doc = " Operation type, as defined by grpc_op_type"]
1135     #[doc = " Write flags bitset for grpc_begin_messages"]
1137     #[doc = " Reserved for future usage"]
1154 #[doc = " Reserved for future usage"]
1163 #[doc = " If \\a is_set, \\a compression_level will be used for the call."]
1164 #[doc = " Otherwise, \\a compression_level won't be considered"]
1175     #[doc = " This op takes ownership of the slices in send_message.  After"]
1176     #[doc = " a call completes, the contents of send_message are not guaranteed"]
1177     #[doc = " and likely empty.  The original owner should still call"]
1178     #[doc = " grpc_byte_buffer_destroy() on this object however."]
1187     #[doc = " optional: set to NULL if no details need sending, non-NULL if they do"]
1188     #[doc = " pointer will not be retained past the start_batch call"]
1191 #[doc = " ownership of the array is with the caller, but ownership of the elements"]
1192 #[doc = "stays with the call object (ie key, value members are owned by the call"]
1193 #[doc = "object, recv_initial_metadata->array is owned by the caller)."]
1194 #[doc = "After the operation completes, call grpc_metadata_array_destroy on this"]
1195 #[doc = "value, or reuse it in a future op."]
1201 #[doc = " ownership of the byte buffer is moved to the caller; the caller must"]
1202 #[doc = "call grpc_byte_buffer_destroy on this value, or reuse it in a future op."]
1203 #[doc = "The returned byte buffer will be NULL if trailing metadata was"]
1204 #[doc = "received instead of a message."]
1213     #[doc = " ownership of the array is with the caller, but ownership of the"]
1214     #[doc = "elements stays with the call object (ie key, value members are owned"]
1215     #[doc = "by the call object, trailing_metadata->array is owned by the caller)."]
1216     #[doc = "After the operation completes, call grpc_metadata_array_destroy on"]
1217     #[doc = "this value, or reuse it in a future op."]
1221     #[doc = " If this is not nullptr, it will be populated with the full fidelity"]
1222     #[doc = " error string for debugging purposes. The application is responsible"]
1223     #[doc = " for freeing the data by using gpr_free()."]
1229     #[doc = " out argument, set to 1 if the call failed at the server for"]
1230     #[doc = "a reason other than a non-OK status (cancel, deadline"]
1231     #[doc = "exceeded, network failure, etc.), 0 otherwise (RPC processing ran to"]
1232     #[doc = "completion and was able to provide any status from the server)"]
1249 #[doc = " Information requested from the channel."]
1253     #[doc = " If non-NULL, will be set to point to a string indicating the LB"]
1254     #[doc = " policy name.  Caller takes ownership."]
1256     #[doc = " If non-NULL, will be set to point to a string containing the"]
1257     #[doc = " service config used by the channel in JSON form."]
1266 #[doc = " Completion queues internally MAY maintain a set of file descriptors in a"]
1267 #[doc = "structure called 'pollset'. This enum specifies if a completion queue has an"]
1268 #[doc = "associated pollset and any restrictions on the type of file descriptors that"]
1269 #[doc = "can be present in the pollset."]
1270 #[doc = ""]
1271 #[doc = "I/O progress can only be made when grpc_completion_queue_next() or"]
1272 #[doc = "grpc_completion_queue_pluck() are called on the completion queue (unless the"]
1273 #[doc = "grpc_cq_polling_type is GRPC_CQ_NON_POLLING) and hence it is very important"]
1274 #[doc = "to actively call these APIs"]
1277     #[doc = " The completion queue will have an associated pollset and there is no"]
1278     #[doc = "restriction on the type of file descriptors the pollset may contain"]
1280     #[doc = " Similar to GRPC_CQ_DEFAULT_POLLING except that the completion queues will"]
1281     #[doc = "not contain any 'listening file descriptors' (i.e file descriptors used to"]
1282     #[doc = "listen to incoming channels)"]
1284     #[doc = " The completion queue will not have an associated pollset. Note that"]
1285     #[doc = "grpc_completion_queue_next() or grpc_completion_queue_pluck() MUST still"]
1286     #[doc = "be called to pop events from the completion queue; it is not required to"]
1287     #[doc = "call them actively to make I/O progress"]
1291 #[doc = " Specifies the type of APIs to use to pop events from the completion queue"]
1294     #[doc = " Events are popped out by calling grpc_completion_queue_next() API ONLY"]
1296     #[doc = " Events are popped out by calling grpc_completion_queue_pluck() API ONLY"]
1298     #[doc = " EXPERIMENTAL: Events trigger a callback specified as the tag"]
1301 #[doc = " EXPERIMENTAL: Specifies an interface class to be used as a tag"]
1302 #[doc = "for callback-based completion queues. This can be used directly,"]
1303 #[doc = "as the first element of a struct in C, or as a base class in C++."]
1304 #[doc = "Its \"run\" value should be assigned to some non-member function, such as"]
1305 #[doc = "a static method."]
1309     #[doc = " The run member specifies a function that will be called when this"]
1310     #[doc = "tag is extracted from the completion queue. Its arguments will be a"]
1311     #[doc = "pointer to this functor and a boolean that indicates whether the"]
1312     #[doc = "operation succeeded (non-zero) or failed (zero)"]
1319     #[doc = " The inlineable member specifies whether this functor can be run inline."]
1320     #[doc = "This should only be used for trivial internally-defined functors."]
1322     #[doc = " The following fields are not API. They are meant for internal use."]
1329     #[doc = " The version number of this structure. More fields might be added to this"]
1330     #[doc = "structure in future."]
1332     #[doc = " Set to GRPC_CQ_CURRENT_VERSION"]
1335     #[doc = " When creating a callbackable CQ, pass in a functor to get invoked when"]
1336     #[doc = " shutdown is complete"]
1345     #[doc = " Returns a RAW byte buffer instance over the given slices (up to \\a nslices)."]
1346     #[doc = ""]
1347     #[doc = " Increases the reference count for all \\a slices processed. The user is"]
1348     #[doc = " responsible for invoking grpc_byte_buffer_destroy on the returned instance."]
1355     #[doc = " Returns a *compressed* RAW byte buffer instance over the given slices (up to"]
1356     #[doc = " \\a nslices). The \\a compression argument defines the compression algorithm"]
1357     #[doc = " used to generate the data in \\a slices."]
1358     #[doc = ""]
1359     #[doc = " Increases the reference count for all \\a slices processed. The user is"]
1360     #[doc = " responsible for invoking grpc_byte_buffer_destroy on the returned instance."]
1368     #[doc = " Copies input byte buffer \\a bb."]
1369     #[doc = ""]
1370     #[doc = " Increases the reference count of all the source slices. The user is"]
1371     #[doc = " responsible for calling grpc_byte_buffer_destroy over the returned copy."]
1375     #[doc = " Returns the size of the given byte buffer, in bytes."]
1379     #[doc = " Destroys \\a byte_buffer deallocating all its memory."]
1383     #[doc = " Initialize \\a reader to read over \\a buffer."]
1384     #[doc = " Returns 1 upon success, 0 otherwise."]
1391     #[doc = " Cleanup and destroy \\a reader"]
1395     #[doc = " Updates \\a slice with the next piece of data from from \\a reader and returns"]
1396     #[doc = " 1. Returns 0 at the end of the stream. Caller is responsible for calling"]
1397     #[doc = " grpc_slice_unref on the result."]
1404     #[doc = " EXPERIMENTAL API - This function may be removed and changed, in the future."]
1405     #[doc = ""]
1406     #[doc = " Updates \\a slice with the next piece of data from from \\a reader and returns"]
1407     #[doc = " 1. Returns 0 at the end of the stream. Caller is responsible for making sure"]
1408     #[doc = " the slice pointer remains valid when accessed."]
1409     #[doc = ""]
1410     #[doc = " NOTE: Do not use this function unless the caller can guarantee that the"]
1411     #[doc = "       underlying grpc_byte_buffer outlasts the use of the slice. This is only"]
1412     #[doc = "       safe when the underlying grpc_byte_buffer remains immutable while slice"]
1413     #[doc = "       is being accessed."]
1420     #[doc = " Merge all data from \\a reader into single slice"]
1424     #[doc = " Returns a RAW byte buffer instance from the output of \\a reader."]
1430     #[doc = " initialize a slice buffer"]
1434     #[doc = " destroy a slice buffer - unrefs any held elements"]
1438     #[doc = " Add an element to a slice buffer - takes ownership of the slice."]
1439     #[doc = "This function is allowed to concatenate the passed in slice to the end of"]
1440     #[doc = "some other slice if desired by the slice buffer."]
1444     #[doc = " add an element to a slice buffer - takes ownership of the slice and returns"]
1445     #[doc = "the index of the slice."]
1446     #[doc = "Guarantees that the slice will not be concatenated at the end of another"]
1447     #[doc = "slice (i.e. the data for this slice will begin at the first byte of the"]
1448     #[doc = "slice at the returned index in sb->slices)"]
1449     #[doc = "The implementation MAY decide to concatenate data at the end of a small"]
1450     #[doc = "slice added in this fashion."]
1457     #[doc = " add a very small (less than 8 bytes) amount of data to the end of a slice"]
1458     #[doc = "buffer: returns a pointer into which to add the data"]
1462     #[doc = " pop the last buffer, but don't unref it"]
1466     #[doc = " clear a slice buffer, unref all elements"]
1470     #[doc = " swap the contents of two slice buffers"]
1474     #[doc = " move all of the elements of src into dst"]
1478     #[doc = " remove n bytes from the end of a slice buffer"]
1486     #[doc = " move the first n bytes of src into dst"]
1494     #[doc = " move the first n bytes of src into dst without adding references"]
1502     #[doc = " move the first n bytes of src into dst (copying them)"]
1510     #[doc = " take the first slice in the slice buffer"]
1514     #[doc = " undo the above with (a possibly different) \\a slice"]
1518 #[doc = " Connectivity state of a channel."]
1521     #[doc = " channel is idle"]
1523     #[doc = " channel is connecting"]
1525     #[doc = " channel is ready for work"]
1527     #[doc = " channel has seen a failure but expects to recover"]
1529     #[doc = " channel has seen a failure that it cannot recover from"]
1533     #[doc = " Time constants."]
1537     #[doc = " The zero time interval."]
1541     #[doc = " The far future"]
1545     #[doc = " initialize time subsystem"]
1549     #[doc = " Return the current time measured from the given clocks epoch."]
1553     #[doc = " Convert a timespec from one clock to another"]
1557     #[doc = " Return -ve, 0, or +ve according to whether a < b, a == b, or a > b"]
1558     #[doc = "respectively."]
1568     #[doc = " Add and subtract times.  Calculations saturate at infinities."]
1575     #[doc = " Return a timespec representing a given number of time units. INT64_MIN is"]
1576     #[doc = "interpreted as gpr_inf_past, and INT64_MAX as gpr_inf_future."]
1598     #[doc = " Return 1 if two times are equal or within threshold of each other,"]
1599     #[doc = "0 otherwise"]
1607     #[doc = " Sleep until at least 'until' - an absolute timeout"]
1614     #[doc = " \\mainpage GRPC Core"]
1615     #[doc = ""]
1616     #[doc = " The GRPC Core library is a low-level library designed to be wrapped by higher"]
1617     #[doc = " level libraries. The top-level API is provided in grpc.h. Security related"]
1618     #[doc = " functionality lives in grpc_security.h."]
1631     #[doc = " Registers a plugin to be initialized and destroyed with the library."]
1632     #[doc = ""]
1633     #[doc = "The \\a init and \\a destroy functions will be invoked as part of"]
1634     #[doc = "\\a grpc_init() and \\a grpc_shutdown(), respectively."]
1635     #[doc = "Note that these functions can be invoked an arbitrary number of times"]
1636     #[doc = "(and hence so will \\a init and \\a destroy)."]
1637     #[doc = "It is safe to pass NULL to either argument. Plugins are destroyed in"]
1638     #[doc = "the reverse order they were initialized."]
1645     #[doc = " Initialize the grpc library."]
1646     #[doc = ""]
1647     #[doc = "After it's called, a matching invocation to grpc_shutdown() is expected."]
1648     #[doc = ""]
1649     #[doc = "It is not safe to call any other grpc functions before calling this."]
1650     #[doc = "(To avoid overhead, little checking is done, and some things may work. We"]
1651     #[doc = "do not warrant that they will continue to do so in future revisions of this"]
1652     #[doc = "library)."]
1656     #[doc = " Shut down the grpc library."]
1657     #[doc = ""]
1658     #[doc = "Before it's called, there should haven been a matching invocation to"]
1659     #[doc = "grpc_init()."]
1660     #[doc = ""]
1661     #[doc = "The last call to grpc_shutdown will initiate cleaning up of grpc library"]
1662     #[doc = "internals, which can happen in another thread. Once the clean-up is done,"]
1663     #[doc = "no memory is used by grpc, nor are any instructions executing within the"]
1664     #[doc = "grpc library.  Prior to calling, all application owned grpc objects must"]
1665     #[doc = "have been destroyed."]
1669     #[doc = " EXPERIMENTAL. Returns 1 if the grpc library has been initialized."]
1670     #[doc = "TODO(ericgribkoff) Decide if this should be promoted to non-experimental as"]
1671     #[doc = "part of stabilizing the fork support API, as tracked in"]
1672     #[doc = "https://github.com/grpc/grpc/issues/15334"]
1676     #[doc = " DEPRECATED. Recommend to use grpc_shutdown only"]
1680     #[doc = " Return a string representing the current version of grpc"]
1684     #[doc = " Return a string specifying what the 'g' in gRPC stands for"]
1688     #[doc = " Returns the completion queue factory based on the attributes. MAY return a"]
1689     #[doc = "NULL if no factory can be found"]
1695     #[doc = " Helper function to create a completion queue with grpc_cq_completion_type"]
1696     #[doc = "of GRPC_CQ_NEXT and grpc_cq_polling_type of GRPC_CQ_DEFAULT_POLLING"]
1702     #[doc = " Helper function to create a completion queue with grpc_cq_completion_type"]
1703     #[doc = "of GRPC_CQ_PLUCK and grpc_cq_polling_type of GRPC_CQ_DEFAULT_POLLING"]
1709     #[doc = " Helper function to create a completion queue with grpc_cq_completion_type"]
1710     #[doc = "of GRPC_CQ_CALLBACK and grpc_cq_polling_type of GRPC_CQ_DEFAULT_POLLING."]
1711     #[doc = "This function is experimental."]
1718     #[doc = " Create a completion queue"]
1726     #[doc = " Blocks until an event is available, the completion queue is being shut down,"]
1727     #[doc = "or deadline is reached."]
1728     #[doc = ""]
1729     #[doc = "Returns a grpc_event with type GRPC_QUEUE_TIMEOUT on timeout,"]
1730     #[doc = "otherwise a grpc_event describing the event that occurred."]
1731     #[doc = ""]
1732     #[doc = "Callers must not call grpc_completion_queue_next and"]
1733     #[doc = "grpc_completion_queue_pluck simultaneously on the same completion queue."]
1741     #[doc = " Blocks until an event with tag 'tag' is available, the completion queue is"]
1742     #[doc = "being shutdown or deadline is reached."]
1743     #[doc = ""]
1744     #[doc = "Returns a grpc_event with type GRPC_QUEUE_TIMEOUT on timeout,"]
1745     #[doc = "otherwise a grpc_event describing the event that occurred."]
1746     #[doc = ""]
1747     #[doc = "Callers must not call grpc_completion_queue_next and"]
1748     #[doc = "grpc_completion_queue_pluck simultaneously on the same completion queue."]
1749     #[doc = ""]
1750     #[doc = "Completion queues support a maximum of GRPC_MAX_COMPLETION_QUEUE_PLUCKERS"]
1751     #[doc = "concurrently executing plucks at any time."]
1760     #[doc = " Begin destruction of a completion queue. Once all possible events are"]
1761     #[doc = "drained then grpc_completion_queue_next will start to produce"]
1762     #[doc = "GRPC_QUEUE_SHUTDOWN events only. At that point it's safe to call"]
1763     #[doc = "grpc_completion_queue_destroy."]
1764     #[doc = ""]
1765     #[doc = "After calling this function applications should ensure that no"]
1766     #[doc = "NEW work is added to be published on this completion queue."]
1770     #[doc = " Destroy a completion queue. The caller must ensure that the queue is"]
1771     #[doc = "drained and no threads are executing grpc_completion_queue_next"]
1775     #[doc = " EXPERIMENTAL API ************/"]
1776     #[doc = " grpc_flush_cq_tls_cache() MUST be called on the same thread,"]
1777     #[doc = " with the same cq."]
1781     #[doc = " EXPERIMENTAL API ************/"]
1782     #[doc = " Returns 1 if there was contents in the cache.  If there was an event"]
1783     #[doc = " in \\a cq tls cache, its tag is placed in tag, and ok is set to the"]
1784     #[doc = " event success."]
1792     #[doc = " Check the connectivity state of a channel."]
1799     #[doc = " Number of active \"external connectivity state watchers\" attached to a"]
1800     #[doc = " channel."]
1801     #[doc = " Useful for testing."]
1807     #[doc = " Watch for a change in connectivity state."]
1808     #[doc = "Once the channel connectivity state is different from last_observed_state,"]
1809     #[doc = "tag will be enqueued on cq with success=1."]
1810     #[doc = "If deadline expires BEFORE the state is changed, tag will be enqueued on cq"]
1811     #[doc = "with success=0."]
1821     #[doc = " Check whether a grpc channel supports connectivity watcher"]
1827     #[doc = " Create a call given a grpc_channel, in order to call 'method'. All"]
1828     #[doc = "completions are sent to 'completion_queue'. 'method' and 'host' need only"]
1829     #[doc = "live through the invocation of this function."]
1830     #[doc = "If parent_call is non-NULL, it must be a server-side call. It will be used"]
1831     #[doc = "to propagate properties from the server call to this new client call,"]
1832     #[doc = "depending on the value of \\a propagation_mask (see propagation_bits.h for"]
1833     #[doc = "possible values)."]
1846     #[doc = " Pre-register a method/host pair on a channel."]
1847     #[doc = "method and host are not owned and must remain alive while the channel is"]
1848     #[doc = "alive."]
1857     #[doc = " Create a call given a handle returned from grpc_channel_register_call."]
1858     #[doc = "\\sa grpc_channel_create_call."]
1870     #[doc = " Allocate memory in the grpc_call arena: this memory is automatically"]
1871     #[doc = "discarded at call completion"]
1875     #[doc = " Start a batch of operations defined in the array ops; when complete, post a"]
1876     #[doc = "completion of type 'tag' to the completion queue bound to the call."]
1877     #[doc = "The order of ops specified in the batch has no significance."]
1878     #[doc = "Only one operation of each type can be active at once in any given"]
1879     #[doc = "batch."]
1880     #[doc = "If a call to grpc_call_start_batch returns GRPC_CALL_OK you must call"]
1881     #[doc = "grpc_completion_queue_next or grpc_completion_queue_pluck on the completion"]
1882     #[doc = "queue associated with 'call' for work to be performed. If a call to"]
1883     #[doc = "grpc_call_start_batch returns any value other than GRPC_CALL_OK it is"]
1884     #[doc = "guaranteed that no state associated with 'call' is changed and it is not"]
1885     #[doc = "appropriate to call grpc_completion_queue_next or"]
1886     #[doc = "grpc_completion_queue_pluck consequent to the failed grpc_call_start_batch"]
1887     #[doc = "call."]
1888     #[doc = "If a call to grpc_call_start_batch with an empty batch returns"]
1889     #[doc = "GRPC_CALL_OK, the tag is put in the completion queue immediately."]
1890     #[doc = "THREAD SAFETY: access to grpc_call_start_batch in multi-threaded environment"]
1891     #[doc = "needs to be synchronized. As an optimization, you may synchronize batches"]
1892     #[doc = "containing just send operations independently from batches containing just"]
1893     #[doc = "receive operations. Access to grpc_call_start_batch with an empty batch is"]
1894     #[doc = "thread-compatible."]
1904     #[doc = " Returns a newly allocated string representing the endpoint to which this"]
1905     #[doc = "call is communicating with. The string is in the uri format accepted by"]
1906     #[doc = "grpc_channel_create."]
1907     #[doc = "The returned string should be disposed of with gpr_free()."]
1908     #[doc = ""]
1909     #[doc = "WARNING: this value is never authenticated or subject to any security"]
1910     #[doc = "related code. It must not be used for any authentication related"]
1911     #[doc = "functionality. Instead, use grpc_auth_context."]
1920     #[doc = " Set census context for a call; Must be called before first call to"]
1921     #[doc = "grpc_call_start_batch()."]
1925     #[doc = " Retrieve the calls current census context."]
1929     #[doc = " Return a newly allocated string representing the target a channel was"]
1930     #[doc = "created for."]
1934     #[doc = " Request info about the channel."]
1935     #[doc = "\\a channel_info indicates what information is being requested and"]
1936     #[doc = "how that information will be returned."]
1937     #[doc = "\\a channel_info is owned by the caller."]
1944     #[doc = " EXPERIMENTAL.  Resets the channel's connect backoff."]
1945     #[doc = "TODO(roth): When we see whether this proves useful, either promote"]
1946     #[doc = "to non-experimental or remove it."]
1950     #[doc = " Create a client channel to 'target'. Additional channel level configuration"]
1951     #[doc = "MAY be provided by grpc_channel_args, though the expectation is that most"]
1952     #[doc = "clients will want to simply pass NULL. The user data in 'args' need only"]
1953     #[doc = "live through the invocation of this function. However, if any args of the"]
1954     #[doc = "'pointer' type are passed, then the referenced vtable must be maintained"]
1955     #[doc = "by the caller until grpc_channel_destroy terminates. See grpc_channel_args"]
1956     #[doc = "definition for more on this."]
1964     #[doc = " Create a lame client: this client fails every operation attempted on it."]
1972     #[doc = " Close and destroy a grpc channel"]
1976     #[doc = " Cancel an RPC."]
1977     #[doc = "Can be called multiple times, from any thread."]
1978     #[doc = "THREAD-SAFETY grpc_call_cancel and grpc_call_cancel_with_status"]
1979     #[doc = "are thread-safe, and can be called at any point before grpc_call_unref"]
1980     #[doc = "is called."]
1987     #[doc = " Cancel an RPC."]
1988     #[doc = "Can be called multiple times, from any thread."]
1989     #[doc = "If a status has not been received for the call, set it to the status code"]
1990     #[doc = "and description passed in."]
1991     #[doc = "Importantly, this function does not send status nor description to the"]
1992     #[doc = "remote endpoint."]
1993     #[doc = "Note that \\a description doesn't need be a static string."]
1994     #[doc = "It doesn't need to be alive after the call to"]
1995     #[doc = "grpc_call_cancel_with_status completes."]
2004     #[doc = " Ref a call."]
2005     #[doc = "THREAD SAFETY: grpc_call_ref is thread-compatible"]
2009     #[doc = " Unref a call."]
2010     #[doc = "THREAD SAFETY: grpc_call_unref is thread-compatible"]
2014     #[doc = " Request notification of a new call."]
2015     #[doc = "Once a call is received, a notification tagged with \\a tag_new is added to"]
2016     #[doc = "\\a cq_for_notification. \\a call, \\a details and \\a request_metadata are"]
2017     #[doc = "updated with the appropriate call information. \\a cq_bound_to_call is bound"]
2018     #[doc = "to \\a call, and batch operation notifications for that call will be posted"]
2019     #[doc = "to \\a cq_bound_to_call."]
2020     #[doc = "Note that \\a cq_for_notification must have been registered to the server via"]
2021     #[doc = "\\a grpc_server_register_completion_queue."]
2033 #[doc = " How to handle payloads for a registered method"]
2036     #[doc = " Don't try to read the payload"]
2038     #[doc = " Read the initial payload as a byte buffer"]
2042     #[doc = " Registers a method in the server."]
2043     #[doc = "Methods to this (host, method) pair will not be reported by"]
2044     #[doc = "grpc_server_request_call, but instead be reported by"]
2045     #[doc = "grpc_server_request_registered_call when passed the appropriate"]
2046     #[doc = "registered_method (as returned by this function)."]
2047     #[doc = "Must be called before grpc_server_start."]
2048     #[doc = "Returns NULL on failure."]
2058     #[doc = " Request notification of a new pre-registered call. 'cq_for_notification'"]
2059     #[doc = "must have been registered to the server via"]
2060     #[doc = "grpc_server_register_completion_queue."]
2074     #[doc = " Create a server. Additional configuration for each incoming channel can"]
2075     #[doc = "be specified with args. If no additional configuration is needed, args can"]
2076     #[doc = "be NULL. The user data in 'args' need only live through the invocation of"]
2077     #[doc = "this function. However, if any args of the 'pointer' type are passed, then"]
2078     #[doc = "the referenced vtable must be maintained by the caller until"]
2079     #[doc = "grpc_server_destroy terminates. See grpc_channel_args definition for more"]
2080     #[doc = "on this."]
2087     #[doc = " Register a completion queue with the server. Must be done for any"]
2088     #[doc = "notification completion queue that is passed to grpc_server_request_*_call"]
2089     #[doc = "and to grpc_server_shutdown_and_notify. Must be performed prior to"]
2090     #[doc = "grpc_server_start."]
2103     #[doc = " EXPERIMENTAL.  Creates an xDS config fetcher."]
2107     #[doc = " EXPERIMENTAL.  Destroys a config fetcher."]
2111     #[doc = " EXPERIMENTAL.  Sets the server's config fetcher.  Takes ownership."]
2112     #[doc = "Must be called before adding ports"]
2119     #[doc = " Add a HTTP2 over plaintext over tcp listener."]
2120     #[doc = "Returns bound port number on success, 0 on failure."]
2121     #[doc = "REQUIRES: server not started"]
2128     #[doc = " Start a server - tells all listeners to start listening"]
2132     #[doc = " Begin shutting down a server."]
2133     #[doc = "After completion, no new calls or connections will be admitted."]
2134     #[doc = "Existing calls will be allowed to complete."]
2135     #[doc = "Send a GRPC_OP_COMPLETE event when there are no more calls being serviced."]
2136     #[doc = "Shutdown is idempotent, and all tags will be notified at once if multiple"]
2137     #[doc = "grpc_server_shutdown_and_notify calls are made. 'cq' must have been"]
2138     #[doc = "registered to this server via grpc_server_register_completion_queue."]
2146     #[doc = " Cancel all in-progress calls."]
2147     #[doc = "Only usable after shutdown."]
2151     #[doc = " Destroy a server."]
2152     #[doc = "Shutdown must have completed beforehand (i.e. all tags generated by"]
2153     #[doc = "grpc_server_shutdown_and_notify must have been received, and at least"]
2154     #[doc = "one call to grpc_server_shutdown_and_notify must have been made)."]
2158     #[doc = " Enable or disable a tracer."]
2159     #[doc = ""]
2160     #[doc = "Tracers (usually controlled by the environment variable GRPC_TRACE)"]
2161     #[doc = "allow printf-style debugging on GRPC internals, and are useful for"]
2162     #[doc = "tracking down problems in the field."]
2163     #[doc = ""]
2164     #[doc = "Use of this function is not strictly thread-safe, but the"]
2165     #[doc = "thread-safety issues raised by it should not be of concern."]
2172     #[doc = " Check whether a metadata key is legal (will be accepted by core)"]
2176     #[doc = " Check whether a non-binary metadata value is legal (will be accepted by"]
2177     #[doc = "core)"]
2181     #[doc = " Check whether a metadata key corresponds to a binary value"]
2185     #[doc = " Convert grpc_call_error values to a string"]
2189     #[doc = " Create a buffer pool"]
2195     #[doc = " Add a reference to a buffer pool"]
2199     #[doc = " Drop a reference to a buffer pool"]
2203     #[doc = " Update the size of a buffer pool"]
2207     #[doc = " Update the size of the maximum number of threads allowed"]
2214     #[doc = " Fetch a vtable for a grpc_channel_arg that points to a grpc_resource_quota"]
2218     #[doc = " CHANNELZ API *************/"]
2219     #[doc = "churn as the feature is implemented. This comment will be removed once"]
2220     #[doc = "channelz is officially supported, and these APIs become stable. For now"]
2221     #[doc = "you may track the progress by following this github issue:"]
2222     #[doc = "https://github.com/grpc/grpc/issues/15340"]
2223     #[doc = ""]
2224     #[doc = "the following APIs return allocated JSON strings that match the response"]
2225     #[doc = "objects from the channelz proto, found here:"]
2226     #[doc = "https://github.com/grpc/grpc/blob/master/src/proto/grpc/channelz/channelz.proto."]
2227     #[doc = ""]
2228     #[doc = "For easy conversion to protobuf, The JSON is formatted according to:"]
2229     #[doc = "https://developers.google.com/protocol-buffers/docs/proto3#json."]
2263     #[doc = " Create a client channel to 'target' using file descriptor 'fd'. The 'target'"]
2264     #[doc = "argument will be used to indicate the name for this channel. See the comment"]
2265     #[doc = "for grpc_insecure_channel_create for description of 'args' argument."]
2273     #[doc = " Add the connected communication channel based on file descriptor 'fd' to the"]
2274     #[doc = "'server'. The 'fd' must be an open file descriptor corresponding to a"]
2275     #[doc = "connected socket. Events from the file descriptor may come on any of the"]
2276     #[doc = "server completion queues (i.e completion queues registered via the"]
2277     #[doc = "grpc_server_register_completion_queue API)."]
2278     #[doc = ""]
2279     #[doc = "The 'reserved' pointer MUST be NULL."]
2287 #[doc = " Results for the SSL roots override callback."]
2292     #[doc = " Do not try fallback options."]
2296 #[doc = " Callback results for dynamically loading a SSL certificate config."]
2306     #[doc = " Server does not request client certificate."]
2307     #[doc = "The certificate presented by the client is not checked by the server at"]
2308     #[doc = "all. (A client may present a self signed or signed certificate or not"]
2309     #[doc = "present a certificate at all and any of those option would be accepted)"]
2311     #[doc = " Server requests client certificate but does not enforce that the client"]
2312     #[doc = "presents a certificate."]
2313     #[doc = ""]
2314     #[doc = "If the client presents a certificate, the client authentication is left to"]
2315     #[doc = "the application (the necessary metadata will be available to the"]
2316     #[doc = "application via authentication context properties, see grpc_auth_context)."]
2317     #[doc = ""]
2318     #[doc = "The client's key certificate pair must be valid for the SSL connection to"]
2319     #[doc = "be established."]
2321     #[doc = " Server requests client certificate but does not enforce that the client"]
2322     #[doc = "presents a certificate."]
2323     #[doc = ""]
2324     #[doc = "If the client presents a certificate, the client authentication is done by"]
2325     #[doc = "the gRPC framework. (For a successful connection the client needs to either"]
2326     #[doc = "present a certificate that can be verified against the root certificate"]
2327     #[doc = "configured by the server or not present a certificate at all)"]
2328     #[doc = ""]
2329     #[doc = "The client's key certificate pair must be valid for the SSL connection to"]
2330     #[doc = "be established."]
2332     #[doc = " Server requests client certificate and enforces that the client presents a"]
2333     #[doc = "certificate."]
2334     #[doc = ""]
2335     #[doc = "If the client presents a certificate, the client authentication is left to"]
2336     #[doc = "the application (the necessary metadata will be available to the"]
2337     #[doc = "application via authentication context properties, see grpc_auth_context)."]
2338     #[doc = ""]
2339     #[doc = "The client's key certificate pair must be valid for the SSL connection to"]
2340     #[doc = "be established."]
2342     #[doc = " Server requests client certificate and enforces that the client presents a"]
2343     #[doc = "certificate."]
2344     #[doc = ""]
2345     #[doc = "The certificate presented by the client is verified by the gRPC framework."]
2346     #[doc = "(For a successful connection the client needs to present a certificate that"]
2347     #[doc = "can be verified against the root certificate configured by the server)"]
2348     #[doc = ""]
2349     #[doc = "The client's key certificate pair must be valid for the SSL connection to"]
2350     #[doc = "be established."]
2370     #[doc = " Default option: performs server certificate verification and hostname"]
2371     #[doc = "verification."]
2373     #[doc = " Performs server certificate verification, but skips hostname verification"]
2374     #[doc = "Client is responsible for verifying server's identity via"]
2375     #[doc = "server authorization check callback."]
2377     #[doc = " Skips both server certificate and hostname verification."]
2378     #[doc = "Client is responsible for verifying server's identity and"]
2379     #[doc = "server's certificate via server authorization check callback."]
2383 #[doc = " Type of local connections for which local channel/server credentials will be"]
2384 #[doc = " applied. It supports UDS and local TCP connections."]
2391 #[doc = " The TLS versions that are supported by the SSL stack."]
2409 #[doc = " value, if not NULL, is guaranteed to be NULL terminated."]
2418     #[doc = " Returns NULL when the iterator is at the end."]
2424     #[doc = " Iterates over the auth context."]
2430     #[doc = " Gets the peer identity. Returns an empty iterator (first _next will return"]
2431     #[doc = "NULL) if the peer is not authenticated."]
2437     #[doc = " Finds a property in the context. May return an empty iterator (first _next"]
2438     #[doc = "will return NULL) if no property with this name was found in the context."]
2445     #[doc = " Gets the name of the property that indicates the peer identity. Will return"]
2446     #[doc = "NULL if the peer is not authenticated."]
2452     #[doc = " Returns 1 if the peer is authenticated, 0 otherwise."]
2458     #[doc = " Gets the auth context from the call. Caller needs to call"]
2459     #[doc = "grpc_auth_context_release on the returned context."]
2463     #[doc = " Releases the auth context returned from grpc_call_auth_context."]
2467     #[doc = " Add a property."]
2476     #[doc = " Add a C string property."]
2484     #[doc = " Sets the property name. Returns 1 if successful or 0 in case of failure"]
2485     #[doc = "(which means that no property with this name exists)."]
2497     #[doc = " Create LRU cache for client-side SSL sessions with the given capacity."]
2498     #[doc = "If capacity is < 1, a default capacity is used instead."]
2502     #[doc = " Destroy SSL session cache."]
2506     #[doc = " Create a channel arg with the given cache object."]
2517     #[doc = " Releases a call credentials object."]
2518     #[doc = "The creator of the credentials object is responsible for its release."]
2527     #[doc = " Releases a channel credentials object."]
2528     #[doc = "The creator of the credentials object is responsible for its release."]
2532     #[doc = " Creates default credentials to connect to a google gRPC service."]
2533     #[doc = "WARNING: Do NOT use this credentials to connect to a non-google service as"]
2534     #[doc = "this could result in an oauth2 token leak. The security level of the"]
2535     #[doc = "resulting connection is GRPC_PRIVACY_AND_INTEGRITY."]
2536     #[doc = ""]
2537     #[doc = "If specified, the supplied call credentials object will be attached to the"]
2538     #[doc = "returned channel credentials object. The call_credentials object must remain"]
2539     #[doc = "valid throughout the lifetime of the returned grpc_channel_credentials"]
2540     #[doc = "object. It is expected that the call credentials object was generated"]
2541     #[doc = "according to the Application Default Credentials mechanism and asserts the"]
2542     #[doc = "identity of the default service account of the machine. Supplying any other"]
2543     #[doc = "sort of call credential will result in undefined behavior, up to and"]
2544     #[doc = "including the sudden and unexpected failure of RPCs."]
2545     #[doc = ""]
2546     #[doc = "If nullptr is supplied, the returned channel credentials object will use a"]
2547     #[doc = "call credentials object based on the Application Default Credentials"]
2548     #[doc = "mechanism."]
2553 #[doc = " Callback for getting the SSL roots override from the application."]
2554 #[doc = "In case of success, *pem_roots_certs must be set to a NULL terminated string"]
2555 #[doc = "containing the list of PEM encoded root certificates. The ownership is passed"]
2556 #[doc = "to the core and freed (laster by the core) with gpr_free."]
2557 #[doc = "If this function fails and GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment is"]
2558 #[doc = "set to a valid path, it will override the roots specified this func"]
2565     #[doc = " Setup a callback to override the default TLS/SSL roots."]
2566     #[doc = "This function is not thread-safe and must be called at initialization time"]
2567     #[doc = "before any ssl credentials are created to have the desired side effect."]
2568     #[doc = "If GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment is set to a valid path, the"]
2569     #[doc = "callback will not be called."]
2572 #[doc = " Object that holds a private key / certificate chain pair in PEM format."]
2576     #[doc = " private_key is the NULL-terminated string containing the PEM encoding of"]
2577     #[doc = "the client's private key."]
2579     #[doc = " cert_chain is the NULL-terminated string containing the PEM encoding of"]
2580     #[doc = "the client's certificate chain."]
2583 #[doc = " Deprecated in favor of grpc_ssl_verify_peer_options. It will be removed"]
2584 #[doc = "after all of its call sites are migrated to grpc_ssl_verify_peer_options."]
2585 #[doc = "Object that holds additional peer-verification options on a secure"]
2586 #[doc = "channel."]
2590     #[doc = " If non-NULL this callback will be invoked with the expected"]
2591     #[doc = "target_name, the peer's certificate (in PEM format), and whatever"]
2592     #[doc = "userdata pointer is set below. If a non-zero value is returned by this"]
2593     #[doc = "callback then it is treated as a verification failure. Invocation of"]
2594     #[doc = "the callback is blocking, so any implementation should be light-weight."]
2602     #[doc = " Arbitrary userdata that will be passed as the last argument to"]
2603     #[doc = "verify_peer_callback."]
2605     #[doc = " A destruct callback that will be invoked when the channel is being"]
2606     #[doc = "cleaned up. The userdata argument will be passed to it. The intent is"]
2607     #[doc = "to perform any cleanup associated with that userdata."]
2611 #[doc = " Object that holds additional peer-verification options on a secure"]
2612 #[doc = "channel."]
2616     #[doc = " If non-NULL this callback will be invoked with the expected"]
2617     #[doc = "target_name, the peer's certificate (in PEM format), and whatever"]
2618     #[doc = "userdata pointer is set below. If a non-zero value is returned by this"]
2619     #[doc = "callback then it is treated as a verification failure. Invocation of"]
2620     #[doc = "the callback is blocking, so any implementation should be light-weight."]
2628     #[doc = " Arbitrary userdata that will be passed as the last argument to"]
2629     #[doc = "verify_peer_callback."]
2631     #[doc = " A destruct callback that will be invoked when the channel is being"]
2632     #[doc = "cleaned up. The userdata argument will be passed to it. The intent is"]
2633     #[doc = "to perform any cleanup associated with that userdata."]
2638     #[doc = " Deprecated in favor of grpc_ssl_server_credentials_create_ex. It will be"]
2639     #[doc = "removed after all of its call sites are migrated to"]
2640     #[doc = "grpc_ssl_server_credentials_create_ex. Creates an SSL credentials object."]
2641     #[doc = "The security level of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY."]
2642     #[doc = "- pem_root_certs is the NULL-terminated string containing the PEM encoding"]
2643     #[doc = "of the server root certificates. If this parameter is NULL, the"]
2644     #[doc = "implementation will first try to dereference the file pointed by the"]
2645     #[doc = "GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable, and if that fails,"]
2646     #[doc = "try to get the roots set by grpc_override_ssl_default_roots. Eventually,"]
2647     #[doc = "if all these fail, it will try to get the roots from a well-known place on"]
2648     #[doc = "disk (in the grpc install directory)."]
2649     #[doc = ""]
2650     #[doc = "gRPC has implemented root cache if the underlying OpenSSL library supports"]
2651     #[doc = "it. The gRPC root certificates cache is only applicable on the default"]
2652     #[doc = "root certificates, which is used when this parameter is nullptr. If user"]
2653     #[doc = "provides their own pem_root_certs, when creating an SSL credential object,"]
2654     #[doc = "gRPC would not be able to cache it, and each subchannel will generate a"]
2655     #[doc = "copy of the root store. So it is recommended to avoid providing large room"]
2656     #[doc = "pem with pem_root_certs parameter to avoid excessive memory consumption,"]
2657     #[doc = "particularly on mobile platforms such as iOS."]
2658     #[doc = "- pem_key_cert_pair is a pointer on the object containing client's private"]
2659     #[doc = "key and certificate chain. This parameter can be NULL if the client does"]
2660     #[doc = "not have such a key/cert pair."]
2661     #[doc = "- verify_options is an optional verify_peer_options object which holds"]
2662     #[doc = "additional options controlling how peer certificates are verified. For"]
2663     #[doc = "example, you can supply a callback which receives the peer's certificate"]
2664     #[doc = "with which you can do additional verification. Can be NULL, in which"]
2665     #[doc = "case verification will retain default behavior. Any settings in"]
2666     #[doc = "verify_options are copied during this call, so the verify_options"]
2667     #[doc = "object can be released afterwards."]
2684     #[doc = " Creates a composite channel credentials object. The security level of"]
2685     #[doc = " resulting connection is determined by channel_creds."]
2693     #[doc = " Creates a composite call credentials object."]
2701     #[doc = " Creates a compute engine credentials object for connecting to Google."]
2702     #[doc = "WARNING: Do NOT use this credentials to connect to a non-google service as"]
2703     #[doc = "this could result in an oauth2 token leak."]
2712     #[doc = " Creates a JWT credentials object. May return NULL if the input is invalid."]
2713     #[doc = "- json_key is the JSON key string containing the client's private key."]
2714     #[doc = "- token_lifetime is the lifetime of each Json Web Token (JWT) created with"]
2715     #[doc = "this credentials.  It should not exceed grpc_max_auth_token_lifetime or"]
2716     #[doc = "will be cropped to this value."]
2724     #[doc = " Builds External Account credentials."]
2725     #[doc = "- json_string is the JSON string containing the credentials options."]
2726     #[doc = "- scopes_string contains the scopes to be binded with the credentials."]
2727     #[doc = "This API is used for experimental purposes for now and may change in the"]
2728     #[doc = "future."]
2735     #[doc = " Creates an Oauth2 Refresh Token credentials object for connecting to Google."]
2736     #[doc = "May return NULL if the input is invalid."]
2737     #[doc = "WARNING: Do NOT use this credentials to connect to a non-google service as"]
2738     #[doc = "this could result in an oauth2 token leak."]
2739     #[doc = "- json_refresh_token is the JSON string containing the refresh token itself"]
2740     #[doc = "along with a client_id and client_secret."]
2747     #[doc = " Creates an Oauth2 Access Token credentials with an access token that was"]
2748     #[doc = "acquired by an out of band mechanism."]
2755     #[doc = " Creates an IAM credentials object for connecting to Google."]
2762 #[doc = " Options for creating STS Oauth Token Exchange credentials following the IETF"]
2763 #[doc = "draft https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16."]
2764 #[doc = "Optional fields may be set to NULL or empty string. It is the responsibility"]
2765 #[doc = "of the caller to ensure that the subject and actor tokens are refreshed on"]
2766 #[doc = "disk at the specified paths. This API is used for experimental purposes for"]
2767 #[doc = "now and may change in the future."]
2782     #[doc = " Creates an STS credentials following the STS Token Exchanged specifed in the"]
2783     #[doc = "IETF draft https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16."]
2784     #[doc = "This API is used for experimental purposes for now and may change in the"]
2785     #[doc = "future."]
2791 #[doc = " Callback function to be called by the metadata credentials plugin"]
2792 #[doc = "implementation when the metadata is ready."]
2793 #[doc = "- user_data is the opaque pointer that was passed in the get_metadata method"]
2794 #[doc = "of the grpc_metadata_credentials_plugin (see below)."]
2795 #[doc = "- creds_md is an array of credentials metadata produced by the plugin. It"]
2796 #[doc = "may be set to NULL in case of an error."]
2797 #[doc = "- num_creds_md is the number of items in the creds_md array."]
2798 #[doc = "- status must be GRPC_STATUS_OK in case of success or another specific error"]
2799 #[doc = "code otherwise."]
2800 #[doc = "- error_details contains details about the error if any. In case of success"]
2801 #[doc = "it should be NULL and will be otherwise ignored."]
2811 #[doc = " Context that can be used by metadata credentials plugin in order to create"]
2812 #[doc = "auth related metadata."]
2816     #[doc = " The fully qualifed service url."]
2818     #[doc = " The method name of the RPC being called (not fully qualified)."]
2819     #[doc = "The fully qualified method name can be built from the service_url:"]
2820     #[doc = "full_qualified_method_name = ctx->service_url + '/' + ctx->method_name."]
2822     #[doc = " The auth_context of the channel which gives the server's identity."]
2824     #[doc = " Reserved for future use."]
2828     #[doc = " Performs a deep copy from \\a from to \\a to."]
2835     #[doc = " Releases internal resources held by \\a context."]
2838 #[doc = " grpc_metadata_credentials plugin is an API user provided structure used to"]
2839 #[doc = "create grpc_credentials objects that can be set on a channel (composed) or"]
2840 #[doc = "a call. See grpc_credentials_metadata_create_from_plugin below."]
2841 #[doc = "The grpc client stack will call the get_metadata method of the plugin for"]
2842 #[doc = "every call in scope for the credentials created from it."]
2846     #[doc = " The implementation of this method has to be non-blocking, but can"]
2847     #[doc = "be performed synchronously or asynchronously."]
2848     #[doc = ""]
2849     #[doc = "If processing occurs synchronously, returns non-zero and populates"]
2850     #[doc = "creds_md, num_creds_md, status, and error_details.  In this case,"]
2851     #[doc = "the caller takes ownership of the entries in creds_md and of"]
2852     #[doc = "error_details.  Note that if the plugin needs to return more than"]
2853     #[doc = "GRPC_METADATA_CREDENTIALS_PLUGIN_SYNC_MAX entries in creds_md, it must"]
2854     #[doc = "return asynchronously."]
2855     #[doc = ""]
2856     #[doc = "If processing occurs asynchronously, returns zero and invokes \\a cb"]
2857     #[doc = "when processing is completed.  \\a user_data will be passed as the"]
2858     #[doc = "first parameter of the callback.  NOTE: \\a cb MUST be invoked in a"]
2859     #[doc = "different thread, not from the thread in which \\a get_metadata() is"]
2860     #[doc = "invoked."]
2861     #[doc = ""]
2862     #[doc = "\\a context is the information that can be used by the plugin to create"]
2863     #[doc = "auth metadata."]
2876     #[doc = " Implements debug string of the given plugin. This method returns an"]
2877     #[doc = " allocated string that the caller needs to free using gpr_free()"]
2881     #[doc = " Destroys the plugin state."]
2883     #[doc = " State that will be set as the first parameter of the methods above."]
2885     #[doc = " Type of credentials that this plugin is implementing."]
2889     #[doc = " Creates a credentials object from a plugin with a specified minimum security"]
2890     #[doc = " level."]
2898     #[doc = " Creates a secure channel using the passed-in credentials. Additional"]
2899     #[doc = "channel level configuration MAY be provided by grpc_channel_args, though"]
2900     #[doc = "the expectation is that most clients will want to simply pass NULL. The"]
2901     #[doc = "user data in 'args' need only live through the invocation of this function."]
2902     #[doc = "However, if any args of the 'pointer' type are passed, then the referenced"]
2903     #[doc = "vtable must be maintained by the caller until grpc_channel_destroy"]
2904     #[doc = "terminates. See grpc_channel_args definition for more on this."]
2918     #[doc = " Releases a server_credentials object."]
2919     #[doc = "The creator of the server_credentials object is responsible for its release."]
2928     #[doc = " Creates a grpc_ssl_server_certificate_config object."]
2929     #[doc = "- pem_roots_cert is the NULL-terminated string containing the PEM encoding of"]
2930     #[doc = "the client root certificates. This parameter may be NULL if the server does"]
2931     #[doc = "not want the client to be authenticated with SSL."]
2932     #[doc = "- pem_key_cert_pairs is an array private key / certificate chains of the"]
2933     #[doc = "server. This parameter cannot be NULL."]
2934     #[doc = "- num_key_cert_pairs indicates the number of items in the private_key_files"]
2935     #[doc = "and cert_chain_files parameters. It must be at least 1."]
2936     #[doc = "- It is the caller's responsibility to free this object via"]
2937     #[doc = "grpc_ssl_server_certificate_config_destroy()."]
2945     #[doc = " Destroys a grpc_ssl_server_certificate_config object."]
2950 #[doc = " Callback to retrieve updated SSL server certificates, private keys, and"]
2951 #[doc = "trusted CAs (for client authentication)."]
2952 #[doc = "- user_data parameter, if not NULL, contains opaque data to be used by the"]
2953 #[doc = "callback."]
2954 #[doc = "- Use grpc_ssl_server_certificate_config_create to create the config."]
2955 #[doc = "- The caller assumes ownership of the config."]
2963     #[doc = " Deprecated in favor of grpc_ssl_server_credentials_create_ex."]
2964     #[doc = "Creates an SSL server_credentials object."]
2965     #[doc = "- pem_roots_cert is the NULL-terminated string containing the PEM encoding of"]
2966     #[doc = "the client root certificates. This parameter may be NULL if the server does"]
2967     #[doc = "not want the client to be authenticated with SSL."]
2968     #[doc = "- pem_key_cert_pairs is an array private key / certificate chains of the"]
2969     #[doc = "server. This parameter cannot be NULL."]
2970     #[doc = "- num_key_cert_pairs indicates the number of items in the private_key_files"]
2971     #[doc = "and cert_chain_files parameters. It should be at least 1."]
2972     #[doc = "- force_client_auth, if set to non-zero will force the client to authenticate"]
2973     #[doc = "with an SSL cert. Note that this option is ignored if pem_root_certs is"]
2974     #[doc = "NULL."]
2984     #[doc = " Deprecated in favor of grpc_ssl_server_credentials_create_with_options."]
2985     #[doc = "Same as grpc_ssl_server_credentials_create method except uses"]
2986     #[doc = "grpc_ssl_client_certificate_request_type enum to support more ways to"]
2987     #[doc = "authenticate client certificates."]
3002     #[doc = " Creates an options object using a certificate config. Use this method when"]
3003     #[doc = "the certificates and keys of the SSL server will not change during the"]
3004     #[doc = "server's lifetime."]
3005     #[doc = "- Takes ownership of the certificate_config parameter."]
3012     #[doc = " Creates an options object using a certificate config fetcher. Use this"]
3013     #[doc = "method to reload the certificates and keys of the SSL server without"]
3014     #[doc = "interrupting the operation of the server. Initial certificate config will be"]
3015     #[doc = "fetched during server initialization."]
3016     #[doc = "- user_data parameter, if not NULL, contains opaque data which will be passed"]
3017     #[doc = "to the fetcher (see definition of"]
3018     #[doc = "grpc_ssl_server_certificate_config_callback)."]
3026     #[doc = " Destroys a grpc_ssl_server_credentials_options object."]
3032     #[doc = " Creates an SSL server_credentials object using the provided options struct."]
3033     #[doc = "- Takes ownership of the options parameter."]
3039     #[doc = " Add a HTTP2 over an encrypted link over tcp listener."]
3040     #[doc = "Returns bound port number on success, 0 on failure."]
3041     #[doc = "REQUIRES: server not started"]
3049     #[doc = " Sets a credentials to a call. Can only be called on the client side before"]
3050     #[doc = "grpc_call_start_batch."]
3056 #[doc = " Callback function that is called when the metadata processing is done."]
3057 #[doc = "- Consumed metadata will be removed from the set of metadata available on the"]
3058 #[doc = "call. consumed_md may be NULL if no metadata has been consumed."]
3059 #[doc = "- Response metadata will be set on the response. response_md may be NULL."]
3060 #[doc = "- status is GRPC_STATUS_OK for success or a specific status for an error."]
3061 #[doc = "Common error status for auth metadata processing is either"]
3062 #[doc = "GRPC_STATUS_UNAUTHENTICATED in case of an authentication failure or"]
3063 #[doc = "GRPC_STATUS PERMISSION_DENIED in case of an authorization failure."]
3064 #[doc = "- error_details gives details about the error. May be NULL."]
3076 #[doc = " Pluggable server-side metadata processor object."]
3080     #[doc = " The context object is read/write: it contains the properties of the"]
3081     #[doc = "channel peer and it is the job of the process function to augment it with"]
3082     #[doc = "properties derived from the passed-in metadata."]
3083     #[doc = "The lifetime of these objects is guaranteed until cb is invoked."]
3109     #[doc = " This method creates a grpc ALTS credentials client options instance."]
3110     #[doc = " It is used for experimental purpose for now and subject to change."]
3114     #[doc = " This method creates a grpc ALTS credentials server options instance."]
3115     #[doc = " It is used for experimental purpose for now and subject to change."]
3119     #[doc = " This method adds a target service account to grpc client's ALTS credentials"]
3120     #[doc = " options instance. It is used for experimental purpose for now and subject"]
3121     #[doc = " to change."]
3122     #[doc = ""]
3123     #[doc = " - options: grpc ALTS credentials options instance."]
3124     #[doc = " - service_account: service account of target endpoint."]
3131     #[doc = " This method destroys a grpc_alts_credentials_options instance by"]
3132     #[doc = " de-allocating all of its occupied memory. It is used for experimental purpose"]
3133     #[doc = " for now and subject to change."]
3134     #[doc = ""]
3135     #[doc = " - options: a grpc_alts_credentials_options instance that needs to be"]
3136     #[doc = "   destroyed."]
3140     #[doc = " This method creates an ALTS channel credential object. The security"]
3141     #[doc = " level of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY."]
3142     #[doc = " It is used for experimental purpose for now and subject to change."]
3143     #[doc = ""]
3144     #[doc = " - options: grpc ALTS credentials options instance for client."]
3145     #[doc = ""]
3146     #[doc = " It returns the created ALTS channel credential object."]
3152     #[doc = " This method creates an ALTS server credential object. It is used for"]
3153     #[doc = " experimental purpose for now and subject to change."]
3154     #[doc = ""]
3155     #[doc = " - options: grpc ALTS credentials options instance for server."]
3156     #[doc = ""]
3157     #[doc = " It returns the created ALTS server credential object."]
3163     #[doc = " This method creates a local channel credential object. The security level"]
3164     #[doc = " of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY for UDS and"]
3165     #[doc = " GRPC_SECURITY_NONE for LOCAL_TCP. It is used for experimental purpose"]
3166     #[doc = " for now and subject to change."]
3167     #[doc = ""]
3168     #[doc = " - type: local connection type"]
3169     #[doc = ""]
3170     #[doc = " It returns the created local channel credential object."]
3176     #[doc = " This method creates a local server credential object. It is used for"]
3177     #[doc = " experimental purpose for now and subject to change."]
3178     #[doc = ""]
3179     #[doc = " - type: local connection type"]
3180     #[doc = ""]
3181     #[doc = " It returns the created local server credential object."]
3212     #[doc = " Creates a grpc_tls_identity_pairs that stores a list of identity credential"]
3213     #[doc = " data, including identity private key and identity certificate chain. It is"]
3214     #[doc = " used for experimental purpose for now and subject to change."]
3218     #[doc = " Adds a identity private key and a identity certificate chain to"]
3219     #[doc = " grpc_tls_identity_pairs. This function will make an internal copy of"]
3220     #[doc = " |private_key| and |cert_chain|. It is used for experimental purpose for now"]
3221     #[doc = " and subject to change."]
3229     #[doc = " Destroys a grpc_tls_identity_pairs object. If this object is passed to a"]
3230     #[doc = " provider initiation function, the ownership is transferred so this function"]
3231     #[doc = " doesn't need to be called. Otherwise the creator of the"]
3232     #[doc = " grpc_tls_identity_pairs object is responsible for its destruction. It is"]
3233     #[doc = " used for experimental purpose for now and subject to change."]
3237     #[doc = " Creates a grpc_tls_certificate_provider that will load credential data from"]
3238     #[doc = " static string during initialization. This provider will always return the"]
3239     #[doc = " same cert data for all cert names."]
3240     #[doc = " root_certificate and pem_key_cert_pairs can be nullptr, indicating the"]
3241     #[doc = " corresponding credential data is not needed."]
3242     #[doc = " This function will make a copy of |root_certificate|."]
3243     #[doc = " The ownership of |pem_key_cert_pairs| is transferred."]
3244     #[doc = " It is used for experimental purpose for now and subject to change."]
3251     #[doc = " Creates a grpc_tls_certificate_provider that will watch the credential"]
3252     #[doc = " changes on the file system. This provider will always return the up-to-date"]
3253     #[doc = " cert data for all the cert names callers set through"]
3254     #[doc = " |grpc_tls_credentials_options|. Note that this API only supports one key-cert"]
3255     #[doc = " file and hence one set of identity key-cert pair, so SNI(Server Name"]
3256     #[doc = " Indication) is not supported."]
3257     #[doc = " - private_key_path is the file path of the private key. This must be set if"]
3258     #[doc = "   |identity_certificate_path| is set. Otherwise, it could be null if no"]
3259     #[doc = "   identity credentials are needed."]
3260     #[doc = " - identity_certificate_path is the file path of the identity certificate"]
3261     #[doc = "   chain. This must be set if |private_key_path| is set. Otherwise, it could"]
3262     #[doc = "   be null if no identity credentials are needed."]
3263     #[doc = " - root_cert_path is the file path to the root certificate bundle. This"]
3264     #[doc = "   may be null if no root certs are needed."]
3265     #[doc = " - refresh_interval_sec is the refreshing interval that we will check the"]
3266     #[doc = "   files for updates."]
3267     #[doc = " It does not take ownership of parameters."]
3268     #[doc = " It is used for experimental purpose for now and subject to change."]
3277     #[doc = " Releases a grpc_tls_certificate_provider object. The creator of the"]
3278     #[doc = " grpc_tls_certificate_provider object is responsible for its release. It is"]
3279     #[doc = " used for experimental purpose for now and subject to change."]
3283     #[doc = " Creates an grpc_tls_credentials_options."]
3284     #[doc = " It is used for experimental purpose for now and subject to change."]
3288     #[doc = " Sets the options of whether to request and verify client certs. This should"]
3289     #[doc = " be called only on the server side. It returns 1 on success and 0 on failure."]
3290     #[doc = " It is used for experimental purpose for now and subject to change."]
3297     #[doc = " Sets the options of whether to choose certain checks, e.g. certificate check,"]
3298     #[doc = " hostname check, etc. This should be called only on the client side. If"]
3299     #[doc = " |server_verification_option| is not GRPC_TLS_SERVER_VERIFICATION, use of a"]
3300     #[doc = " custom authorization check (grpc_tls_server_authorization_check_config) is"]
3301     #[doc = " mandatory. It returns 1 on success and 0 on failure. It is used for"]
3302     #[doc = " experimental purpose for now and subject to change."]
3309     #[doc = " Sets the credential provider in the options."]
3310     #[doc = " The |options| will implicitly take a new ref to the |provider|."]
3311     #[doc = " It returns 1 on success and 0 on failure."]
3312     #[doc = " It is used for experimental purpose for now and subject to change."]
3319     #[doc = " If set, gRPC stack will keep watching the root certificates with"]
3320     #[doc = " name |root_cert_name|. It returns 1 on success and 0 on failure. It is used"]
3321     #[doc = " for experimental purpose for now and subject to change."]
3327     #[doc = " Sets the name of the root certificates being watched."]
3328     #[doc = " If not set, We will use a default empty string as the root certificate name."]
3329     #[doc = " It is used for experimental purpose for now and subject to change."]
3336     #[doc = " If set, gRPC stack will keep watching the identity key-cert pairs"]
3337     #[doc = " with name |identity_cert_name|. It returns 1 on success and 0 on failure. It"]
3338     #[doc = " is used for experimental purpose for now and subject to change."]
3344     #[doc = " Sets the name of the identity certificates being watched."]
3345     #[doc = " If not set, We will use a default empty string as the identity certificate"]
3346     #[doc = " name. It is used for experimental purpose for now and subject to change."]
3353     #[doc = " Sets the configuration for a custom authorization check performed at the end"]
3354     #[doc = " of the handshake. The |options| will implicitly take a new ref to the"]
3355     #[doc = " |config|. It returns 1 on success and 0 on failure. It is used for"]
3356     #[doc = " experimental purpose for now and subject to change."]
3362 #[doc = " callback function provided by gRPC used to handle the result of server"]
3363 #[doc = "authorization check. It is used when schedule API is implemented"]
3364 #[doc = "asynchronously, and serves to bring the control back to gRPC C core. It is"]
3365 #[doc = "used for experimental purpose for now and subject to change."]
3368 #[doc = " A struct containing all information necessary to schedule/cancel a server"]
3369 #[doc = "authorization check request."]
3370 #[doc = "- cb and cb_user_data represent a gRPC-provided callback and an argument"]
3371 #[doc = "passed to it."]
3372 #[doc = "- success will store the result of server authorization check. That is,"]
3373 #[doc = "if success returns a non-zero value, it means the authorization check"]
3374 #[doc = "passes and if returning zero, it means the check fails."]
3375 #[doc = "- target_name is the name of an endpoint the channel is connecting to."]
3376 #[doc = "- peer_cert represents a complete certificate chain including both"]
3377 #[doc = "signing and leaf certificates."]
3378 #[doc = "- \\a subject_alternative_names is an array of size"]
3379 #[doc = "\\a subject_alternative_names_size consisting of pointers to strings."]
3380 #[doc = "- status and error_details contain information"]
3381 #[doc = "about errors occurred when a server authorization check request is"]
3382 #[doc = "scheduled/cancelled."]
3383 #[doc = "- config is a pointer to the unique"]
3384 #[doc = "grpc_tls_server_authorization_check_config instance that this argument"]
3385 #[doc = "corresponds to."]
3386 #[doc = "- context is a pointer to a wrapped language implementation of this"]
3387 #[doc = "grpc_tls_server_authorization_check_arg instance."]
3388 #[doc = "- destroy_context is a pointer to a caller-provided method that cleans"]
3389 #[doc = "up any data associated with the context pointer."]
3390 #[doc = "It is used for experimental purpose for now and subject to change."]
3410     #[doc = " Create a grpc_tls_server_authorization_check_config instance."]
3411     #[doc = "- config_user_data is config-specific, read-only user data"]
3412     #[doc = "that works for all channels created with a credential using the config."]
3413     #[doc = "- schedule is a pointer to an application-provided callback used to invoke"]
3414     #[doc = "server authorization check API. The implementation of this method has to"]
3415     #[doc = "be non-blocking, but can be performed synchronously or asynchronously."]
3416     #[doc = "1)If processing occurs synchronously, it populates arg->result,"]
3417     #[doc = "arg->status, and arg->error_details and returns zero."]
3418     #[doc = "2) If processing occurs asynchronously, it returns a non-zero value. The"]
3419     #[doc = "application then invokes arg->cb when processing is completed. Note that"]
3420     #[doc = "arg->cb cannot be invoked before schedule API returns."]
3421     #[doc = "- cancel is a pointer to an application-provided callback used to cancel a"]
3422     #[doc = "server authorization check request scheduled via an asynchronous schedule"]
3423     #[doc = "API. arg is used to pinpoint an exact check request to be cancelled. The"]
3424     #[doc = "operation may not have any effect if the request has already been"]
3425     #[doc = "processed."]
3426     #[doc = "- destruct is a pointer to an application-provided callback used to clean up"]
3427     #[doc = "any data associated with the config."]
3428     #[doc = "It is used for experimental purpose for now and subject to change."]
3449     #[doc = " Releases a grpc_tls_server_authorization_check_config object. The creator of"]
3450     #[doc = " the grpc_tls_server_authorization_check_config object is responsible for its"]
3451     #[doc = " release. It is used for experimental purpose for now and subject to change."]
3457     #[doc = " Creates a TLS channel credential object based on the"]
3458     #[doc = " grpc_tls_credentials_options specified by callers. The"]
3459     #[doc = " grpc_channel_credentials will take the ownership of the |options|. The"]
3460     #[doc = " security level of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY. It"]
3461     #[doc = " is used for experimental purpose for now and subject to change."]
3467     #[doc = " Creates a TLS server credential object based on the"]
3468     #[doc = " grpc_tls_credentials_options specified by callers. The"]
3469     #[doc = " grpc_server_credentials will take the ownership of the |options|. It"]
3470     #[doc = " is used for experimental purpose for now and subject to change."]
3476     #[doc = " EXPERIMENTAL API - Subject to change"]
3477     #[doc = ""]
3478     #[doc = " This method creates an insecure channel credentials object."]
3482     #[doc = " EXPERIMENTAL API - Subject to change"]
3483     #[doc = ""]
3484     #[doc = " This method creates an insecure server credentials object."]
3488     #[doc = " EXPERIMENTAL API - Subject to change"]
3489     #[doc = ""]
3490     #[doc = " This method creates an xDS channel credentials object."]
3491     #[doc = ""]
3492     #[doc = " Creating a channel with credentials of this type indicates that the channel"]
3493     #[doc = " should get credentials configuration from the xDS control plane."]
3494     #[doc = ""]
3495     #[doc = " \\a fallback_credentials are used if the channel target does not have the"]
3496     #[doc = " 'xds:///' scheme or if the xDS control plane does not provide information on"]
3497     #[doc = " how to fetch credentials dynamically. Does NOT take ownership of the \\a"]
3498     #[doc = " fallback_credentials. (Internally takes a ref to the object.)"]
3504     #[doc = " EXPERIMENTAL API - Subject to change"]
3505     #[doc = ""]
3506     #[doc = " This method creates an xDS server credentials object."]
3507     #[doc = ""]
3508     #[doc = " \\a fallback_credentials are used if the xDS control plane does not provide"]
3509     #[doc = " information on how to fetch credentials dynamically."]
3510     #[doc = ""]
3511     #[doc = " Does NOT take ownership of the \\a fallback_credentials. (Internally takes"]
3512     #[doc = " a ref to the object.)"]
3518 #[doc = " The severity of a log message - use the #defines below when calling into"]
3519 #[doc = "gpr_log to additionally supply file and line data"]
3527     #[doc = " Returns a string representation of the log severity"]
3531     #[doc = " Log a message. It's advised to use GPR_xxx above to generate the context"]
3532     #[doc = " for each message"]
3553     #[doc = " Set global log verbosity"]
3559 #[doc = " Log overrides: applications can use this API to intercept logging calls"]
3560 #[doc = "and use their own implementations"]
3574     #[doc = " malloc."]
3575     #[doc = " If size==0, always returns NULL. Otherwise this function never returns NULL."]
3576     #[doc = " The pointer returned is suitably aligned for any kind of variable it could"]
3577     #[doc = " contain."]
3581     #[doc = " like malloc, but zero all bytes before returning them"]
3585     #[doc = " free"]
3589     #[doc = " realloc, never returns NULL"]
3593     #[doc = " aligned malloc, never returns NULL, will align to alignment, which"]
3594     #[doc = " must be a power of 2."]
3598     #[doc = " free memory allocated by gpr_malloc_aligned"]
3602     #[doc = " Return the number of CPU cores on the current system. Will return 0 if"]
3603     #[doc = "the information is not available."]
3607     #[doc = " Return the CPU on which the current thread is executing; N.B. This should"]
3608     #[doc = "be considered advisory only - it is possible that the thread is switched"]
3609     #[doc = "to a different CPU at any time. Returns a value in range"]
3610     #[doc = "[0, gpr_cpu_num_cores() - 1]"]
3614     #[doc = " Returns a string allocated with gpr_malloc that contains a UTF-8"]
3615     #[doc = " formatted error message, corresponding to the error messageid."]
3616     #[doc = " Use in conjunction with GetLastError() et al."]
3620     #[doc = " Returns a copy of src that can be passed to gpr_free()."]
3621     #[doc = "If allocation fails or if src is NULL, returns NULL."]
3625     #[doc = " printf to a newly-allocated string.  The set of supported formats may vary"]
3626     #[doc = "between platforms."]
3627     #[doc = ""]
3628     #[doc = "On success, returns the number of bytes printed (excluding the final '\\0'),"]
3629     #[doc = "and *strp points to a string which must later be destroyed with gpr_free()."]
3630     #[doc = ""]
3631     #[doc = "On error, returns -1 and sets *strp to NULL. If the format string is bad,"]
3632     #[doc = "the result is undefined."]
3641     #[doc = " Returns the identifier of the current thread."]
3644 #[doc = " Reader for byte buffers. Iterates over slices in the byte buffer"]
3652 #[doc = " Different current objects correspond to different types of byte buffers"]
3656     #[doc = " Index into a slice buffer's array of slices"]
4012     #[doc = " Kick call's completion queue, it should be called after there is an event"]
4013     #[doc = "ready to poll."]
4014     #[doc = "THREAD SAFETY: grpcwrap_call_kick_completion_queue is thread-safe"]
4015     #[doc = "because it does not change the call's state."]