Skip to content

TReader<TKey>

Reading endpoint of a blackboard based communication.

Definition

Unit: Neslib.Iceoryx2.Blackboard

type TReader<TKey> = record ... end;

Type Parameters

TKey:

Properties

Name Description
Handle
Id Returns the TUniqueReaderId of the TReader.
Name Returns the TPortNameView of the TReader

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
Entry<TValue> Creates a TEntryHandle for direct read access to the value.

Property Descriptions

Handle

property Handle: THandle read GetHandle

Type: THandle


Id

Returns the TUniqueReaderId of the TReader.

property Id: TUniqueReaderId read GetId

Type: TUniqueReaderId


Name

Returns the TPortNameView of the TReader

property Name: TPortNameView read GetName

Type: TPortNameView


Constructor Descriptions

Assign

constructor Assign(var ADest: TReader<TKey>; const ASrc: TReader<TKey>)

Parameters

ADest: TReader<TKey>

ASrc: TReader<TKey>


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TReader, Pointer)

class operator Equal(const ALeft: TReader<TKey>; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TReader<TKey>

ARight: Pointer

Returns

Boolean


NotEqual(TReader, Pointer)

class operator NotEqual(const ALeft: TReader<TKey>; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TReader<TKey>

ARight: Pointer

Returns

Boolean


Method Descriptions

Entry<TValue>(TKey)

Creates a TEntryHandle for direct read access to the value.

function Entry<TValue>(const AKey: TKey): TResult<TEntryHandle<TKey>, TEntryHandleError>; inline

Type Parameters

TValue:

Parameters

AKey: TKey

Returns

TResult<TEntryHandle<TKey>, TEntryHandleError>