frodo2.communication.QueueOutputPipeInterface Interface Reference

Interface for classes used as an output of a Queue object. More...

Inheritance diagram for frodo2.communication.QueueOutputPipeInterface:

Public Member Functions
void	pushMessage (MessageWrapper msg)
	Pushes a message into the pipe.
void	close ()
	Closes the pipe (if relevant).
String	toDOT ()

Detailed Description

Interface for classes used as an output of a Queue object.

Author

Thomas Leaute

This interface has a pushMessage() method that a Queue can call to relay messages.

Member Function Documentation

close()

void frodo2.communication.QueueOutputPipeInterface.close

(

)

Closes the pipe (if relevant).

Implemented in frodo2.communication.QueueTest.QueueOutputPipeTrivial, frodo2.communication.sharedMemory.QueueIOPipe, and frodo2.communication.tcp.QueueOutputPipeTCP.

pushMessage()

void frodo2.communication.QueueOutputPipeInterface.pushMessage

(

MessageWrapper

msg

)

Pushes a message into the pipe.

Parameters

msg	the message to be pushed into the pipe

Warning

If your implementation of this method needs to read from the message's raw data stream, it MUST spawn a new thread and do it from within the thread. If this method attempts to read directly from the thread, this could cause a race condition.

Implemented in frodo2.communication.QueueTest.QueueOutputPipeTrivial, frodo2.communication.sharedMemory.QueueIOPipe, and frodo2.communication.tcp.QueueOutputPipeTCP.

Referenced by frodo2.communication.Queue.sendMessage().

toDOT()

String frodo2.communication.QueueOutputPipeInterface.toDOT

(

)

Returns

a unique ID for the pipe used by Queue.networkToDOT

Implemented in frodo2.communication.QueueTest.QueueOutputPipeTrivial, frodo2.communication.sharedMemory.QueueIOPipe, and frodo2.communication.tcp.QueueOutputPipeTCP.

---

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

• src/frodo2/communication/QueueOutputPipeInterface.java