Skip to content

TNotifier

Represents the sending endpoint of an event based communication.

Definition

Unit: Neslib.Iceoryx2.Event

type TNotifier = record ... end;

Properties

Name Description
Deadline Returns the deadline of the corresponding TService.
Handle
Id Returns the TUniqueNotifierId of the TNotifier
Name Returns the TPortNameView of the TNotifier

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
Notify Notifies all listeners connected to the service with the default event id provided on creation. Returns on success the number of TListener's that were notified otherwise it returns TNotifierNotifyError.
NotifyWithCustomEventId Notifies all listener connected to the service with a custom TEventId. Returns on success the number of TListener's that were notified otherwise it returns TNotifierNotifyError.

Property Descriptions

Deadline

Returns the deadline of the corresponding TService.

property Deadline: Nullable<TDuration> read GetDeadline

Type: Nullable<TDuration>


Handle

property Handle: THandle read GetHandle

Type: THandle


Id

Returns the TUniqueNotifierId of the TNotifier

property Id: TUniqueNotifierId read GetId

Type: TUniqueNotifierId


Name

Returns the TPortNameView of the TNotifier

property Name: TPortNameView read GetName

Type: TPortNameView


Constructor Descriptions

Assign

constructor Assign(var ADest: TNotifier; const ASrc: TNotifier)

Parameters

ADest: TNotifier

ASrc: TNotifier


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TNotifier, Pointer)

class operator Equal(const ALeft: TNotifier; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TNotifier

ARight: Pointer

Returns

Boolean


NotEqual(TNotifier, Pointer)

class operator NotEqual(const ALeft: TNotifier; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TNotifier

ARight: Pointer

Returns

Boolean


Method Descriptions

Notify

Notifies all listeners connected to the service with the default event id provided on creation. Returns on success the number of TListener's that were notified otherwise it returns TNotifierNotifyError.

function Notify: TResult<NativeInt, TNotifierNotifyError>; inline

Returns

TResult<NativeInt, TNotifierNotifyError>


NotifyWithCustomEventId(TEventId)

Notifies all listener connected to the service with a custom TEventId. Returns on success the number of TListener's that were notified otherwise it returns TNotifierNotifyError.

function NotifyWithCustomEventId(const AEventId: TEventId): TResult<NativeInt, TNotifierNotifyError>; inline

Parameters

AEventId: TEventId

Returns

TResult<NativeInt, TNotifierNotifyError>