InstantIO::BasicOutSlot::Listener Class Reference

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

#include <BasicOutSlot.h>

Inheritance diagram for InstantIO::BasicOutSlot::Listener:
InstantIO::Node InstantIO::ThreadedNode

List of all members.

Public Member Functions

virtual ~Listener ()
 Destructor.
virtual void startOutSlot (BasicOutSlot &outSlot)
 Gets called when an OutSlot gets connected to the first InSlot.
virtual void stopOutSlot (BasicOutSlot &outSlot)
 Gets called when an OutSlot gets disconnected from the last InSlot.

Detailed Description

Allows to receive information about the status of an OutSlot.

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

  1. The first InSlot connects to the OutSlot.
  2. The last InSlot disconnects from the OutSlot.

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::BasicOutSlot::Listener::~Listener (  )  [virtual]

Destructor.


Member Function Documentation

virtual void InstantIO::BasicOutSlot::Listener::startOutSlot ( BasicOutSlot outSlot  )  [virtual]

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

You can use this callback to get a notification when you should start writing values to an OutSlot.

Parameters:
outSlot The OutSlot that generated the event.

Reimplemented in InstantIO::Node.

virtual void InstantIO::BasicOutSlot::Listener::stopOutSlot ( BasicOutSlot outSlot  )  [virtual]

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

You can use this callback to get a notification when you can stop writing values to an OutSlot.

Parameters:
outSlot The OutSlot that generated the event.

Reimplemented in InstantIO::Node.


The documentation for this class was generated from the following file:
Generated on Thu Jul 31 17:17:32 2014 by  doxygen 1.6.3