netdeviceapi.java

来自「纯java操作系统jnode,安装简单和操作简单的个人使用的Java操作系统」· Java 代码 · 共 70 行

/*
 * $Id: NetDeviceAPI.java,v 1.2 2003/12/21 08:04:07 epr Exp $
 */
package org.jnode.driver.net;

import org.jnode.driver.DeviceAPI;
import org.jnode.net.HardwareAddress;
import org.jnode.net.ProtocolAddressInfo;
import org.jnode.net.SocketBuffer;

/**
 * Generic API for network devices.
 * 
 * <h3>Transmission</h3>
 * To transmit data, each network device should has a queue of Frame's. 
 * The transmit method is called to add a frame to this queue. The device
 * should start a worker thread to process this queue.
 * Once a frame has been transmitted, the notifyTransmission method of that
 * frame must be called.
 * 
 * <h3>Reception</h3>
 * On reception of a frame, a network device must call the receive
 * method of the NetworkLayerManager.
 * 
 * @see org.jnode.net.NetworkLayerManager
 * 
 * @author epr
 */
public interface NetDeviceAPI extends DeviceAPI {

	/**
	 * Gets the hardware address of this device
	 */
	public HardwareAddress getAddress();

	/**
	 * Gets the maximum transfer unit, the number of bytes this device can
	 * transmit at a time.
	 */
	public int getMTU();

	/**
	 * Add the given frame to the transmit queue of this device.
	 * A client to this interface should use methods in Frame to checks for
	 * errors and wait for the actual transmission.
	 * After the frame has actually been transmitted by the device, the 
	 * Frame.notifyTransmission method must be called.
	 * 
	 * @param packet The network packet to transmit. No linklayer header has
	 * been added yet.
	 * @param destination The destination address, or null for a broadcast. 
	 * @throws NetworkException
	 */
	public void transmit(SocketBuffer packet, HardwareAddress destination)
	throws NetworkException;

	/**
	 * Gets the protocol address information for a given protocol.
	 * @param protocolID
	 * @return The protocol address information, or null if not found.
	 */
	public ProtocolAddressInfo getProtocolAddressInfo(int protocolID);

	/**
	 * Sets the protocol address information for a given protocol.
	 * @param protocolID
	 */
	public void setProtocolAddressInfo(int protocolID, ProtocolAddressInfo addressInfo);
}