frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.SinkQueue Class Reference

A Queue that discards all messages sent. More...

Inheritance diagram for frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.SinkQueue:

Public Member Functions
void	sendMessage (Object to, Message msg)
Public Member Functions inherited from frodo2.communication.Queue
	Queue (boolean measureMsgs)
	Constructor.
	Queue (boolean measureMsgs, boolean init)
	Constructor.
void	toBeClosedUponKill (QueueInputPipeInterface input)
	Reminds the queue to close the given pipe when it is killed.
void	removeInputPipe (QueueInputPipeInterface input)
	Removes the given input pipe from the list of input pipes.
void	addOutputPipe (Object recipient, QueueOutputPipeInterface output)
	Adds an output pipe to this queue.
QueueOutputPipeInterface	getOutputPipe (Object recipient)
	Returns the output pipe corresponding to the given recipient.
void	removeOutputPipe (Object recipient)
	Removes the output pipe corresponding to the given recipient.
QueueIOPipe	addOutputQueue (Object recipient, Queue queue)
	Adds a new output pipe to the provided queue.
void	addIncomingMessagePolicy (IncomingMsgPolicyInterface< MessageType > policy)
	Adds a listener to be notified of new incoming messages.
void	addIncomingMessagePolicy (Collection< MessageType > msgTypes, IncomingMsgPolicyInterface< MessageType > policy)
	Adds a listener to be notified of new incoming messages.
void	addIncomingMessagePolicy (MessageType type, IncomingMsgPolicyInterface< MessageType > policy)
	Adds a listener to be notified of new incoming messages of type type.
void	addOutgoingMessagePolicy (OutgoingMsgPolicyInterface< MessageType > policy)
	Adds a listener to be notified of new outgoing messages.
void	addOutgoingMessagePolicy (Collection< MessageType > msgTypes, OutgoingMsgPolicyInterface< MessageType > policy)
	Adds a listener to be notified of new outgoing messages.
void	addOutgoingMessagePolicy (MessageType type, OutgoingMsgPolicyInterface< MessageType > policy)
	Adds a listener to be notified of new outgoing messages of type type.
void	addToInbox (MessageWrapper msg)
	Adds the input message to this queue's inbox.
void	sendMessage (Object to, MessageWrapper msgWrap)
	Send a message that has already been wrapped.
void	sendMessageToSelf (Message msg)
	Sends a message to itself.
void	end ()
	Kills the queue, making it unusable.
void	run ()
	Continuously processes all messages in the inbox.
void	deleteIncomingMessagePolicy (IncomingMsgPolicyInterface< MessageType > policy)
	Completely removes the input policy from all lists of listeners.
void	deleteStatsReporters ()
	Delete all StatsReporters.
void	deleteOutgoingMessagePolicy (OutgoingMsgPolicyInterface< MessageType > policy)
	Completely removes the outgoing message policy from all lists of listeners.
void	cleanQueue ()
	Removes all messages from the inbox.
void	setProblem (ProblemInterface<?, ?> problem)
	Sets the problem that is queried for NCCCs.
void	updateNCCCs (long msgNCCCs)
	Updates the queue's NCCC counter to the input count if the input is greater.
long	getCurrentTime ()
int	getInboxSize ()
MessageWrapper	getCurrentMessageWrapper ()
HashMap< MessageType, Integer >	getMsgNbrs ()
HashMap< Object, Integer >	getMsgNbrsSent ()
HashMap< MessageType, Long >	getMsgSizes ()
HashMap< Object, Long >	getMsgSizesSent ()
HashMap< MessageType, Long >	getMaxMsgSizes ()
void	resetStats ()
	Resets the metrics statistics.
void	resetMsgSizeMonitor ()
	Closes the MsgSizeMonitor and creates a new one.

Additional Inherited Members
Static Public Member Functions inherited from frodo2.communication.Queue
static String	networkToDOT (Queue[] queues)
	Generates a String representation in DOT format of a network of queues.
Protected Member Functions inherited from frodo2.communication.Queue
	Queue ()
	Empty constructor that does absolutely nothing.
void	notifyInListeners (Message msg, Object toAgent)
	Notifies the incoming message listeners of a message.
boolean	notifyOutListeners (Object fromAgent, Message msg, Collection<? extends Object > toAgents)
	Notifies the outgoing message listeners of a message.
void	recordStats (Object to, Message msg)
	Records statistics about the input message.
Protected Attributes inherited from frodo2.communication.Queue
Set< QueueInputPipeInterface >	inputs
	List of input pipes.
HashMap< Object, QueueOutputPipeInterface >	outputs
	Map associating an output pipe to each destination ID.
MsgSizeMonitor	monitor
	A monitor used to measure the sizes of the messages.
HashMap< MessageType, ArrayList< IncomingMsgPolicyInterface< MessageType > > >	inPolicies
	A list of listeners notified of incoming objects.
HashMap< MessageType, ArrayList< OutgoingMsgPolicyInterface< MessageType > > >	outPolicies
	A list of listeners notified of outgoing messages.
ProblemInterface<?, ?>	problem
	The problem used to obtain the current NCCC count.
final boolean	measureMsgs
	Whether to measure the number of messages and the total amount of information sent.
HashMap< MessageType, Integer >	msgNbrs
	For each message type, the number of messages sent of that type.
HashMap< MessageType, Long >	msgSizes
	For each message type, the total amount of information sent in messages of that type, in bytes.
HashMap< MessageType, Long >	maxMsgSizes
	For each message type, the size (in bytes) of the largest message of that type.
MessageWrapper	msgWrap
	The last wrapped message to have been received.
Package Functions inherited from frodo2.communication.Queue
public< T extends Object > void	sendMessageToMulti (Collection< T > recipients, Message msg)
	Sends a message to all specified recipients.

Detailed Description

A Queue that discards all messages sent.

Member Function Documentation

sendMessage()

void frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.SinkQueue.sendMessage	(	Object	to,
		Message	msg )

See also

Queue.sendMessage(java.lang.Object, Message)

Reimplemented from frodo2.communication.Queue.

---

The documentation for this class was generated from the following file:

• src/frodo2/algorithms/varOrdering/dfs/DFSgenerationParallel.java