3 * Copyright 2015 gRPC authors.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #ifndef GRPCPP_IMPL_CODEGEN_SERIALIZATION_TRAITS_H
20 #define GRPCPP_IMPL_CODEGEN_SERIALIZATION_TRAITS_H
22 // IWYU pragma: private, include <grpcpp/impl/serialization_traits.h>
26 /// Defines how to serialize and deserialize some type.
28 /// Used for hooking different message serialization API's into GRPC.
29 /// Each SerializationTraits<Message> implementation must provide the
30 /// following functions:
31 /// 1. static Status Serialize(const Message& msg,
32 /// ByteBuffer* buffer,
33 /// bool* own_buffer);
35 /// static Status Serialize(const Message& msg,
36 /// grpc_byte_buffer** buffer,
37 /// bool* own_buffer);
38 /// The former is preferred; the latter is deprecated
40 /// 2. static Status Deserialize(ByteBuffer* buffer,
43 /// static Status Deserialize(grpc_byte_buffer* buffer,
45 /// The former is preferred; the latter is deprecated
47 /// Serialize is required to convert message to a ByteBuffer, and
48 /// return that byte buffer through *buffer. *own_buffer should
49 /// be set to true if the caller owns said byte buffer, or false if
50 /// ownership is retained elsewhere.
52 /// Deserialize is required to convert buffer into the message stored at
53 /// msg. max_receive_message_size is passed in as a bound on the maximum
54 /// number of message bytes Deserialize should accept.
56 /// Both functions return a Status, allowing them to explain what went
57 /// wrong if required.
58 template <class Message,
59 class UnusedButHereForPartialTemplateSpecialization = void>
60 class SerializationTraits;
64 #endif // GRPCPP_IMPL_CODEGEN_SERIALIZATION_TRAITS_H