Files
scylladb/io/i_versioned_serializer.hh
2015-01-05 14:13:31 +08:00

67 lines
2.0 KiB
C++

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Modified by Cloudius Systems
*
* Copyright 2015 Cloudius Systems
*/
#pragma once
#include <cstdint>
namespace io {
// FIXME
class DataOutputPlus;
class DataInput;
template<typename T>
class i_versioned_serializer {
public:
/**
* Serialize the specified type into the specified DataOutputStream instance.
*
* @param t type that needs to be serialized
* @param out DataOutput into which serialization needs to happen.
* @param version protocol version
* @throws java.io.IOException if serialization fails
*/
virtual void serialize(T& t, DataOutputPlus out, int32_t version) = 0;
/**
* Deserialize into the specified DataInputStream instance.
* @param in DataInput from which deserialization needs to happen.
* @param version protocol version
* @return the type that was deserialized
* @throws IOException if deserialization fails
*/
virtual T& deserialize(DataInput in, int32_t version) = 0;
/**
* Calculate serialized size of object without actually serializing.
* @param t object to calculate serialized size
* @param version protocol version
* @return serialized size of object t
*/
virtual uint64_t serialized_size(T& t, int32_t version) = 0;
};
}