|
|
|
@ -55,11 +55,11 @@ extern "C" { |
|
|
|
|
* functionality lives in grpc_security.h. |
|
|
|
|
*/ |
|
|
|
|
|
|
|
|
|
void grpc_metadata_array_init(grpc_metadata_array *array); |
|
|
|
|
void grpc_metadata_array_destroy(grpc_metadata_array *array); |
|
|
|
|
GRPC_API void grpc_metadata_array_init(grpc_metadata_array *array); |
|
|
|
|
GRPC_API void grpc_metadata_array_destroy(grpc_metadata_array *array); |
|
|
|
|
|
|
|
|
|
void grpc_call_details_init(grpc_call_details *details); |
|
|
|
|
void grpc_call_details_destroy(grpc_call_details *details); |
|
|
|
|
GRPC_API void grpc_call_details_init(grpc_call_details *details); |
|
|
|
|
GRPC_API void grpc_call_details_destroy(grpc_call_details *details); |
|
|
|
|
|
|
|
|
|
/** Registers a plugin to be initialized and destroyed with the library.
|
|
|
|
|
|
|
|
|
@ -69,7 +69,7 @@ void grpc_call_details_destroy(grpc_call_details *details); |
|
|
|
|
(and hence so will \a init and \a destroy). |
|
|
|
|
It is safe to pass NULL to either argument. Plugins are destroyed in |
|
|
|
|
the reverse order they were initialized. */ |
|
|
|
|
void grpc_register_plugin(void (*init)(void), void (*destroy)(void)); |
|
|
|
|
GRPC_API void grpc_register_plugin(void (*init)(void), void (*destroy)(void)); |
|
|
|
|
|
|
|
|
|
/** Initialize the grpc library.
|
|
|
|
|
|
|
|
|
@ -77,7 +77,7 @@ void grpc_register_plugin(void (*init)(void), void (*destroy)(void)); |
|
|
|
|
(To avoid overhead, little checking is done, and some things may work. We |
|
|
|
|
do not warrant that they will continue to do so in future revisions of this |
|
|
|
|
library). */ |
|
|
|
|
void grpc_init(void); |
|
|
|
|
GRPC_API void grpc_init(void); |
|
|
|
|
|
|
|
|
|
/** Shut down the grpc library.
|
|
|
|
|
|
|
|
|
@ -85,13 +85,13 @@ void grpc_init(void); |
|
|
|
|
executing within the grpc library. |
|
|
|
|
Prior to calling, all application owned grpc objects must have been |
|
|
|
|
destroyed. */ |
|
|
|
|
void grpc_shutdown(void); |
|
|
|
|
GRPC_API void grpc_shutdown(void); |
|
|
|
|
|
|
|
|
|
/** Return a string representing the current version of grpc */ |
|
|
|
|
const char *grpc_version_string(void); |
|
|
|
|
GRPC_API const char *grpc_version_string(void); |
|
|
|
|
|
|
|
|
|
/** Create a completion queue */ |
|
|
|
|
grpc_completion_queue *grpc_completion_queue_create(void *reserved); |
|
|
|
|
GRPC_API grpc_completion_queue *grpc_completion_queue_create(void *reserved); |
|
|
|
|
|
|
|
|
|
/** Blocks until an event is available, the completion queue is being shut down,
|
|
|
|
|
or deadline is reached. |
|
|
|
@ -101,7 +101,7 @@ grpc_completion_queue *grpc_completion_queue_create(void *reserved); |
|
|
|
|
|
|
|
|
|
Callers must not call grpc_completion_queue_next and |
|
|
|
|
grpc_completion_queue_pluck simultaneously on the same completion queue. */ |
|
|
|
|
grpc_event grpc_completion_queue_next(grpc_completion_queue *cq, |
|
|
|
|
GRPC_API grpc_event grpc_completion_queue_next(grpc_completion_queue *cq, |
|
|
|
|
gpr_timespec deadline, void *reserved); |
|
|
|
|
|
|
|
|
|
/** Blocks until an event with tag 'tag' is available, the completion queue is
|
|
|
|
@ -115,7 +115,7 @@ grpc_event grpc_completion_queue_next(grpc_completion_queue *cq, |
|
|
|
|
|
|
|
|
|
Completion queues support a maximum of GRPC_MAX_COMPLETION_QUEUE_PLUCKERS |
|
|
|
|
concurrently executing plucks at any time. */ |
|
|
|
|
grpc_event grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, |
|
|
|
|
GRPC_API grpc_event grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, |
|
|
|
|
gpr_timespec deadline, void *reserved); |
|
|
|
|
|
|
|
|
|
/** Maximum number of outstanding grpc_completion_queue_pluck executions per
|
|
|
|
@ -129,11 +129,11 @@ grpc_event grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, |
|
|
|
|
|
|
|
|
|
After calling this function applications should ensure that no |
|
|
|
|
NEW work is added to be published on this completion queue. */ |
|
|
|
|
void grpc_completion_queue_shutdown(grpc_completion_queue *cq); |
|
|
|
|
GRPC_API void grpc_completion_queue_shutdown(grpc_completion_queue *cq); |
|
|
|
|
|
|
|
|
|
/** Destroy a completion queue. The caller must ensure that the queue is
|
|
|
|
|
drained and no threads are executing grpc_completion_queue_next */ |
|
|
|
|
void grpc_completion_queue_destroy(grpc_completion_queue *cq); |
|
|
|
|
GRPC_API void grpc_completion_queue_destroy(grpc_completion_queue *cq); |
|
|
|
|
|
|
|
|
|
/** Create a completion queue alarm instance associated to \a cq.
|
|
|
|
|
* |
|
|
|
@ -141,18 +141,18 @@ void grpc_completion_queue_destroy(grpc_completion_queue *cq); |
|
|
|
|
* grpc_alarm_cancel), an event with tag \a tag will be added to \a cq. If the |
|
|
|
|
* alarm expired, the event's success bit will be true, false otherwise (ie, |
|
|
|
|
* upon cancellation). */ |
|
|
|
|
grpc_alarm *grpc_alarm_create(grpc_completion_queue *cq, gpr_timespec deadline, |
|
|
|
|
GRPC_API grpc_alarm *grpc_alarm_create(grpc_completion_queue *cq, gpr_timespec deadline, |
|
|
|
|
void *tag); |
|
|
|
|
|
|
|
|
|
/** Cancel a completion queue alarm. Calling this function over an alarm that
|
|
|
|
|
* has already fired has no effect. */ |
|
|
|
|
void grpc_alarm_cancel(grpc_alarm *alarm); |
|
|
|
|
GRPC_API void grpc_alarm_cancel(grpc_alarm *alarm); |
|
|
|
|
|
|
|
|
|
/** Destroy the given completion queue alarm, cancelling it in the process. */ |
|
|
|
|
void grpc_alarm_destroy(grpc_alarm *alarm); |
|
|
|
|
GRPC_API void grpc_alarm_destroy(grpc_alarm *alarm); |
|
|
|
|
|
|
|
|
|
/** Check the connectivity state of a channel. */ |
|
|
|
|
grpc_connectivity_state grpc_channel_check_connectivity_state( |
|
|
|
|
GRPC_API grpc_connectivity_state grpc_channel_check_connectivity_state( |
|
|
|
|
grpc_channel *channel, int try_to_connect); |
|
|
|
|
|
|
|
|
|
/** Watch for a change in connectivity state.
|
|
|
|
@ -160,7 +160,7 @@ grpc_connectivity_state grpc_channel_check_connectivity_state( |
|
|
|
|
tag will be enqueued on cq with success=1. |
|
|
|
|
If deadline expires BEFORE the state is changed, tag will be enqueued on cq |
|
|
|
|
with success=0. */ |
|
|
|
|
void grpc_channel_watch_connectivity_state( |
|
|
|
|
GRPC_API void grpc_channel_watch_connectivity_state( |
|
|
|
|
grpc_channel *channel, grpc_connectivity_state last_observed_state, |
|
|
|
|
gpr_timespec deadline, grpc_completion_queue *cq, void *tag); |
|
|
|
|
|
|
|
|
@ -170,7 +170,7 @@ void grpc_channel_watch_connectivity_state( |
|
|
|
|
If parent_call is non-NULL, it must be a server-side call. It will be used |
|
|
|
|
to propagate properties from the server call to this new client call. |
|
|
|
|
*/ |
|
|
|
|
grpc_call *grpc_channel_create_call(grpc_channel *channel, |
|
|
|
|
GRPC_API grpc_call *grpc_channel_create_call(grpc_channel *channel, |
|
|
|
|
grpc_call *parent_call, |
|
|
|
|
uint32_t propagation_mask, |
|
|
|
|
grpc_completion_queue *completion_queue, |
|
|
|
@ -179,15 +179,15 @@ grpc_call *grpc_channel_create_call(grpc_channel *channel, |
|
|
|
|
|
|
|
|
|
/** Ping the channels peer (load balanced channels will select one sub-channel
|
|
|
|
|
to ping); if the channel is not connected, posts a failed. */ |
|
|
|
|
void grpc_channel_ping(grpc_channel *channel, grpc_completion_queue *cq, |
|
|
|
|
GRPC_API void grpc_channel_ping(grpc_channel *channel, grpc_completion_queue *cq, |
|
|
|
|
void *tag, void *reserved); |
|
|
|
|
|
|
|
|
|
/** Pre-register a method/host pair on a channel. */ |
|
|
|
|
void *grpc_channel_register_call(grpc_channel *channel, const char *method, |
|
|
|
|
GRPC_API void *grpc_channel_register_call(grpc_channel *channel, const char *method, |
|
|
|
|
const char *host, void *reserved); |
|
|
|
|
|
|
|
|
|
/** Create a call given a handle returned from grpc_channel_register_call */ |
|
|
|
|
grpc_call *grpc_channel_create_registered_call( |
|
|
|
|
GRPC_API grpc_call *grpc_channel_create_registered_call( |
|
|
|
|
grpc_channel *channel, grpc_call *parent_call, uint32_t propagation_mask, |
|
|
|
|
grpc_completion_queue *completion_queue, void *registered_call_handle, |
|
|
|
|
gpr_timespec deadline, void *reserved); |
|
|
|
@ -203,7 +203,7 @@ grpc_call *grpc_channel_create_registered_call( |
|
|
|
|
needs to be synchronized. As an optimization, you may synchronize batches |
|
|
|
|
containing just send operations independently from batches containing just |
|
|
|
|
receive operations. */ |
|
|
|
|
grpc_call_error grpc_call_start_batch(grpc_call *call, const grpc_op *ops, |
|
|
|
|
GRPC_API grpc_call_error grpc_call_start_batch(grpc_call *call, const grpc_op *ops, |
|
|
|
|
size_t nops, void *tag, void *reserved); |
|
|
|
|
|
|
|
|
|
/** Returns a newly allocated string representing the endpoint to which this
|
|
|
|
@ -214,38 +214,38 @@ grpc_call_error grpc_call_start_batch(grpc_call *call, const grpc_op *ops, |
|
|
|
|
WARNING: this value is never authenticated or subject to any security |
|
|
|
|
related code. It must not be used for any authentication related |
|
|
|
|
functionality. Instead, use grpc_auth_context. */ |
|
|
|
|
char *grpc_call_get_peer(grpc_call *call); |
|
|
|
|
GRPC_API char *grpc_call_get_peer(grpc_call *call); |
|
|
|
|
|
|
|
|
|
struct census_context; |
|
|
|
|
|
|
|
|
|
/* Set census context for a call; Must be called before first call to
|
|
|
|
|
grpc_call_start_batch(). */ |
|
|
|
|
void grpc_census_call_set_context(grpc_call *call, |
|
|
|
|
GRPC_API void grpc_census_call_set_context(grpc_call *call, |
|
|
|
|
struct census_context *context); |
|
|
|
|
|
|
|
|
|
/* Retrieve the calls current census context. */ |
|
|
|
|
struct census_context *grpc_census_call_get_context(grpc_call *call); |
|
|
|
|
GRPC_API struct census_context *grpc_census_call_get_context(grpc_call *call); |
|
|
|
|
|
|
|
|
|
/** Return a newly allocated string representing the target a channel was
|
|
|
|
|
created for. */ |
|
|
|
|
char *grpc_channel_get_target(grpc_channel *channel); |
|
|
|
|
GRPC_API char *grpc_channel_get_target(grpc_channel *channel); |
|
|
|
|
|
|
|
|
|
/** Create a client channel to 'target'. Additional channel level configuration
|
|
|
|
|
MAY be provided by grpc_channel_args, though the expectation is that most |
|
|
|
|
clients will want to simply pass NULL. See grpc_channel_args definition for |
|
|
|
|
more on this. The data in 'args' need only live through the invocation of |
|
|
|
|
this function. */ |
|
|
|
|
grpc_channel *grpc_insecure_channel_create(const char *target, |
|
|
|
|
GRPC_API grpc_channel *grpc_insecure_channel_create(const char *target, |
|
|
|
|
const grpc_channel_args *args, |
|
|
|
|
void *reserved); |
|
|
|
|
|
|
|
|
|
/** Create a lame client: this client fails every operation attempted on it. */ |
|
|
|
|
grpc_channel *grpc_lame_client_channel_create(const char *target, |
|
|
|
|
GRPC_API grpc_channel *grpc_lame_client_channel_create(const char *target, |
|
|
|
|
grpc_status_code error_code, |
|
|
|
|
const char *error_message); |
|
|
|
|
|
|
|
|
|
/** Close and destroy a grpc channel */ |
|
|
|
|
void grpc_channel_destroy(grpc_channel *channel); |
|
|
|
|
GRPC_API void grpc_channel_destroy(grpc_channel *channel); |
|
|
|
|
|
|
|
|
|
/* Error handling for grpc_call
|
|
|
|
|
Most grpc_call functions return a grpc_error. If the error is not GRPC_OK |
|
|
|
@ -258,7 +258,7 @@ void grpc_channel_destroy(grpc_channel *channel); |
|
|
|
|
THREAD-SAFETY grpc_call_cancel and grpc_call_cancel_with_status |
|
|
|
|
are thread-safe, and can be called at any point before grpc_call_destroy |
|
|
|
|
is called.*/ |
|
|
|
|
grpc_call_error grpc_call_cancel(grpc_call *call, void *reserved); |
|
|
|
|
GRPC_API grpc_call_error grpc_call_cancel(grpc_call *call, void *reserved); |
|
|
|
|
|
|
|
|
|
/** Called by clients to cancel an RPC on the server.
|
|
|
|
|
Can be called multiple times, from any thread. |
|
|
|
@ -266,14 +266,14 @@ grpc_call_error grpc_call_cancel(grpc_call *call, void *reserved); |
|
|
|
|
and description passed in. |
|
|
|
|
Importantly, this function does not send status nor description to the |
|
|
|
|
remote endpoint. */ |
|
|
|
|
grpc_call_error grpc_call_cancel_with_status(grpc_call *call, |
|
|
|
|
GRPC_API grpc_call_error grpc_call_cancel_with_status(grpc_call *call, |
|
|
|
|
grpc_status_code status, |
|
|
|
|
const char *description, |
|
|
|
|
void *reserved); |
|
|
|
|
|
|
|
|
|
/** Destroy a call.
|
|
|
|
|
THREAD SAFETY: grpc_call_destroy is thread-compatible */ |
|
|
|
|
void grpc_call_destroy(grpc_call *call); |
|
|
|
|
GRPC_API void grpc_call_destroy(grpc_call *call); |
|
|
|
|
|
|
|
|
|
/** Request notification of a new call.
|
|
|
|
|
Once a call is received, a notification tagged with \a tag_new is added to |
|
|
|
@ -283,7 +283,7 @@ void grpc_call_destroy(grpc_call *call); |
|
|
|
|
to \a cq_bound_to_call. |
|
|
|
|
Note that \a cq_for_notification must have been registered to the server via |
|
|
|
|
\a grpc_server_register_completion_queue. */ |
|
|
|
|
grpc_call_error grpc_server_request_call( |
|
|
|
|
GRPC_API grpc_call_error grpc_server_request_call( |
|
|
|
|
grpc_server *server, grpc_call **call, grpc_call_details *details, |
|
|
|
|
grpc_metadata_array *request_metadata, |
|
|
|
|
grpc_completion_queue *cq_bound_to_call, |
|
|
|
@ -296,13 +296,13 @@ grpc_call_error grpc_server_request_call( |
|
|
|
|
registered_method (as returned by this function). |
|
|
|
|
Must be called before grpc_server_start. |
|
|
|
|
Returns NULL on failure. */ |
|
|
|
|
void *grpc_server_register_method(grpc_server *server, const char *method, |
|
|
|
|
GRPC_API void *grpc_server_register_method(grpc_server *server, const char *method, |
|
|
|
|
const char *host); |
|
|
|
|
|
|
|
|
|
/** Request notification of a new pre-registered call. 'cq_for_notification'
|
|
|
|
|
must have been registered to the server via |
|
|
|
|
grpc_server_register_completion_queue. */ |
|
|
|
|
grpc_call_error grpc_server_request_registered_call( |
|
|
|
|
GRPC_API grpc_call_error grpc_server_request_registered_call( |
|
|
|
|
grpc_server *server, void *registered_method, grpc_call **call, |
|
|
|
|
gpr_timespec *deadline, grpc_metadata_array *request_metadata, |
|
|
|
|
grpc_byte_buffer **optional_payload, |
|
|
|
@ -313,23 +313,23 @@ grpc_call_error grpc_server_request_registered_call( |
|
|
|
|
be specified with args. If no additional configuration is needed, args can |
|
|
|
|
be NULL. See grpc_channel_args for more. The data in 'args' need only live |
|
|
|
|
through the invocation of this function. */ |
|
|
|
|
grpc_server *grpc_server_create(const grpc_channel_args *args, void *reserved); |
|
|
|
|
GRPC_API grpc_server *grpc_server_create(const grpc_channel_args *args, void *reserved); |
|
|
|
|
|
|
|
|
|
/** Register a completion queue with the server. Must be done for any
|
|
|
|
|
notification completion queue that is passed to grpc_server_request_*_call |
|
|
|
|
and to grpc_server_shutdown_and_notify. Must be performed prior to |
|
|
|
|
grpc_server_start. */ |
|
|
|
|
void grpc_server_register_completion_queue(grpc_server *server, |
|
|
|
|
GRPC_API void grpc_server_register_completion_queue(grpc_server *server, |
|
|
|
|
grpc_completion_queue *cq, |
|
|
|
|
void *reserved); |
|
|
|
|
|
|
|
|
|
/** Add a HTTP2 over plaintext over tcp listener.
|
|
|
|
|
Returns bound port number on success, 0 on failure. |
|
|
|
|
REQUIRES: server not started */ |
|
|
|
|
int grpc_server_add_insecure_http2_port(grpc_server *server, const char *addr); |
|
|
|
|
GRPC_API int grpc_server_add_insecure_http2_port(grpc_server *server, const char *addr); |
|
|
|
|
|
|
|
|
|
/** Start a server - tells all listeners to start listening */ |
|
|
|
|
void grpc_server_start(grpc_server *server); |
|
|
|
|
GRPC_API void grpc_server_start(grpc_server *server); |
|
|
|
|
|
|
|
|
|
/** Begin shutting down a server.
|
|
|
|
|
After completion, no new calls or connections will be admitted. |
|
|
|
@ -338,18 +338,18 @@ void grpc_server_start(grpc_server *server); |
|
|
|
|
Shutdown is idempotent, and all tags will be notified at once if multiple |
|
|
|
|
grpc_server_shutdown_and_notify calls are made. 'cq' must have been |
|
|
|
|
registered to this server via grpc_server_register_completion_queue. */ |
|
|
|
|
void grpc_server_shutdown_and_notify(grpc_server *server, |
|
|
|
|
GRPC_API void grpc_server_shutdown_and_notify(grpc_server *server, |
|
|
|
|
grpc_completion_queue *cq, void *tag); |
|
|
|
|
|
|
|
|
|
/** Cancel all in-progress calls.
|
|
|
|
|
Only usable after shutdown. */ |
|
|
|
|
void grpc_server_cancel_all_calls(grpc_server *server); |
|
|
|
|
GRPC_API void grpc_server_cancel_all_calls(grpc_server *server); |
|
|
|
|
|
|
|
|
|
/** Destroy a server.
|
|
|
|
|
Shutdown must have completed beforehand (i.e. all tags generated by |
|
|
|
|
grpc_server_shutdown_and_notify must have been received, and at least |
|
|
|
|
one call to grpc_server_shutdown_and_notify must have been made). */ |
|
|
|
|
void grpc_server_destroy(grpc_server *server); |
|
|
|
|
GRPC_API void grpc_server_destroy(grpc_server *server); |
|
|
|
|
|
|
|
|
|
/** Enable or disable a tracer.
|
|
|
|
|
|
|
|
|
@ -359,17 +359,17 @@ void grpc_server_destroy(grpc_server *server); |
|
|
|
|
|
|
|
|
|
Use of this function is not strictly thread-safe, but the |
|
|
|
|
thread-safety issues raised by it should not be of concern. */ |
|
|
|
|
int grpc_tracer_set_enabled(const char *name, int enabled); |
|
|
|
|
GRPC_API int grpc_tracer_set_enabled(const char *name, int enabled); |
|
|
|
|
|
|
|
|
|
/** Check whether a metadata key is legal (will be accepted by core) */ |
|
|
|
|
int grpc_header_key_is_legal(const char *key, size_t length); |
|
|
|
|
GRPC_API int grpc_header_key_is_legal(const char *key, size_t length); |
|
|
|
|
|
|
|
|
|
/** Check whether a non-binary metadata value is legal (will be accepted by
|
|
|
|
|
core) */ |
|
|
|
|
int grpc_header_nonbin_value_is_legal(const char *value, size_t length); |
|
|
|
|
GRPC_API int grpc_header_nonbin_value_is_legal(const char *value, size_t length); |
|
|
|
|
|
|
|
|
|
/** Check whether a metadata key corresponds to a binary value */ |
|
|
|
|
int grpc_is_binary_header(const char *key, size_t length); |
|
|
|
|
GRPC_API int grpc_is_binary_header(const char *key, size_t length); |
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus |
|
|
|
|
} |
|
|
|
|