Input port

Represents how the input port should handle the packet-enqueued notification. More...

Collaboration diagram for Input port:

Detailed Description

Represents how the input port should handle the packet-enqueued notification.

Modules
	Factories

Functions
void	setNotificationMethod (daq::PacketReadyNotification method) const
	Sets the input-ports response to the packet enqueued notification.
daq::PacketReadyNotification	getNotificationMethod () const
	Gets the input-ports response to the packet enqueued notification.
void	notifyPacketEnqueued (daq::Bool queueWasEmpty) const
	Gets called when a packet was enqueued in a connection. More...
void	notifyPacketEnqueuedOnThisThread () const
	Gets called when a packet was enqueued in a connection. More...
void	setListener (const daq::InputPortNotificationsPtr &port) const
	Set the object receiving input-port related events and notifications.
daq::BaseObjectPtr	getCustomData () const
	Get a custom data attached to the object.
void	setCustomData (const daq::BaseObjectPtr &customData) const
	Set a custom data attached to the object.
void	setRequiresSignal (daq::Bool requiresSignal) const
	Sets requires signal flag of the input port. More...
daq::Bool	getGapCheckingEnabled () const
	Returns the state of gap checking requested by the input port. More...
void	notifyPacketEnqueuedWithScheduler () const
	Gets called when a packet was enqueued in a connection. More...

Function Documentation

getGapCheckingEnabled()

daq::Bool getGapCheckingEnabled ( ) const

inline

Returns the state of gap checking requested by the input port.

Returns

true if gap checking is requested by the input port.

notifyPacketEnqueued()

void notifyPacketEnqueued ( daq::Bool  queueWasEmpty ) const

inline

Gets called when a packet was enqueued in a connection.

Parameters

queueWasEmpty

True if queue was empty before packet was enqueued.

notifyPacketEnqueuedOnThisThread()

void notifyPacketEnqueuedOnThisThread ( ) const

inline

Gets called when a packet was enqueued in a connection.

The notification is called on the same thread that enqueued the packet.

notifyPacketEnqueuedWithScheduler()

void notifyPacketEnqueuedWithScheduler ( ) const

inline

Gets called when a packet was enqueued in a connection.

The notification is scheduled.

setRequiresSignal()

void setRequiresSignal ( daq::Bool  requiresSignal ) const

inline

Sets requires signal flag of the input port.

Parameters

requiresSignal

True if the input port requires a signal to be connected; false otherwise.

If an input port requires a signal, then the input port must have a signal connected otherwise the owner of the input port (function block) should report an error.