Chiebot-Mirror
/
grpc
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation tweaks in grpc.h.

Browse Source
pull/539/head
Nathaniel Manista 10 years ago
parent 96e352c008
commit 6d41a054f9
1 changed files with 6 additions and 5 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 11
      include/grpc/grpc.h

11
include/grpc/grpc.h
Unescape View File

@ -44,7 +44,7 @@
extern "C" { extern "C" {
#endif #endif
/* Completion Channels enable notification of the completion of asynchronous /* Completion Queues enable notification of the completion of asynchronous
actions. */ actions. */
typedef struct grpc_completion_queue grpc_completion_queue; typedef struct grpc_completion_queue grpc_completion_queue;
@ -156,7 +156,8 @@ typedef enum grpc_op_error {
struct grpc_byte_buffer; struct grpc_byte_buffer;
typedef struct grpc_byte_buffer grpc_byte_buffer; typedef struct grpc_byte_buffer grpc_byte_buffer;
/* Sample helpers to obtain byte buffers (these will certainly move place */ /* Sample helpers to obtain byte buffers (these will certainly move
someplace else) */
grpc_byte_buffer *grpc_byte_buffer_create(gpr_slice *slices, size_t nslices); grpc_byte_buffer *grpc_byte_buffer_create(gpr_slice *slices, size_t nslices);
grpc_byte_buffer *grpc_byte_buffer_copy(grpc_byte_buffer *bb); grpc_byte_buffer *grpc_byte_buffer_copy(grpc_byte_buffer *bb);
size_t grpc_byte_buffer_length(grpc_byte_buffer *bb); size_t grpc_byte_buffer_length(grpc_byte_buffer *bb);
@ -340,12 +341,12 @@ typedef struct grpc_op {
/* Initialize the grpc library */ /* Initialize the grpc library */
void grpc_init(void); void grpc_init(void);
/* Shutdown the grpc library */ /* Shut down the grpc library */
void grpc_shutdown(void); void grpc_shutdown(void);
grpc_completion_queue *grpc_completion_queue_create(void); grpc_completion_queue *grpc_completion_queue_create(void);
/* Blocks until an event is available, the completion queue is being shutdown, /* Blocks until an event is available, the completion queue is being shut down,
or deadline is reached. Returns NULL on timeout, otherwise the event that or deadline is reached. Returns NULL on timeout, otherwise the event that
occurred. Callers should call grpc_event_finish once they have processed occurred. Callers should call grpc_event_finish once they have processed
the event. the event.
@ -365,7 +366,7 @@ grpc_event *grpc_completion_queue_next(grpc_completion_queue *cq,
grpc_event *grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, grpc_event *grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag,
gpr_timespec deadline); gpr_timespec deadline);
/* Cleanup any data owned by the event */ /* Clean up any data owned by the event */
void grpc_event_finish(grpc_event *event); void grpc_event_finish(grpc_event *event);
/* Begin destruction of a completion queue. Once all possible events are /* Begin destruction of a completion queue. Once all possible events are

Write Preview
Loading…
Cancel
Save