openDAQ
Open data acquisition platform
InputPortNotificationsPtr Class Reference

Notifications object passed to the input port on construction by its owner (listener). More...

Inherits ObjectPtr< IInputPortNotifications >.

Detailed Description

Notifications object passed to the input port on construction by its owner (listener).

Input ports invoke the notification functions within the Input port notifications object when corresponding events occur. The listener can then react on those events.

Public Member Functions

daq::Bool acceptsSignal (const daq::InputPortPtr &port, const daq::SignalPtr &signal) const
 Called when the Input port method acceptsSignal is called. Should return true if the signal is accepted; false otherwise. More...
 
void connected (const daq::InputPortPtr &port) const
 Called when a signal is connected to the input port. More...
 
void disconnected (const daq::InputPortPtr &port) const
 Called when a signal is disconnected from the input port. More...
 
void packetReceived (const daq::InputPortPtr &port) const
 Notifies the listener of the newly received packet on the specified input-port. More...
 

Member Function Documentation

◆ acceptsSignal()

daq::Bool acceptsSignal ( const daq::InputPortPtr &  port,
const daq::SignalPtr &  signal 
) const
inline

Called when the Input port method acceptsSignal is called. Should return true if the signal is accepted; false otherwise.

Parameters
portThe input port on which the method was called.
signalThe signal which is being checked for acceptance.
Returns
True if the signal is accepted; false otherwise.

◆ connected()

void connected ( const daq::InputPortPtr &  port) const
inline

Called when a signal is connected to the input port.

Parameters
portThe port to which the signal was connected.

◆ disconnected()

void disconnected ( const daq::InputPortPtr &  port) const
inline

Called when a signal is disconnected from the input port.

Parameters
portThe port from which a signal was disconnected.

◆ packetReceived()

void packetReceived ( const daq::InputPortPtr &  port) const
inline

Notifies the listener of the newly received packet on the specified input-port.

Parameters
portThe port on which the new packet was received.