usr.router

Class FabricDevice

java.lang.Object

usr.router.FabricDevice

All Implemented Interfaces:

FabricDeviceInterface

public class FabricDevice
extends java.lang.Object
implements FabricDeviceInterface

A fabric device is a device with an Inbound and an outbound queue. Inboud is "towards fabric" and Outbound is "from fabric" -- see diagram Different queueing disciplines can be chosen for incoming and outgoing queues

Constructor Summary

Constructors

Constructor and Description
FabricDevice(DatagramDevice ep, NetIFListener l) Default fabric device has no queue

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addToInQueue(Datagram dg, DatagramDevice dd) Returns true if datagram is sent or false if dropped
boolean	addToInQueue(Datagram dg, DatagramDevice dd, usr.router.Waker waitObj) Add a datagram to the in queue -- true means sent to out queue, false means blocked
boolean	addToOutQueue(usr.router.DatagramHandle dh) Add a datagram to the out queue -- return true if datagram added to out queue, false means rejected
boolean	addToOutQueue(usr.router.DatagramHandle dh, usr.router.Waker waitObj) Add a datagram to the out queue -- true means added to out queue, false means rejected
boolean	blockingAddToInQueue(Datagram dg, DatagramDevice dd) Add a datagram to the in queue -- blocking call, will continue to wait until datagram is added
boolean	blockingAddToOutQueue(usr.router.DatagramHandle dh) Add a datagram to the out queue -- blocking call, will continue to wait until datagram is added
NetIFListener	getListener() Get the listener device
NetStats	getNetStats()
protected void	inQueueHasCapacity() A callback from the InQueueHandler to say that the queue has some space.
protected void	outQueueHasCapacity() A callback from the OutQueueHandler to say that the queue has some space.
boolean	sendOutDatagram(usr.router.DatagramHandle dh) Send the outbound Datagram onwards
void	setInQueueDiscipline(int discipline) Set the queue type for the inbound queue
void	setInQueueLength(int len) Set the queue length for the inbound queue
void	setListener(NetIFListener l) Set the listener device for this fabric device
void	setOutQueueDiscipline(int discipline) Set the queue type for the outbound queue
void	setOutQueueLength(int len) Set the queue length for the outbound queue
void	start() Start the device
void	stop() Stop any running threads
boolean	transferDatagram(usr.router.DatagramHandle dh) transfer datagram from in queue to out queue using no queue discipline add right now or drop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FabricDevice

public FabricDevice(DatagramDevice ep,
            NetIFListener l)

Default fabric device has no queue

Method Detail

setInQueueDiscipline

public void setInQueueDiscipline(int discipline)

Set the queue type for the inbound queue

setOutQueueDiscipline

public void setOutQueueDiscipline(int discipline)

Set the queue type for the outbound queue

setInQueueLength

public void setInQueueLength(int len)

Set the queue length for the inbound queue

setOutQueueLength

public void setOutQueueLength(int len)

Set the queue length for the outbound queue

start

public void start()

Description copied from interface: FabricDeviceInterface

Start the device

Specified by:

start in interface FabricDeviceInterface

blockingAddToInQueue

public boolean blockingAddToInQueue(Datagram dg,
                           DatagramDevice dd)
                             throws java.net.NoRouteToHostException

Add a datagram to the in queue -- blocking call, will continue to wait until datagram is added

Specified by:

blockingAddToInQueue in interface FabricDeviceInterface

Throws:

java.net.NoRouteToHostException

addToInQueue

public boolean addToInQueue(Datagram dg,
                   DatagramDevice dd)
                     throws java.net.NoRouteToHostException

Returns true if datagram is sent or false if dropped

Specified by:

addToInQueue in interface FabricDeviceInterface

Throws:

java.net.NoRouteToHostException

addToInQueue

public boolean addToInQueue(Datagram dg,
                   DatagramDevice dd,
                   usr.router.Waker waitObj)
                     throws java.net.NoRouteToHostException,
                            InterfaceBlockedException

Add a datagram to the in queue -- true means sent to out queue, false means blocked

Throws:

java.net.NoRouteToHostException

InterfaceBlockedException

inQueueHasCapacity

protected void inQueueHasCapacity()

A callback from the InQueueHandler to say that the queue has some space.

getNetStats

public NetStats getNetStats()

setListener

public void setListener(NetIFListener l)

Set the listener device for this fabric device

getListener

public NetIFListener getListener()

Get the listener device

blockingAddToOutQueue

public boolean blockingAddToOutQueue(usr.router.DatagramHandle dh)
                              throws java.net.NoRouteToHostException

Add a datagram to the out queue -- blocking call, will continue to wait until datagram is added

Throws:

java.net.NoRouteToHostException

addToOutQueue

public boolean addToOutQueue(usr.router.DatagramHandle dh)
                      throws java.net.NoRouteToHostException,
                             InterfaceBlockedException

Add a datagram to the out queue -- return true if datagram added to out queue, false means rejected

Throws:

java.net.NoRouteToHostException

InterfaceBlockedException

addToOutQueue

public boolean addToOutQueue(usr.router.DatagramHandle dh,
                    usr.router.Waker waitObj)
                      throws java.net.NoRouteToHostException,
                             InterfaceBlockedException

Add a datagram to the out queue -- true means added to out queue, false means rejected

Throws:

java.net.NoRouteToHostException

InterfaceBlockedException

outQueueHasCapacity

protected void outQueueHasCapacity()

A callback from the OutQueueHandler to say that the queue has some space.

transferDatagram

public boolean transferDatagram(usr.router.DatagramHandle dh)
                         throws java.net.NoRouteToHostException

transfer datagram from in queue to out queue using no queue discipline add right now or drop

Throws:

java.net.NoRouteToHostException

sendOutDatagram

public boolean sendOutDatagram(usr.router.DatagramHandle dh)
                        throws InterfaceBlockedException

Send the outbound Datagram onwards

Throws:

InterfaceBlockedException

stop

public void stop()

Stop any running threads

Specified by:

stop in interface FabricDeviceInterface