TServiceBuilderEvent
Builder to create new TMessagingPattern.Event based services
Definition
Unit: Neslib.Iceoryx2.Event
Methods
| Name | Description |
|---|---|
| _Init | |
| Create | Creates a new service. |
| CreateWithAttributes | Creates a new service with a set of attributes. |
| Deadline | Enables the deadline property of the service. There must be a notification emitted by any TNotifier after at least the provided ADeadline. |
| DisableDeadline | Disables the deadline property of the service. TNotifier can signal notifications at any rate. |
| DisableNotifierCreatedEvent | If the service is created it disables sending an event when a new notifier was created. |
| DisableNotifierDeadEvent | If the service is created it disables sending an event when a notifier was identified as dead |
| DisableNotifierDroppedEvent | If the service is created it disables sending an event when a notifier was dropped. |
| EventIdMaxValue | If the service is created it set the greatest supported TNodeId value. If an existing service is opened it defines the value size the TNodeId must at least support. |
| MaxListeners | If the service is created it defines how many TListener's shall be supported at most. If an existing service is opened it defines how many TListener's must be at least supported. |
| MaxNodes | If the service is created it defines how many TNode's shall be able to open it in parallel. If an existing service is opened it defines how many TNode's must be at least supported. |
| MaxNotifiers | If the service is created it defines how many TNotifier's shall be supported at most. If an existing service is opened it defines how many TNotifier's must be at least supported. |
| NotifierCreatedEvent | If the service is created it defines the event that shall be emitted by every newly created TNotifier. |
| NotifierDeadEvent | If the service is created it defines the event that shall be emitted when a TNotifier is identified as dead. If none is provided no event will be emitted. |
| NotifierDroppedEvent | If the service is created it defines the event that shall be emitted by every TNotifier before it is dropped. If none is provided a TNotifier will not emit an event. |
| Open | Opens an existing service. |
| OpenOrCreate | If the service exists, it will be opened otherwise a new service will be created. |
| OpenOrCreateWithAttributes | If the service exists, it will be opened otherwise a new service will be created. It defines a set of attributes. If the service already exists, all attribute requirements must be satisfied otherwise the open process will fail. If the service does not exist the required attributes will be defined in the service. |
| OpenWithAttributes | Opens an existing service with attribute requirements. If the defined attribute requirements are not satisfied the open process will fail. |
Method Descriptions
_Init(_iox2_service_builder_h, TServiceType)
procedure _Init(const AHandle: _iox2_service_builder_h; const AServiceType: TServiceType); inline
Parameters
AHandle: _iox2_service_builder_h
AServiceType: TServiceType
Create
Creates a new service.
function Create: TResult<TPortFactoryEvent, TEventCreateError>
Returns
TResult<TPortFactoryEvent, TEventCreateError>
CreateWithAttributes(TAttributeSpecifier)
Creates a new service with a set of attributes.
function CreateWithAttributes(const AAttributes: TAttributeSpecifier): TResult<TPortFactoryEvent, TEventCreateError>
Parameters
AAttributes: TAttributeSpecifier
Returns
TResult<TPortFactoryEvent, TEventCreateError>
Deadline(TDuration)
Enables the deadline property of the service. There must be a notification emitted by any TNotifier after at least the provided ADeadline.
function Deadline(const ADeadline: TDuration): PServiceBuilderEvent; inline
Parameters
ADeadline: TDuration
Returns
DisableDeadline
Disables the deadline property of the service. TNotifier can signal notifications at any rate.
function DisableDeadline: PServiceBuilderEvent; inline
Returns
DisableNotifierCreatedEvent
If the service is created it disables sending an event when a new notifier was created.
function DisableNotifierCreatedEvent: PServiceBuilderEvent; inline
Returns
DisableNotifierDeadEvent
If the service is created it disables sending an event when a notifier was identified as dead
function DisableNotifierDeadEvent: PServiceBuilderEvent; inline
Returns
DisableNotifierDroppedEvent
If the service is created it disables sending an event when a notifier was dropped.
function DisableNotifierDroppedEvent: PServiceBuilderEvent; inline
Returns
EventIdMaxValue(UInt64)
If the service is created it set the greatest supported TNodeId value. If an existing service is opened it defines the value size the TNodeId must at least support.
function EventIdMaxValue(const AValue: UInt64): PServiceBuilderEvent; inline
Parameters
AValue: UInt64
Returns
MaxListeners(UInt64)
If the service is created it defines how many TListener's shall be supported at most. If an existing service is opened it defines how many TListener's must be at least supported.
function MaxListeners(const AValue: UInt64): PServiceBuilderEvent; inline
Parameters
AValue: UInt64
Returns
MaxNodes(UInt64)
If the service is created it defines how many TNode's shall be able to open it in parallel. If an existing service is opened it defines how many TNode's must be at least supported.
function MaxNodes(const AValue: UInt64): PServiceBuilderEvent; inline
Parameters
AValue: UInt64
Returns
MaxNotifiers(UInt64)
If the service is created it defines how many TNotifier's shall be supported at most. If an existing service is opened it defines how many TNotifier's must be at least supported.
function MaxNotifiers(const AValue: UInt64): PServiceBuilderEvent; inline
Parameters
AValue: UInt64
Returns
NotifierCreatedEvent(TEventId)
If the service is created it defines the event that shall be emitted by every newly created TNotifier.
function NotifierCreatedEvent(const AEventId: TEventId): PServiceBuilderEvent; inline
Parameters
AEventId: TEventId
Returns
NotifierDeadEvent(TEventId)
If the service is created it defines the event that shall be emitted when a TNotifier is identified as dead. If none is provided no event will be emitted.
function NotifierDeadEvent(const AEventId: TEventId): PServiceBuilderEvent; inline
Parameters
AEventId: TEventId
Returns
NotifierDroppedEvent(TEventId)
If the service is created it defines the event that shall be emitted by every TNotifier before it is dropped. If none is provided a TNotifier will not emit an event.
function NotifierDroppedEvent(const AEventId: TEventId): PServiceBuilderEvent; inline
Parameters
AEventId: TEventId
Returns
Open
Opens an existing service.
function Open: TResult<TPortFactoryEvent, TEventOpenError>
Returns
TResult<TPortFactoryEvent, TEventOpenError>
OpenOrCreate
If the service exists, it will be opened otherwise a new service will be created.
function OpenOrCreate: TResult<TPortFactoryEvent, TEventOpenOrCreateError>
Returns
TResult<TPortFactoryEvent, TEventOpenOrCreateError>
OpenOrCreateWithAttributes(TAttributeVerifier)
If the service exists, it will be opened otherwise a new service will be created. It defines a set of attributes. If the service already exists, all attribute requirements must be satisfied otherwise the open process will fail. If the service does not exist the required attributes will be defined in the service.
function OpenOrCreateWithAttributes(const ARequiredAttributes: TAttributeVerifier): TResult<TPortFactoryEvent, TEventOpenOrCreateError>
Parameters
ARequiredAttributes: TAttributeVerifier
Returns
TResult<TPortFactoryEvent, TEventOpenOrCreateError>
OpenWithAttributes(TAttributeVerifier)
Opens an existing service with attribute requirements. If the defined attribute requirements are not satisfied the open process will fail.
function OpenWithAttributes(const ARequiredAttributes: TAttributeVerifier): TResult<TPortFactoryEvent, TEventOpenError>
Parameters
ARequiredAttributes: TAttributeVerifier
Returns
TResult<TPortFactoryEvent, TEventOpenError>