GRPC C++  1.36.1
slice.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2015 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #ifndef GRPCPP_IMPL_CODEGEN_SLICE_H
20 #define GRPCPP_IMPL_CODEGEN_SLICE_H
21 
25 
27 
28 namespace grpc {
29 
35 class Slice final {
36  public:
41 
42  enum AddRef { ADD_REF };
45  : slice_(g_core_codegen_interface->grpc_slice_ref(slice)) {}
46 
47  enum StealRef { STEAL_REF };
49  Slice(grpc_slice slice, StealRef) : slice_(slice) {}
50 
52  explicit Slice(size_t len)
54 
56  Slice(const void* buf, size_t len)
58  reinterpret_cast<const char*>(buf), len)) {}
59 
61  /* NOLINTNEXTLINE(google-explicit-constructor) */
62  Slice(const std::string& str)
64  str.c_str(), str.length())) {}
65 
67 
69  Slice(const void* buf, size_t len, StaticSlice)
71  reinterpret_cast<const char*>(buf), len)) {}
72 
74  Slice(const Slice& other)
75  : slice_(g_core_codegen_interface->grpc_slice_ref(other.slice_)) {}
76 
78  Slice& operator=(Slice other) {
79  std::swap(slice_, other.slice_);
80  return *this;
81  }
82 
88  Slice(void* buf, size_t len, void (*destroy)(void*), void* user_data)
90  buf, len, destroy, user_data)) {}
91 
93  Slice(void* buf, size_t len, void (*destroy)(void*))
94  : Slice(buf, len, destroy, buf) {}
95 
97  Slice(void* buf, size_t len, void (*destroy)(void*, size_t))
99  destroy)) {}
100 
102  size_t size() const { return GRPC_SLICE_LENGTH(slice_); }
103 
105  const uint8_t* begin() const { return GRPC_SLICE_START_PTR(slice_); }
106 
108  const uint8_t* end() const { return GRPC_SLICE_END_PTR(slice_); }
109 
111  grpc_slice c_slice() const {
113  }
114 
115  private:
116  friend class ByteBuffer;
117 
118  grpc_slice slice_;
119 };
120 
122  return grpc::string_ref(
123  reinterpret_cast<const char*>(GRPC_SLICE_START_PTR(*slice)),
124  GRPC_SLICE_LENGTH(*slice));
125 }
126 
127 inline std::string StringFromCopiedSlice(grpc_slice slice) {
128  return std::string(reinterpret_cast<char*>(GRPC_SLICE_START_PTR(slice)),
129  GRPC_SLICE_LENGTH(slice));
130 }
131 
132 inline grpc_slice SliceReferencingString(const std::string& str) {
134  str.length());
135 }
136 
137 inline grpc_slice SliceFromCopiedString(const std::string& str) {
139  str.length());
140 }
141 
142 } // namespace grpc
143 
144 #endif // GRPCPP_IMPL_CODEGEN_SLICE_H
grpc_slice_new_with_user_data
GPRAPI grpc_slice grpc_slice_new_with_user_data(void *p, size_t len, void(*destroy)(void *), void *user_data)
Equivalent to grpc_slice_new, but with a separate pointer that is passed to the destroy function.
grpc::StringRefFromSlice
grpc::string_ref StringRefFromSlice(const grpc_slice *slice)
Definition: slice.h:121
grpc::string_ref
This class is a non owning reference to a string.
Definition: string_ref.h:41
grpc_empty_slice
GPRAPI grpc_slice grpc_empty_slice(void)
grpc::Slice::STATIC_SLICE
@ STATIC_SLICE
Definition: slice.h:66
GRPC_SLICE_LENGTH
#define GRPC_SLICE_LENGTH(slice)
Definition: slice.h:99
grpc::Slice::Slice
Slice(size_t len)
Allocate a slice of specified size.
Definition: slice.h:52
grpc
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
grpc_slice_new_with_len
GPRAPI grpc_slice grpc_slice_new_with_len(void *p, size_t len, void(*destroy)(void *, size_t))
Equivalent to grpc_slice_new, but with a two argument destroy function that also takes the slice leng...
grpc::Slice::begin
const uint8_t * begin() const
Raw pointer to the beginning (first element) of the slice.
Definition: slice.h:105
config.h
grpc::SliceFromCopiedString
grpc_slice SliceFromCopiedString(const std::string &str)
Definition: slice.h:137
core_codegen_interface.h
grpc_slice_malloc
GPRAPI grpc_slice grpc_slice_malloc(size_t length)
Equivalent to grpc_slice_new(malloc(len), len, free), but saves one malloc() call.
grpc::Slice::ADD_REF
@ ADD_REF
Definition: slice.h:42
grpc::Slice::Slice
Slice(const void *buf, size_t len)
Construct a slice from a copied buffer.
Definition: slice.h:56
grpc::Slice::end
const uint8_t * end() const
Raw pointer to the end (one byte past the last element) of the slice.
Definition: slice.h:108
grpc::Slice::Slice
Slice(const Slice &other)
Copy constructor, adds a reference.
Definition: slice.h:74
grpc::Slice::STEAL_REF
@ STEAL_REF
Definition: slice.h:47
grpc_slice_from_copied_buffer
GPRAPI grpc_slice grpc_slice_from_copied_buffer(const char *source, size_t len)
Create a slice by copying a buffer.
grpc::Slice::Slice
Slice(void *buf, size_t len, void(*destroy)(void *, size_t))
Similar to the above but has a destroy that also takes slice length.
Definition: slice.h:97
grpc_slice_ref
GPRAPI grpc_slice grpc_slice_ref(grpc_slice s)
Increment the refcount of s.
grpc::Slice::size
size_t size() const
Byte size.
Definition: slice.h:102
grpc::Slice::StealRef
StealRef
Definition: slice.h:47
grpc::Slice::operator=
Slice & operator=(Slice other)
Assignment, reference count is unchanged.
Definition: slice.h:78
grpc::Slice::Slice
Slice()
Construct an empty slice.
Definition: slice.h:38
grpc::ByteBuffer
A sequence of bytes.
Definition: byte_buffer.h:61
grpc_slice
A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1].
Definition: slice.h:60
grpc::Slice::AddRef
AddRef
Definition: slice.h:42
grpc::Slice
A wrapper around grpc_slice.
Definition: slice.h:35
grpc::Slice::c_slice
grpc_slice c_slice() const
Raw C slice. Caller needs to call grpc_slice_unref when done.
Definition: slice.h:111
grpc::Slice::~Slice
~Slice()
Destructor - drops one reference.
Definition: slice.h:40
string_ref.h
grpc_slice_from_static_buffer
GPRAPI grpc_slice grpc_slice_from_static_buffer(const void *source, size_t len)
Create a slice pointing to constant memory.
grpc::Slice::StaticSlice
StaticSlice
Definition: slice.h:66
grpc::CoreCodegenInterface::grpc_slice_unref
virtual void grpc_slice_unref(grpc_slice slice)=0
grpc::Slice::Slice
Slice(const std::string &str)
Construct a slice from a copied string.
Definition: slice.h:62
GRPC_SLICE_START_PTR
#define GRPC_SLICE_START_PTR(slice)
Definition: slice.h:96
grpc::Slice::Slice
Slice(grpc_slice slice, StealRef)
Construct a slice from slice, stealing a reference.
Definition: slice.h:49
grpc::Slice::Slice
Slice(const void *buf, size_t len, StaticSlice)
Construct a slice from a static buffer.
Definition: slice.h:69
GRPC_SLICE_END_PTR
#define GRPC_SLICE_END_PTR(slice)
Definition: slice.h:105
grpc::CoreCodegenInterface::grpc_slice_from_static_buffer
virtual grpc_slice grpc_slice_from_static_buffer(const void *buffer, size_t length)=0
grpc::Slice::Slice
Slice(grpc_slice slice, AddRef)
Construct a slice from slice, adding a reference.
Definition: slice.h:44
grpc::g_core_codegen_interface
CoreCodegenInterface * g_core_codegen_interface
Definition: completion_queue.h:96
grpc::CoreCodegenInterface::grpc_slice_ref
virtual grpc_slice grpc_slice_ref(grpc_slice slice)=0
grpc::Slice::Slice
Slice(void *buf, size_t len, void(*destroy)(void *), void *user_data)
Create a slice pointing at some data.
Definition: slice.h:88
grpc::CoreCodegenInterface::grpc_slice_from_copied_buffer
virtual grpc_slice grpc_slice_from_copied_buffer(const void *buffer, size_t length)=0
grpc::Slice::Slice
Slice(void *buf, size_t len, void(*destroy)(void *))
Specialization of above for common case where buf == user_data.
Definition: slice.h:93
grpc::StringFromCopiedSlice
std::string StringFromCopiedSlice(grpc_slice slice)
Definition: slice.h:127
slice.h
grpc::SliceReferencingString
grpc_slice SliceReferencingString(const std::string &str)
Definition: slice.h:132