Metadata that is the same about every message (independent of data type). More...

#include <DirectHub.hxx>

Inheritance diagram for MessageMetadata:

Public Member Functions
void	clear ()
	Clears the message metadata, including notifying the barrier, if set.

void	set_done (BarrierNotifiable *done)
	Sets the done notifiable to a barrier.

Public Attributes
BarrierNotifiable *	done_ = nullptr
	This must be notified when the processing of the message is complete.

HubSource *	source_ = nullptr
	Represents the input port where the message came in.

HubSource *	dst_ = nullptr
	Represents the output port where the message will leave.

bool	isFlush_ = false
	If true, this message should flush the output buffer.

Detailed Description

Metadata that is the same about every message (independent of data type).

Definition at line 51 of file DirectHub.hxx.

Member Function Documentation

◆ clear()

void MessageMetadata::clear ( )

inline

Clears the message metadata, including notifying the barrier, if set.

Definition at line 54 of file DirectHub.hxx.

◆ set_done()

void MessageMetadata::set_done ( BarrierNotifiable * done )

inline

Sets the done notifiable to a barrier.

Parameters

ref	a new reference to a barrier notifiable. Will be notified once.

Definition at line 68 of file DirectHub.hxx.

Member Data Documentation

◆ done_

BarrierNotifiable* MessageMetadata::done_ = nullptr

This must be notified when the processing of the message is complete.

All forks coming from the message must take children.

Definition at line 80 of file DirectHub.hxx.

◆ dst_

HubSource* MessageMetadata::dst_ = nullptr

Represents the output port where the message will leave.

nullptr means broadcast.

Definition at line 85 of file DirectHub.hxx.

◆ isFlush_

bool MessageMetadata::isFlush_ = false

If true, this message should flush the output buffer.

Definition at line 87 of file DirectHub.hxx.

◆ source_

HubSource* MessageMetadata::source_ = nullptr

Represents the input port where the message came in.

Definition at line 82 of file DirectHub.hxx.

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

DirectHub.hxx

Public Member Functions

Public Attributes