Function grpcio_sys::grpc_call_start_batch
source · pub unsafe extern "C" fn grpc_call_start_batch(
call: *mut grpc_call,
ops: *const grpc_op,
nops: usize,
tag: *mut c_void,
reserved: *mut c_void
) -> grpc_call_error
Expand description
Start a batch of operations defined in the array ops; when complete, post a completion of type ‘tag’ to the completion queue bound to the call. The order of ops specified in the batch has no significance. Only one operation of each type can be active at once in any given batch. If a call to grpc_call_start_batch returns GRPC_CALL_OK you must call grpc_completion_queue_next or grpc_completion_queue_pluck on the completion queue associated with ‘call’ for work to be performed. If a call to grpc_call_start_batch returns any value other than GRPC_CALL_OK it is guaranteed that no state associated with ‘call’ is changed and it is not appropriate to call grpc_completion_queue_next or grpc_completion_queue_pluck consequent to the failed grpc_call_start_batch call. If a call to grpc_call_start_batch with an empty batch returns GRPC_CALL_OK, the tag is put in the completion queue immediately. THREAD SAFETY: access to grpc_call_start_batch in multi-threaded environment needs to be synchronized. As an optimization, you may synchronize batches containing just send operations independently from batches containing just receive operations. Access to grpc_call_start_batch with an empty batch is thread-compatible.