• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_SERIALIZATION_TRAITS_H
20 #define GRPCPP_IMPL_CODEGEN_SERIALIZATION_TRAITS_H
21 
22 namespace grpc {
23 
24 /// Defines how to serialize and deserialize some type.
25 ///
26 /// Used for hooking different message serialization API's into GRPC.
27 /// Each SerializationTraits<Message> implementation must provide the
28 /// following functions:
29 /// 1.  static Status Serialize(const Message& msg,
30 ///                             ByteBuffer* buffer,
31 ///                             bool* own_buffer);
32 ///     OR
33 ///     static Status Serialize(const Message& msg,
34 ///                             grpc_byte_buffer** buffer,
35 ///                             bool* own_buffer);
36 ///     The former is preferred; the latter is deprecated
37 ///
38 /// 2.  static Status Deserialize(ByteBuffer* buffer,
39 ///                               Message* msg);
40 ///     OR
41 ///     static Status Deserialize(grpc_byte_buffer* buffer,
42 ///                               Message* msg);
43 ///     The former is preferred; the latter is deprecated
44 ///
45 /// Serialize is required to convert message to a ByteBuffer, and
46 /// return that byte buffer through *buffer. *own_buffer should
47 /// be set to true if the caller owns said byte buffer, or false if
48 /// ownership is retained elsewhere.
49 ///
50 /// Deserialize is required to convert buffer into the message stored at
51 /// msg. max_receive_message_size is passed in as a bound on the maximum
52 /// number of message bytes Deserialize should accept.
53 ///
54 /// Both functions return a Status, allowing them to explain what went
55 /// wrong if required.
56 template <class Message,
57           class UnusedButHereForPartialTemplateSpecialization = void>
58 class SerializationTraits;
59 
60 }  // namespace grpc
61 
62 #endif  // GRPCPP_IMPL_CODEGEN_SERIALIZATION_TRAITS_H
63