InstantIO::BasicInSlot::Listener Class Reference

Allows to receive information about the status of an InSlot. More...

#include <BasicInSlot.h>

Inheritance diagram for InstantIO::BasicInSlot::Listener:

List of all members.

Public Member Functions
virtual	~Listener ()
	Destructor.
virtual void	startInSlot (BasicInSlot &inSlot)
	Gets called when an InSlot gets connected to the first OutSlot.
virtual void	stopInSlot (BasicInSlot &inSlot)
	Gets called when an InSlot gets disconnected from the last OutSlot.
virtual void	newData (BasicInSlot &inSlot)
	Gets called when there is new data available on an InSlot.

---

Detailed Description

Allows to receive information about the status of an InSlot.

You can implement this interface by your own classes and add instances of these classes to InSlots by using the addListener method. In this case, the InSlot calls methods of this interface when special events occur. These events are:

1. The first OutSlot connects to the InSlot.
2. The last OutSlot disconnects from the InSlot.
3. New data is available for receival on the InSlot.

Please keep in mind that you should not block under any circumstance in the methods, and you should not perform time-consuming tasks. These methods are just meant to do short notifications about the events.

Author:

Patrick Dähne

---

Constructor & Destructor Documentation

virtual InstantIO::BasicInSlot::Listener::~Listener

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void InstantIO::BasicInSlot::Listener::startInSlot

(

BasicInSlot &

inSlot

)

[virtual]

Gets called when an InSlot gets connected to the first OutSlot.

You can use this callback to get a notification when you should start reading values from an InSlot.

Parameters:

inSlot

The InSlot that generated the event.

Reimplemented in InstantIO::Node.

virtual void InstantIO::BasicInSlot::Listener::stopInSlot

(

BasicInSlot &

inSlot

)

[virtual]

Gets called when an InSlot gets disconnected from the last OutSlot.

You can use this callback to get a notification when you can stop reading values from an InSlot.

Parameters:

inSlot

The InSlot that generated the event.

Reimplemented in InstantIO::Node.

virtual void InstantIO::BasicInSlot::Listener::newData

(

BasicInSlot &

inSlot

)

[virtual]

Gets called when there is new data available on an InSlot.

You can use this callback to get a notification when you can read a data value from an InSlot using the top or pop methods.

Parameters:

inSlot

The InSlot that generated the event.

---

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

• BasicInSlot.h