Line data    Source code

       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 GRPCXX_SUPPORT_SLICE_H
      35             : #define GRPCXX_SUPPORT_SLICE_H
      36             : 
      37             : #include <grpc/support/slice.h>
      38             : #include <grpc++/support/config.h>
      39             : 
      40             : namespace grpc {
      41             : 
      42             : /// A wrapper around \a grpc_slice.
      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.
      47             : class Slice GRPC_FINAL {
      48             :  public:
      49             :   /// Construct an empty slice.
      50             :   Slice();
      51             :   // Destructor - drops one reference.
      52             :   ~Slice();
      53             : 
      54             :   enum AddRef { ADD_REF };
      55             :   /// Construct a slice from \a slice, adding a reference.
      56             :   Slice(gpr_slice slice, AddRef);
      57             : 
      58             :   enum StealRef { STEAL_REF };
      59             :   /// Construct a slice from \a slice, stealing a reference.
      60             :   Slice(gpr_slice slice, StealRef);
      61             : 
      62             :   /// Copy constructor, adds a reference.
      63             :   Slice(const Slice& other);
      64             : 
      65             :   /// Assignment, reference count is unchanged.
      66             :   Slice& operator=(Slice other) {
      67             :     std::swap(slice_, other.slice_);
      68             :     return *this;
      69             :   }
      70             : 
      71             :   /// Byte size.
      72         110 :   size_t size() const { return GPR_SLICE_LENGTH(slice_); }
      73             : 
      74             :   /// Raw pointer to the beginning (first element) of the slice.
      75         103 :   const gpr_uint8* begin() const { return GPR_SLICE_START_PTR(slice_); }
      76             : 
      77             :   /// Raw pointer to the end (one byte \em past the last element) of the slice.
      78             :   const gpr_uint8* end() const { return GPR_SLICE_END_PTR(slice_); }
      79             : 
      80             :  private:
      81             :   friend class ByteBuffer;
      82             : 
      83             :   gpr_slice slice_;
      84             : };
      85             : 
      86             : }  // namespace grpc
      87             : 
      88             : #endif  // GRPCXX_SUPPORT_SLICE_H