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_BYTE_BUFFER_H
      35             : #define GRPCXX_SUPPORT_BYTE_BUFFER_H
      36             : 
      37             : #include <grpc/grpc.h>
      38             : #include <grpc/byte_buffer.h>
      39             : #include <grpc/support/log.h>
      40             : #include <grpc++/impl/serialization_traits.h>
      41             : #include <grpc++/support/config.h>
      42             : #include <grpc++/support/slice.h>
      43             : #include <grpc++/support/status.h>
      44             : 
      45             : #include <vector>
      46             : 
      47             : namespace grpc {
      48             : 
      49             : /// A sequence of bytes.
      50             : class ByteBuffer GRPC_FINAL {
      51             :  public:
      52             :   /// Constuct an empty buffer.
      53          13 :   ByteBuffer() : buffer_(nullptr) {}
      54             : 
      55             :   /// Construct buffer from \a slices, of which there are \a nslices.
      56             :   ByteBuffer(const Slice* slices, size_t nslices);
      57             : 
      58             :   ~ByteBuffer();
      59             : 
      60             :   /// Dump (read) the buffer contents into \a slices.
      61             :   void Dump(std::vector<Slice>* slices) const;
      62             : 
      63             :   /// Remove all data.
      64             :   void Clear();
      65             : 
      66             :   /// Buffer size in bytes.
      67             :   size_t Length() const;
      68             : 
      69             :  private:
      70             :   friend class SerializationTraits<ByteBuffer, void>;
      71             : 
      72             :   ByteBuffer(const ByteBuffer&);
      73             :   ByteBuffer& operator=(const ByteBuffer&);
      74             : 
      75             :   // takes ownership
      76          25 :   void set_buffer(grpc_byte_buffer* buf) {
      77          25 :     if (buffer_) {
      78           1 :       gpr_log(GPR_ERROR, "Overriding existing buffer");
      79           1 :       Clear();
      80             :     }
      81          25 :     buffer_ = buf;
      82          25 :   }
      83             : 
      84             :   // For \a SerializationTraits's usage.
      85          25 :   grpc_byte_buffer* buffer() const { return buffer_; }
      86             : 
      87             :   grpc_byte_buffer* buffer_;
      88             : };
      89             : 
      90             : template <>
      91             : class SerializationTraits<ByteBuffer, void> {
      92             :  public:
      93          25 :   static Status Deserialize(grpc_byte_buffer* byte_buffer, ByteBuffer* dest,
      94             :                             int max_message_size) {
      95          25 :     dest->set_buffer(byte_buffer);
      96          25 :     return Status::OK;
      97             :   }
      98          25 :   static Status Serialize(const ByteBuffer& source, grpc_byte_buffer** buffer,
      99             :                           bool* own_buffer) {
     100          25 :     *buffer = source.buffer();
     101          25 :     *own_buffer = false;
     102          25 :     return Status::OK;
     103             :   }
     104             : };
     105             : 
     106             : }  // namespace grpc
     107             : 
     108             : #endif  // GRPCXX_SUPPORT_BYTE_BUFFER_H