Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 6169d5f | 2016-03-31 07:46:18 -0700 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 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 | |
yang-g | 9e2f90c | 2015-08-21 15:35:03 -0700 | [diff] [blame] | 34 | #ifndef GRPCXX_SUPPORT_SLICE_H |
| 35 | #define GRPCXX_SUPPORT_SLICE_H |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 36 | |
yang-g | 9e2f90c | 2015-08-21 15:35:03 -0700 | [diff] [blame] | 37 | #include <grpc++/support/config.h> |
Craig Tiller | f40df23 | 2016-03-25 13:38:14 -0700 | [diff] [blame] | 38 | #include <grpc/support/slice.h> |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 39 | |
| 40 | namespace grpc { |
| 41 | |
Vijay Pai | 93beeb8 | 2016-01-07 12:12:40 -0800 | [diff] [blame] | 42 | /// A wrapper around \a gpr_slice. |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 43 | /// |
| 44 | /// A slice represents a contiguous reference counted array of bytes. |
| 45 | /// It is cheap to take references to a slice, and it is cheap to create a |
| 46 | /// slice pointing to a subset of another slice. |
Yang Gao | 61c4131 | 2015-03-10 12:42:18 -0700 | [diff] [blame] | 47 | class Slice GRPC_FINAL { |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 48 | public: |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 49 | /// Construct an empty slice. |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 50 | Slice(); |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 51 | // Destructor - drops one reference. |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 52 | ~Slice(); |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 53 | |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 54 | enum AddRef { ADD_REF }; |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 55 | /// Construct a slice from \a slice, adding a reference. |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 56 | Slice(gpr_slice slice, AddRef); |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 57 | |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 58 | enum StealRef { STEAL_REF }; |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 59 | /// Construct a slice from \a slice, stealing a reference. |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 60 | Slice(gpr_slice slice, StealRef); |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 61 | |
| 62 | /// Copy constructor, adds a reference. |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 63 | Slice(const Slice& other); |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 64 | |
| 65 | /// Assignment, reference count is unchanged. |
Yang Gao | 61c4131 | 2015-03-10 12:42:18 -0700 | [diff] [blame] | 66 | Slice& operator=(Slice other) { |
| 67 | std::swap(slice_, other.slice_); |
| 68 | return *this; |
| 69 | } |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 70 | |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 71 | /// Byte size. |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 72 | size_t size() const { return GPR_SLICE_LENGTH(slice_); } |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 73 | |
| 74 | /// Raw pointer to the beginning (first element) of the slice. |
Craig Tiller | 7536af0 | 2015-12-22 13:49:30 -0800 | [diff] [blame] | 75 | const uint8_t* begin() const { return GPR_SLICE_START_PTR(slice_); } |
Craig Tiller | d6599a3 | 2015-09-03 09:37:02 -0700 | [diff] [blame] | 76 | |
| 77 | /// Raw pointer to the end (one byte \em past the last element) of the slice. |
Craig Tiller | 7536af0 | 2015-12-22 13:49:30 -0800 | [diff] [blame] | 78 | const uint8_t* end() const { return GPR_SLICE_END_PTR(slice_); } |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 79 | |
yang-g | a324c4f | 2016-06-24 11:57:07 -0700 | [diff] [blame] | 80 | /// Raw C slice. Caller needs to call gpr_slice_unref when done. |
| 81 | gpr_slice c_slice() const { return gpr_slice_ref(slice_); } |
| 82 | |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 83 | private: |
Yang Gao | 61c4131 | 2015-03-10 12:42:18 -0700 | [diff] [blame] | 84 | friend class ByteBuffer; |
| 85 | |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 86 | gpr_slice slice_; |
| 87 | }; |
| 88 | |
Yang Gao | 61c4131 | 2015-03-10 12:42:18 -0700 | [diff] [blame] | 89 | } // namespace grpc |
Craig Tiller | db57c4f | 2015-02-24 10:34:47 -0800 | [diff] [blame] | 90 | |
David Garcia Quintas | 2bf574f | 2016-01-14 15:27:08 -0800 | [diff] [blame] | 91 | #endif // GRPCXX_SUPPORT_SLICE_H |