TSubscriber<TPayload, TUserHeader>
Receiving endpoint of a publish-subscriber based communication.
Definition
Unit: Neslib.Iceoryx2.PublishSubscribe
Type Parameters
TPayload:
TUserHeader:
Properties
| Name | Description |
|---|---|
| BufferSize | Returns the internal buffer size of the TSubscriber. |
| Handle | |
| HasSamples | Returns True when the TSubscriber has TSample's that can be acquired via TSubscriber.Receive, otherwise False. |
| Id | Returns the TUniqueSubscriberId of the TSubscriber |
| Name | Returns the TPortNameView of the TSubscriber |
Constructors
| Name | Description |
|---|---|
| Assign | |
| Finalize | |
| Initialize |
Operators
| Name | Description |
|---|---|
| Equal | |
| NotEqual |
Methods
| Name | Description |
|---|---|
| Receive | Receives a TSample from publisher. If no sample could be received None is returned. If a failure occurs TReceiveError is returned. |
Property Descriptions
BufferSize
Returns the internal buffer size of the TSubscriber.
property BufferSize: Int64 read GetBufferSize
Type: Int64
Handle
property Handle: THandle read GetHandle
Type: THandle
HasSamples
Returns True when the TSubscriber has TSample's that can be acquired via TSubscriber.Receive, otherwise False.
property HasSamples: TResult<Boolean, TConnectionFailure> read GetHasSamples
Type: TResult<Boolean, TConnectionFailure>
Id
Returns the TUniqueSubscriberId of the TSubscriber
property Id: TUniqueSubscriberId read GetId
Type: TUniqueSubscriberId
Name
Returns the TPortNameView of the TSubscriber
property Name: TPortNameView read GetName
Type: TPortNameView
Constructor Descriptions
Assign
constructor Assign(var ADest: TSubscriber<TPayload, TUserHeader>; const ASrc: TSubscriber<TPayload, TUserHeader>)
Parameters
ADest: TSubscriber<TPayload, TUserHeader>
ASrc: TSubscriber<TPayload, TUserHeader>
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TSubscriber, Pointer)
class operator Equal(const ALeft: TSubscriber<TPayload, TUserHeader>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TSubscriber<TPayload, TUserHeader>
ARight: Pointer
Returns
Boolean
NotEqual(TSubscriber, Pointer)
class operator NotEqual(const ALeft: TSubscriber<TPayload, TUserHeader>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TSubscriber<TPayload, TUserHeader>
ARight: Pointer
Returns
Boolean
Method Descriptions
Receive
Receives a TSample from publisher. If no sample could be received None is returned. If a failure occurs TReceiveError is returned.
function Receive: TResult<TSample<TPayload>, TReceiveError>; inline
Returns
TResult<TSample<TPayload>, TReceiveError>