diff options
Diffstat (limited to 'include')
-rw-r--r-- | include/grpc++/byte_buffer.h | 1 | ||||
-rw-r--r-- | include/grpc/byte_buffer.h | 60 | ||||
-rw-r--r-- | include/grpc/byte_buffer_reader.h | 3 | ||||
-rw-r--r-- | include/grpc/compression.h | 49 | ||||
-rw-r--r-- | include/grpc/grpc.h | 29 | ||||
-rw-r--r-- | include/grpc/grpc_security.h | 2 |
6 files changed, 110 insertions, 34 deletions
diff --git a/include/grpc++/byte_buffer.h b/include/grpc++/byte_buffer.h index ceb62622fd..3e40eaed1d 100644 --- a/include/grpc++/byte_buffer.h +++ b/include/grpc++/byte_buffer.h @@ -35,6 +35,7 @@ #define GRPCXX_BYTE_BUFFER_H #include <grpc/grpc.h> +#include <grpc/byte_buffer.h> #include <grpc/support/log.h> #include <grpc++/config.h> #include <grpc++/slice.h> diff --git a/include/grpc/byte_buffer.h b/include/grpc/byte_buffer.h index 06077a02a9..6d08474d8c 100644 --- a/include/grpc/byte_buffer.h +++ b/include/grpc/byte_buffer.h @@ -34,22 +34,74 @@ #ifndef GRPC_BYTE_BUFFER_H #define GRPC_BYTE_BUFFER_H -#include <grpc/grpc.h> +#include <grpc/compression.h> #include <grpc/support/slice_buffer.h> #ifdef __cplusplus extern "C" { #endif -typedef enum { GRPC_BB_SLICE_BUFFER } grpc_byte_buffer_type; +typedef enum { + GRPC_BB_RAW + /* Future types may include GRPC_BB_PROTOBUF, etc. */ +} grpc_byte_buffer_type; -/* byte buffers are containers for messages passed in from the public api's */ struct grpc_byte_buffer { grpc_byte_buffer_type type; union { - gpr_slice_buffer slice_buffer; + struct { + grpc_compression_algorithm compression; + gpr_slice_buffer slice_buffer; + } raw; } data; }; +typedef struct grpc_byte_buffer grpc_byte_buffer; + +/** Returns a RAW byte buffer instance over the given slices (up to \a nslices). + * + * Increases the reference count for all \a slices processed. The user is + * responsible for invoking grpc_byte_buffer_destroy on the returned instance.*/ +grpc_byte_buffer *grpc_raw_byte_buffer_create(gpr_slice *slices, + size_t nslices); + +/** Returns a *compressed* RAW byte buffer instance over the given slices (up to + * \a nslices). The \a compression argument defines the compression algorithm + * used to generate the data in \a slices. + * + * Increases the reference count for all \a slices processed. The user is + * responsible for invoking grpc_byte_buffer_destroy on the returned instance.*/ +grpc_byte_buffer *grpc_raw_compressed_byte_buffer_create( + gpr_slice *slices, size_t nslices, grpc_compression_algorithm compression); + +/** Copies input byte buffer \a bb. + * + * Increases the reference count of all the source slices. The user is + * responsible for calling grpc_byte_buffer_destroy over the returned copy. */ +grpc_byte_buffer *grpc_byte_buffer_copy(grpc_byte_buffer *bb); + +/** Returns the size of the given byte buffer, in bytes. */ +size_t grpc_byte_buffer_length(grpc_byte_buffer *bb); + +/** Destroys \a byte_buffer deallocating all its memory. */ +void grpc_byte_buffer_destroy(grpc_byte_buffer *byte_buffer); + + +/** Reader for byte buffers. Iterates over slices in the byte buffer */ +struct grpc_byte_buffer_reader; +typedef struct grpc_byte_buffer_reader grpc_byte_buffer_reader; + +/** Initialize \a reader to read over \a buffer */ +void grpc_byte_buffer_reader_init(grpc_byte_buffer_reader *reader, + grpc_byte_buffer *buffer); + +/** Cleanup and destroy \a reader */ +void grpc_byte_buffer_reader_destroy(grpc_byte_buffer_reader *reader); + +/** Updates \a slice with the next piece of data from from \a reader and returns + * 1. Returns 0 at the end of the stream. Caller is responsible for calling + * gpr_slice_unref on the result. */ +int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader *reader, + gpr_slice *slice); #ifdef __cplusplus } diff --git a/include/grpc/byte_buffer_reader.h b/include/grpc/byte_buffer_reader.h index d3da27cf1c..1ef817cf30 100644 --- a/include/grpc/byte_buffer_reader.h +++ b/include/grpc/byte_buffer_reader.h @@ -42,7 +42,8 @@ extern "C" { #endif struct grpc_byte_buffer_reader { - grpc_byte_buffer *buffer; + grpc_byte_buffer *buffer_in; + grpc_byte_buffer *buffer_out; /* Different current objects correspond to different types of byte buffers */ union { /* Index into a slice buffer's array of slices */ diff --git a/include/grpc/compression.h b/include/grpc/compression.h new file mode 100644 index 0000000000..630fa1656a --- /dev/null +++ b/include/grpc/compression.h @@ -0,0 +1,49 @@ +/* + * + * Copyright 2015, Google Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google Inc. nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ + +#ifndef GRPC_COMPRESSION_H +#define GRPC_COMPRESSION_H + +/* The various compression algorithms supported by GRPC */ +typedef enum { + GRPC_COMPRESS_NONE = 0, + GRPC_COMPRESS_DEFLATE, + GRPC_COMPRESS_GZIP, + /* TODO(ctiller): snappy */ + GRPC_COMPRESS_ALGORITHMS_COUNT +} grpc_compression_algorithm; + +const char *grpc_compression_algorithm_name( + grpc_compression_algorithm algorithm); + +#endif /* GRPC_COMPRESSION_H */ diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h index 298e2cf257..2caa9680ba 100644 --- a/include/grpc/grpc.h +++ b/include/grpc/grpc.h @@ -37,6 +37,7 @@ #include <grpc/status.h> #include <stddef.h> +#include <grpc/byte_buffer.h> #include <grpc/support/slice.h> #include <grpc/support/time.h> @@ -155,34 +156,6 @@ typedef enum grpc_call_error { (start_write/add_metadata). Illegal on invoke/accept. */ #define GRPC_WRITE_NO_COMPRESS (0x00000002u) -/* A buffer of bytes */ -struct grpc_byte_buffer; -typedef struct grpc_byte_buffer grpc_byte_buffer; - -/* 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_copy(grpc_byte_buffer *bb); -size_t grpc_byte_buffer_length(grpc_byte_buffer *bb); -void grpc_byte_buffer_destroy(grpc_byte_buffer *byte_buffer); - -/* Reader for byte buffers. Iterates over slices in the byte buffer */ -struct grpc_byte_buffer_reader; -typedef struct grpc_byte_buffer_reader grpc_byte_buffer_reader; - -/** Initialize \a reader to read over \a buffer */ -void grpc_byte_buffer_reader_init(grpc_byte_buffer_reader *reader, - grpc_byte_buffer *buffer); - -/** Cleanup and destroy \a reader */ -void grpc_byte_buffer_reader_destroy(grpc_byte_buffer_reader *reader); - -/* At the end of the stream, returns 0. Otherwise, returns 1 and sets slice to - be the returned slice. Caller is responsible for calling gpr_slice_unref on - the result. */ -int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader *reader, - gpr_slice *slice); - /* A single metadata element */ typedef struct grpc_metadata { const char *key; diff --git a/include/grpc/grpc_security.h b/include/grpc/grpc_security.h index 82f8f442a3..e104b6952f 100644 --- a/include/grpc/grpc_security.h +++ b/include/grpc/grpc_security.h @@ -117,7 +117,7 @@ grpc_credentials *grpc_service_account_credentials_create( grpc_credentials *grpc_jwt_credentials_create(const char *json_key, gpr_timespec token_lifetime); -/* Creates an Oauth2 Refresh Token crednetials object. May return NULL if the +/* Creates an Oauth2 Refresh Token credentials object. May return NULL if the input is invalid. WARNING: Do NOT use this credentials to connect to a non-google service as this could result in an oauth2 token leak. |