dorkbox.util.serialization.SerializationManager Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 dorkbox, llc.
 *
 *  Licensed 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.
 */
package dorkbox.util.serialization;

import java.io.IOException;

import org.slf4j.Logger;

import com.esotericsoftware.kryo.Kryo;
import com.esotericsoftware.kryo.Serializer;
import com.esotericsoftware.kryo.io.Input;
import com.esotericsoftware.kryo.io.Output;

import io.netty.buffer.ByteBuf;

public
interface SerializationManager {

    /**
     * Registers the class using the lowest, next available integer ID and the {@link Kryo#getDefaultSerializer(Class) default serializer}.
     * If the class is already registered, the existing entry is updated with the new serializer.
     * 
     * Registering a primitive also affects the corresponding primitive wrapper.
     * 

     * Because the ID assigned is affected by the IDs registered before it, the order classes are registered is important when using this
     * method. The order must be the same at deserialization as it was for serialization.
     */
    SerializationManager register(Class clazz);

    /**
     * Registers the class using the specified ID. If the ID is already in use by the same type, the old entry is overwritten. If the ID
     * is already in use by a different type, a {@link KryoException} is thrown.
     * 

     * Registering a primitive also affects the corresponding primitive wrapper.
     * 

     * IDs must be the same at deserialization as they were for serialization.
     *
     * @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs 0-8 are used by default for primitive types and String, but
     *         these IDs can be repurposed.
     */
    SerializationManager register(Class clazz, int id);

    /**
     * Registers the class using the lowest, next available integer ID and the specified serializer. If the class is already registered,
     * the existing entry is updated with the new serializer.
     * 

     * Registering a primitive also affects the corresponding primitive wrapper.
     * 

     * Because the ID assigned is affected by the IDs registered before it, the order classes are registered is important when using this
     * method. The order must be the same at deserialization as it was for serialization.
     */
    SerializationManager register(Class clazz, Serializer serializer);

    /**
     * Registers the class using the specified ID and serializer. If the ID is already in use by the same type, the old entry is
     * overwritten. If the ID is already in use by a different type, a {@link KryoException} is thrown.
     * 

     * Registering a primitive also affects the corresponding primitive wrapper.
     * 

     * IDs must be the same at deserialization as they were for serialization.
     *
     * @param id Must be >= 0. Smaller IDs are serialized more efficiently. IDs 0-8 are used by default for primitive types and String, but
     *         these IDs can be repurposed.
     */
    SerializationManager register(Class clazz, Serializer serializer, int id);

    /**
     * Waits until a kryo is available to write, using CAS operations to prevent having to synchronize.
     * 

     * No crypto and no sequence number
     * 

     * There is a small speed penalty if there were no kryo's available to use.
     */
    void write(ByteBuf buffer, Object message) throws IOException;

    /**
     * Reads an object from the buffer.
     * 
     * No crypto and no sequence number
     *
     * @param length should ALWAYS be the length of the expected object!
     */
    Object read(ByteBuf buffer, int length) throws IOException;

    /**
     * Writes the class and object using an available kryo instance
     */
    void writeFullClassAndObject(Output output, Object value) throws IOException;

    /**
     * Returns a class read from the input
     */
    Object readFullClassAndObject(final Input input) throws IOException;

    /**
     * Called when initialization is complete. This is to prevent (and recognize) out-of-order class/serializer registration.
     *
     * The loggers are for trace debug output for the wire data
     */
    void finishInit(final Logger wireReadLogger, final Logger wireWriteLogger);

    /**
     * @return true if our initialization is complete. Some registrations (in the property store, for example) always register for client
     *              and server, even if in the same JVM. This only attempts to register once.
     */
    boolean initialized();
}