modules/network-api/src/main/java/org/apache/ignite/network/serialization/MessageDeserializer.java

/*
 * 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.
 */

package org.apache.ignite.network.serialization;

import org.apache.ignite.network.NetworkMessage;

/**
 * Message deserializer.
 *
 * @param <M> Message type.
 */
public interface MessageDeserializer<M extends NetworkMessage> {
    /**
     * Read a message from the reader.
     *
     * @param reader Message reader.
     * @return {@code true } if the message has been read completely.
     * @throws MessageMappingException If failed.
     */
    boolean readMessage(MessageReader reader) throws MessageMappingException;

    /**
     * Message type, that this deserializer creates.
     *
     * @return Message type.
     */
    Class<M> klass();

    /**
     * Returns the message, deserialized by the {@link #readMessage} method.
     *
     * @return Deserialized message.
     */
    M getMessage();
}