/*
 * Copyright 2014 Parity authors
 *
 * 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 com.paritytrading.parity.net;

import java.nio.BufferOverflowException;
import java.nio.BufferUnderflowException;
import java.nio.ByteBuffer;
import java.nio.ReadOnlyBufferException;

/**
 * A protocol message.
 */
public interface ProtocolMessage {

    /**
     * Read this message from a buffer.
     *
     * @param buffer a buffer
     * @throws BufferUnderflowException if there are fewer bytes remaining
     *   in the buffer than what this message consists of
     */
    void get(ByteBuffer buffer);

    /**
     * Write this message to a buffer.
     *
     * @param buffer a buffer
     * @throws BufferOverflowException if there are fewer bytes remaining
     *   in the buffer than what this message consists of
     * @throws ReadOnlyBufferException if the buffer is read-only
     */
    void put(ByteBuffer buffer);

}
