com.ardikars.jxpacket.common.Packet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jxpacket-common Show documentation
Jxpacket is a network packet crafting library for java.
There is a newer version: 1.2.6.RELEASE
/**
 * Copyright (C) 2017-2018  Ardika Rommy Sanjaya 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package com.ardikars.jxpacket.common;

import com.ardikars.common.util.NamedNumber;
import io.netty.buffer.ByteBuf;

import java.io.Serializable;
import java.util.List;

/**
 * This interface representing a packet which consists of a packet header and a payload.
 * @author Ardika Rommy Sanjaya
 * @since 1.5.0
 */
public interface Packet extends Iterable, Serializable {

    /**
     * Returns the {@link Header} object representing this packet's header.
     * @return returns null if header doesn't exist, {@link Header} object otherwise.
     */
    Header getHeader();

    /**
     * Returns the {@link Packet} object representing this packet's payload.
     * @return returns null if a payload doesn't exits, {@link Packet} object otherwise.
     */
    Packet getPayload();

    /**
     * Ensures that given packet type is included on this {@link Packet} object.
     * @param clazz packet type.
     * @param  type.
     * @return returns true if this packet is or its payload includes an object of
     * specified packet class; false otherwise.
     */
     boolean contains(Class clazz);

    /**
     * Returns list of specify packet's.
     * @param clazz packet type.
     * @param  type.
     * @return returns list of {@link Packet} object.
     */
     List get(Class clazz);

    /**
     * The interface for packet builder.
     */
    interface Builder extends com.ardikars.common.util.Builder {

        default void release(ByteBuf buffer) {
            int refCnt = buffer.refCnt();
            while (refCnt > 0) {
                try {
                    buffer.release();
                } catch (Throwable throwable) {
                    // do nothing
                }
                refCnt--;
            }
        }

    }

    /**
     * The interface for packet factory.
     */
    interface Factory extends com.ardikars.common.util.Factory {

    }

    /**
     * This interface representing a packet header.
     */
    interface Header extends Serializable {

        /**
         * Returns the payload type.
         * @param  type.
         * @return returns payload type.
         */
         T getPayloadType();

        /**
         * Returns header length.
         * @return returns header length.
         */
        int getLength();

        /**
         * Returns header as byte buffer.
         * @return return byte buffer.
         */
        ByteBuf getBuffer();

    }

}