org.cloudbus.cloudsim.network.NetworkPacket Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudsim-plus Show documentation

CloudSim Plus: A modern, highly extensible and easier-to-use Java 8+ Framework for Modeling and Simulation of Cloud Computing Infrastructures and Services

There is a newer version: 8.0.0

Show newest version

/*
 * Gokul Poduval & Chen-Khong Tham
 * Computer Communication Networks (CCN) Lab
 * Dept of Electrical & Computer Engineering
 * National University of Singapore
 * August 2004
 *
 * Licence: GPL - http://www.gnu.org/copyleft/gpl.html
 * Copyright (c) 2004, The University of Melbourne, Australia and National
 * University of Singapore
 * Packet.java - Interface of a Network Packet.
 *
 */

package org.cloudbus.cloudsim.network;

import org.cloudbus.cloudsim.core.Identifiable;
import org.cloudbus.cloudsim.hosts.Host;
import org.cloudbus.cloudsim.network.switches.Switch;
import org.cloudbus.cloudsim.vms.Vm;

/**
 * Defines the structure for a network packet.
 *
 * @author Gokul Poduval
 * @author Chen-Khong Tham, National University of Singapore
 * @author Manoel Campos da Silva Filho
 * @param  the class of objects involved in the packet transmission.
 *           if they are {@link Host}s, {@link Vm}s, {@link Switch}es, etc.
 *
 * @since CloudSim Toolkit 1.0
 */
public interface NetworkPacket {
    /**
     * Gets the size of the packet in bytes.
     *
     * @return size of the packet in bytes.
     */
    long getSize();

    /**
     * Gets the entity that this packet is coming from (the sender).
     *
     * @return
     */
    T getSource();

    /**
     * Sets the entity that this packet is coming from (the sender).
     * @param source the source ID to set
     */
    void setSource(T source);

    /**
     * Gets the entity that the packet is going to.
     *
     * @return
     */
    T getDestination();

    /**
     * Sets the entity that the packet is going to (the receiver).
     *
     * @param destination the destination to set
     */
    void setDestination(T destination);

    /**
     * Gets the time (in seconds) when the packet was sent.
     * @return
     */
    double getSendTime();

    /**
     * Sets the time when the packet was sent.
     * @param time the time to set (in seconds)
     */
    void setSendTime(double time);

    /**
     * Gets the time (in seconds) when the packet was received.
     * @return
     */
    double getReceiveTime();

    /**
     * Sets the time when the packet was received.
     * @param time the time to set (in seconds)
     */
    void setReceiveTime(double time);
}