refine code and add README

3 files changed, 142 insertions, 244 deletions

diff --git a/include/grpc++/impl/codegen/thrift_serializer.h b/include/grpc++/impl/codegen/thrift_serializer.h
index 315d76cf2a..46112ee5b2 100644
--- a/include/grpc++/impl/codegen/thrift_serializer.h
+++ b/include/grpc++/impl/codegen/thrift_serializer.h
@@ -36,12 +36,16 @@
 
 #include <memory>
 #include <string>
-
+#include <stdexcept>
+#include <grpc/impl/codegen/byte_buffer.h>
+#include <grpc/impl/codegen/byte_buffer_reader.h>
+#include <grpc/impl/codegen/slice.h>
+#include <grpc/impl/codegen/slice_buffer.h>
 #include <thrift/protocol/TBinaryProtocol.h>
 #include <thrift/protocol/TCompactProtocol.h>
+#include <thrift/protocol/TProtocolException.h>
 #include <thrift/transport/TBufferTransports.h>
 #include <thrift/transport/TTransportUtils.h>
-#include <grpc/impl/codegen/byte_buffer.h>
 
 namespace apache {
 namespace thrift {
@@ -49,100 +53,165 @@ namespace util {
 
 using apache::thrift::protocol::TBinaryProtocolT;
 using apache::thrift::protocol::TCompactProtocolT;
+using apache::thrift::protocol::TMessageType;
 using apache::thrift::protocol::TNetworkBigEndian;
 using apache::thrift::transport::TMemoryBuffer;
 using apache::thrift::transport::TBufferBase;
 using apache::thrift::transport::TTransport;
-using std::shared_ptr;
 
-
-template <typename Dummy, typename P>
-class ThriftSerializer {
+template <typename Dummy, typename Protocol> class ThriftSerializer {
 public:
   ThriftSerializer()
-  : prepared_ (false)
-  , lastDeserialized_ (false)
-  , serializeVersion_ (false) {}
-
-  /**
-   * Serialize the passed type into the internal buffer
-   * and returns a pointer to internal buffer and its size
-   *
-   */
-  template <typename T>
-  void serialize(const T& fields, const uint8_t** serializedBuffer,
-      size_t* serializedLen);
-
-  /**
-   * Serialize the passed type into the byte buffer
-   */
-  template <typename T>
-  void serialize(const T& fields, grpc_byte_buffer** bp);
-
-  /**
-   * Deserialize the passed char array into  the passed type, returns the number
-   * of bytes that have been consumed from the passed string.
-   */
-  template <typename T>
-  uint32_t deserialize(const uint8_t* serializedBuffer, size_t length,
-      T* fields);
-
-  /**
-   * Deserialize the passed byte buffer to passed type, returns the number
-   * of bytes consumed from byte buffer
-   */
-  template <typename T>
-  uint32_t deserialize(grpc_byte_buffer* buffer, T* msg);
-
-  void setSerializeVersion(bool value);
+      : prepared_ (false)
+      , last_deserialized_ (false)
+      , serialize_version_ (false) {}
 
   virtual ~ThriftSerializer() {}
 
+  // Serialize the passed type into the internal buffer
+  // and returns a pointer to internal buffer and its size
+  template <typename T> void Serialize(const T& fields, const uint8_t** serializedBuffer,
+      size_t* serializedLen) {
+     // prepare or reset buffer
+    if (!prepared_ || last_deserialized_) {
+      prepare();
+    } else {
+      buffer_->resetBuffer();
+    }
+    last_deserialized_ = false;
+
+    // if required serialize protocol version
+    if (serialize_version_) {
+      protocol_->writeMessageBegin("", TMessageType(0), 0);
+    }
+
+    // serilaize fields into buffer
+    fields.write(protocol_.get());
+
+    // write the end of message
+    if (serialize_version_) {
+      protocol_->writeMessageEnd();
+    }
+
+    uint8_t* byteBuffer;
+    uint32_t byteBufferSize;
+    buffer_->getBuffer(&byteBuffer, &byteBufferSize);
+    *serializedBuffer = byteBuffer;
+    *serializedLen = byteBufferSize; 
+  }
+
+  // Serialize the passed type into the byte buffer
+  template <typename T> void Serialize(const T& fields, grpc_byte_buffer** bp) {
+
+    const uint8_t* byteBuffer;
+    size_t byteBufferSize;
+
+    Serialize(fields, &byteBuffer, &byteBufferSize);
+
+    gpr_slice slice = gpr_slice_from_copied_buffer((char*)byteBuffer,byteBufferSize);
+
+    *bp = grpc_raw_byte_buffer_create(&slice, 1);
 
-  /**
-   * Set the container size limit to deserialize
-   * This function should be called after buffer_ is initialized
-   */
-  void setContainerSizeLimit(int32_t container_limit) {
+    gpr_slice_unref(slice);
+  }
+
+  // Deserialize the passed char array into  the passed type, returns the number
+  // of bytes that have been consumed from the passed string.
+  template <typename T> uint32_t Deserialize(const uint8_t* serializedBuffer, size_t length,
+      T* fields) {
+    // prepare buffer if necessary
+    if (!prepared_) {
+      prepare();
+    }
+    last_deserialized_ = true;
+
+    //reset buffer transport 
+    buffer_->resetBuffer((uint8_t*)serializedBuffer, length);
+
+    // read the protocol version if necessary
+    if (serialize_version_) {
+      std::string name = "";
+      TMessageType mt = (TMessageType) 0;
+      int32_t seq_id = 0;
+      protocol_->readMessageBegin(name, mt, seq_id);
+    }
+
+    // deserialize buffer into fields
+    uint32_t len = fields->read(protocol_.get());
+
+    // read the end of message
+    if (serialize_version_) {
+      protocol_->readMessageEnd();
+    }
+
+    return len;
+  }
+
+
+  // Deserialize the passed byte buffer to passed type, returns the number
+  // of bytes consumed from byte buffer
+  template <typename T> uint32_t Deserialize(grpc_byte_buffer* buffer, T* msg) {
+
+    grpc_byte_buffer_reader reader;
+    grpc_byte_buffer_reader_init(&reader, buffer);
+
+    gpr_slice slice = grpc_byte_buffer_reader_readall(&reader);
+
+    uint32_t len = Deserialize(GPR_SLICE_START_PTR(slice), GPR_SLICE_LENGTH(slice), msg);
+
+    gpr_slice_unref(slice);
+
+    grpc_byte_buffer_reader_destroy(&reader);
+
+    return len;
+  }
+
+  // set serialization version flag
+  void SetSerializeVersion(bool value) {
+    serialize_version_ = value;
+  }
+
+  // Set the container size limit to deserialize
+  // This function should be called after buffer_ is initialized
+  void SetContainerSizeLimit(int32_t container_limit) {
     if (!prepared_) {
       prepare();
     }
     protocol_->setContainerSizeLimit(container_limit);
   }
 
-  /**
-   * Set the string size limit to deserialize
-   * This function should be called after buffer_ is initialized
-   */
-  void setStringSizeLimit(int32_t string_limit) {
+  // Set the string size limit to deserialize
+  // This function should be called after buffer_ is initialized
+  void SetStringSizeLimit(int32_t string_limit) {
     if (!prepared_) {
       prepare();
     }
     protocol_->setStringSizeLimit(string_limit);
   }
 
+private:
+  bool prepared_;
+  bool last_deserialized_;
+  boost::shared_ptr<TMemoryBuffer> buffer_;
+  std::shared_ptr<Protocol> protocol_;
+  bool serialize_version_;
 
-  private:
-    void prepare();
-
-  private:
-    typedef P Protocol;
-    bool prepared_;
-    bool lastDeserialized_;
-    boost::shared_ptr<TMemoryBuffer> buffer_;
-    shared_ptr<Protocol> protocol_;
-    bool serializeVersion_;
-}; // ThriftSerializer
+  void prepare() {
+    buffer_.reset(new TMemoryBuffer());
 
-template <typename Dummy = void>
-struct ThriftSerializerBinary : public ThriftSerializer<Dummy, TBinaryProtocolT<TBufferBase, TNetworkBigEndian> > {};
+    // create a protocol for the memory buffer transport
+    protocol_.reset(new Protocol(buffer_));
 
+    prepared_ = true;
+  }
 
-template <typename Dummy = void>
-struct ThriftSerializerCompact : public ThriftSerializer<Dummy, TCompactProtocolT<TBufferBase> >{ };
+}; // ThriftSerializer
 
-}}} // namespace apache::thrift::util
+typedef ThriftSerializer<void, TBinaryProtocolT<TBufferBase, TNetworkBigEndian>> ThriftSerializerBinary;
+typedef ThriftSerializer<void, TCompactProtocolT<TBufferBase>> ThriftSerializerCompact;
 
-#include <grpc++/impl/codegen/thrift_serializer_inl.h>
+} // namespace util
+} // namespace thrift
+} // namespace apache
 
-#endif
+#endif
\ No newline at end of file
diff --git a/include/grpc++/impl/codegen/thrift_serializer_inl.h b/include/grpc++/impl/codegen/thrift_serializer_inl.h
deleted file mode 100644
index 866ecf6312..0000000000
--- a/include/grpc++/impl/codegen/thrift_serializer_inl.h
+++ /dev/null
@@ -1,169 +0,0 @@
-/*
- *
- * Copyright 2016, Google Inc.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met:
- *
- *     * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following disclaimer
- * in the documentation and/or other materials provided with the
- * distribution.
- *     * Neither the name of Google Inc. nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
-
- #ifndef GRPCXX_IMPL_CODEGEN_THRIFT_SERIALIZER_INL_H
- #define GRPCXX_IMPL_CODEGEN_THRIFT_SERIALIZER_INL_H
-
-#include <stdexcept>
-#include <string>
-#include <grpc++/impl/codegen/thrift_serializer.h>
-#include <grpc/impl/codegen/byte_buffer_reader.h>
-#include <grpc/impl/codegen/slice.h>
-#include <grpc/impl/codegen/slice_buffer.h>
-#include <thrift/protocol/TProtocolException.h>
-
-namespace apache {
-namespace thrift {
-namespace util {
-
-using apache::thrift::protocol::TMessageType;
-
-template <typename Dummy, typename P>
-template <typename T>
-void ThriftSerializer<Dummy, P>::serialize(const T& fields,
-    const uint8_t** serializedBuffer, size_t* serializedLen) {
-
-  // prepare or reset buffer
-  if (!prepared_ || lastDeserialized_) {
-    prepare();
-  } else {
-    buffer_->resetBuffer();
-  }
-  lastDeserialized_ = false;
-
-  // if required serialize protocol version
-  if (serializeVersion_) {
-    protocol_->writeMessageBegin("", TMessageType(0), 0);
-  }
-
-  // serilaize fields into buffer
-  fields.write(protocol_.get());
-
-  // write the end of message
-  if (serializeVersion_) {
-    protocol_->writeMessageEnd();
-  }
-
-  // assign buffer to string
-  uint8_t* byteBuffer;
-  uint32_t byteBufferSize;
-  buffer_->getBuffer(&byteBuffer, &byteBufferSize);
-  *serializedBuffer = byteBuffer;
-  *serializedLen = byteBufferSize; 
-}
-
-template <typename Dummy, typename P>
-template <typename T>
-void ThriftSerializer<Dummy, P>::serialize(const T& fields, grpc_byte_buffer** bp) {
-
-  const uint8_t* byteBuffer;
-  size_t byteBufferSize;
-  serialize(fields, &byteBuffer, &byteBufferSize);
-
-  gpr_slice slice = gpr_slice_from_copied_buffer((char*)byteBuffer,byteBufferSize);
-
-  *bp = grpc_raw_byte_buffer_create(&slice, 1);
-
-  gpr_slice_unref(slice);
-}
-
-template <typename Dummy, typename P>
-template <typename T>
-uint32_t ThriftSerializer<Dummy, P>::deserialize(const uint8_t* serializedBuffer,
-    size_t length, T* fields) {
-  // prepare buffer if necessary
-  if (!prepared_) {
-    prepare();
-  }
-  lastDeserialized_ = true;
-
-  //reset buffer transport 
-  buffer_->resetBuffer((uint8_t*)serializedBuffer, length);
-
-  // read the protocol version if necessary
-  if (serializeVersion_) {
-    std::string name = "";
-    TMessageType mt = (TMessageType) 0;
-    int32_t seq_id = 0;
-    protocol_->readMessageBegin(name, mt, seq_id);
-  }
-
-  // deserialize buffer into fields
-  uint32_t len = fields->read(protocol_.get());
-
-  // read the end of message
-  if (serializeVersion_) {
-    protocol_->readMessageEnd();
-  }
-
-  return len;
-}
-
-template <typename Dummy, typename P>
-template <typename T>
-uint32_t ThriftSerializer<Dummy, P>::deserialize(grpc_byte_buffer* bp, T* fields) {
-  grpc_byte_buffer_reader reader;
-  grpc_byte_buffer_reader_init(&reader, bp);
-
-  gpr_slice slice = grpc_byte_buffer_reader_readall(&reader);
-
-  uint32_t len = deserialize(GPR_SLICE_START_PTR(slice), GPR_SLICE_LENGTH(slice), fields);
-
-  gpr_slice_unref(slice);
-
-  grpc_byte_buffer_reader_destroy(&reader);
-
-  return len;
-}
-
-template <typename Dummy, typename P>
-void ThriftSerializer<Dummy, P>::setSerializeVersion(bool value) {
-  serializeVersion_ = value;
-}
-
-template <typename Dummy, typename P>
-void
-ThriftSerializer<Dummy, P>::prepare()
-{
-  
-  buffer_.reset(new TMemoryBuffer());
-
-  // create a protocol for the memory buffer transport
-  protocol_.reset(new Protocol(buffer_));
-
-  prepared_ = true;
-}
-
-}}} // namespace apache::thrift::util
-
-#endif
diff --git a/include/grpc++/impl/codegen/thrift_utils.h b/include/grpc++/impl/codegen/thrift_utils.h
index 629441149f..14332c0521 100644
--- a/include/grpc++/impl/codegen/thrift_utils.h
+++ b/include/grpc++/impl/codegen/thrift_utils.h
@@ -44,9 +44,7 @@
 #include <grpc++/impl/codegen/status.h>
 #include <grpc++/impl/codegen/status_code_enum.h>
 #include <grpc++/impl/codegen/thrift_serializer.h>
-#include <cstdbool>
 #include <cstdint>
-#include <string>
 #include <cstdlib>
 
 namespace grpc {
@@ -62,9 +60,9 @@ class SerializationTraits<T,typename std::enable_if<std::is_base_of<apache::thri
 
     *own_buffer = true;
 
-    ThriftSerializerCompact<T> serializer;
+    ThriftSerializerCompact serializer;
 
-    serializer.serialize(msg, bp);
+    serializer.Serialize(msg, bp);
 
     return Status(StatusCode::OK, "ok");
   }
@@ -76,8 +74,8 @@ class SerializationTraits<T,typename std::enable_if<std::is_base_of<apache::thri
       return Status(StatusCode::INTERNAL, "No payload");
     }
 
-    ThriftSerializerCompact<T> deserializer;
-    deserializer.deserialize(buffer, msg);
+    ThriftSerializerCompact deserializer;
+    deserializer.Deserialize(buffer, msg);
 
     grpc_byte_buffer_destroy(buffer);