pcap.codec.Packet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pcap-codec Show documentation

Packet Codec

There is a newer version: 1.5.1

/** This code is licenced under the GPL version 2. */
package pcap.codec;

import java.io.Serializable;
import java.util.List;
import pcap.common.annotation.Inclubating;
import pcap.common.util.NamedNumber;

/** @author Ardika Rommy Sanjaya */
@Inclubating
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 header();

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

  /**
   * 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);

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

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

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

    /**
     * Returns the payload type.
     *
     * @param  type.
     * @return returns payload type.
     */
    @SuppressWarnings("TypeParameterUnusedInFormals")
     T payloadType();

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