GRPC Core 0.10.0.0

- Main Page
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
byte_buffer.h
Go to the documentation of this file.
1 /*
2 *
3 * Copyright 2015, Google Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
34 #ifndef GRPC_BYTE_BUFFER_H
35 #define GRPC_BYTE_BUFFER_H
36
37 #include <grpc/compression.h>
38 #include <grpc/support/slice_buffer.h>
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 typedef enum {
45 GRPC_BB_RAW
46 /* Future types may include GRPC_BB_PROTOBUF, etc. */
47 } grpc_byte_buffer_type;
48
49 struct grpc_byte_buffer {
50 grpc_byte_buffer_type type;
51 union {
52 struct {
53 grpc_compression_algorithm compression;
54 gpr_slice_buffer slice_buffer;
55 } raw;
56 } data;
57 };
58 typedef struct grpc_byte_buffer grpc_byte_buffer;
59
64 grpc_byte_buffer *grpc_raw_byte_buffer_create(gpr_slice *slices,
65 size_t nslices);
66
73 grpc_byte_buffer *grpc_raw_compressed_byte_buffer_create(
74 gpr_slice *slices, size_t nslices, grpc_compression_algorithm compression);
75
80 grpc_byte_buffer *grpc_byte_buffer_copy(grpc_byte_buffer *bb);
81
83 size_t grpc_byte_buffer_length(grpc_byte_buffer *bb);
84
86 void grpc_byte_buffer_destroy(grpc_byte_buffer *byte_buffer);
87
89 struct grpc_byte_buffer_reader;
90 typedef struct grpc_byte_buffer_reader grpc_byte_buffer_reader;
91
93 void grpc_byte_buffer_reader_init(grpc_byte_buffer_reader *reader,
94 grpc_byte_buffer *buffer);
95
97 void grpc_byte_buffer_reader_destroy(grpc_byte_buffer_reader *reader);
98
102 int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader *reader,
103 gpr_slice *slice);
104
106 grpc_byte_buffer *grpc_raw_byte_buffer_from_reader(
107 grpc_byte_buffer_reader *reader);
108
109 #ifdef __cplusplus
110 }
111 #endif
112
113 #endif /* GRPC_BYTE_BUFFER_H */
compression.h
grpc_compression_algorithm
grpc_compression_algorithm
Definition: compression.h:45
grpc_byte_buffer_reader_next
int grpc_byte_buffer_reader_next(grpc_byte_buffer_reader *reader, gpr_slice *slice)
Updates slice with the next piece of data from from reader and returns.
grpc_byte_buffer::data
union grpc_byte_buffer::@0 data
grpc_byte_buffer_reader_init
void grpc_byte_buffer_reader_init(grpc_byte_buffer_reader *reader, grpc_byte_buffer *buffer)
Initialize reader to read over buffer.
grpc_byte_buffer::slice_buffer
gpr_slice_buffer slice_buffer
Definition: byte_buffer.h:54
grpc_byte_buffer::type
grpc_byte_buffer_type type
Definition: byte_buffer.h:50
grpc_byte_buffer
Definition: byte_buffer.h:49
gpr_slice_buffer
Definition: slice_buffer.h:48
GRPC_BB_RAW
Definition: byte_buffer.h:45
grpc_byte_buffer_type
grpc_byte_buffer_type
Definition: byte_buffer.h:44
grpc_byte_buffer_destroy
void grpc_byte_buffer_destroy(grpc_byte_buffer *byte_buffer)
Destroys byte_buffer deallocating all its memory.
grpc_raw_compressed_byte_buffer_create
grpc_byte_buffer * grpc_raw_compressed_byte_buffer_create(gpr_slice *slices, size_t nslices, grpc_compression_algorithm compression)
Returns a compressed RAW byte buffer instance over the given slices (up to nslices).
grpc_raw_byte_buffer_from_reader
grpc_byte_buffer * grpc_raw_byte_buffer_from_reader(grpc_byte_buffer_reader *reader)
Returns a RAW byte buffer instance from the output of reader.
grpc_byte_buffer::raw
struct grpc_byte_buffer::@0::@1 raw
grpc_byte_buffer::compression
grpc_compression_algorithm compression
Definition: byte_buffer.h:53
grpc_byte_buffer_reader_destroy
void grpc_byte_buffer_reader_destroy(grpc_byte_buffer_reader *reader)
Cleanup and destroy reader.
grpc_byte_buffer_length
size_t grpc_byte_buffer_length(grpc_byte_buffer *bb)
Returns the size of the given byte buffer, in bytes.
slice_buffer.h
grpc_raw_byte_buffer_create
grpc_byte_buffer * grpc_raw_byte_buffer_create(gpr_slice *slices, size_t nslices)
Returns a RAW byte buffer instance over the given slices (up to nslices).
grpc_byte_buffer_reader
Definition: byte_buffer_reader.h:44
gpr_slice
Definition: slice.h:79
grpc_byte_buffer_copy
grpc_byte_buffer * grpc_byte_buffer_copy(grpc_byte_buffer *bb)
Copies input byte buffer bb.