Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvStreamEventSink Class Reference

Event sink used to receive buffer queue/unqueue notifications. More...

Public Member Functions

 PvStreamEventSink ()
 Constructor.
 
virtual ~PvStreamEventSink ()
 Destructor.
 
virtual void OnBufferQueued (PvBuffer *aBuffer)
 Override to get OnBufferQueued callback. More...
 
virtual void OnBufferRetrieved (PvBuffer *aBuffer)
 Override to get OnBufferRetrieved callback. More...
 

Detailed Description

Event sink used to receive buffer queue/unqueue notifications.

Inherit a class from this interface and register an instance of it to a PvStream in order to receive these notifications.

These notifications are fired when events of pushing buffers in the stream object with QueueBuffer and RetrieveBuffer are called by user code or another object like PvPipeline.

QueueBuffer and RetrieveBuffer still need to be called. This notificaiton mechanism cannot be used in place of QueueBuffer and RetrieveBuffer to receive buffer delivery callbacks.

Member Function Documentation

void PvStreamEventSink::OnBufferQueued ( PvBuffer aBuffer)
virtual

Override to get OnBufferQueued callback.

Called when a buffer is queued in a PvStream through QueueBuffer. Sychronous call, can be used to perform operations on the buffer if required.

Base implementation does not need to be called.

Parameters
[in]aBufferA pointer to the buffer being queued in the stream object.
void PvStreamEventSink::OnBufferRetrieved ( PvBuffer aBuffer)
virtual

Override to get OnBufferRetrieved callback.

Called when a buffer is retrieved from a PvStream through RetrieveBuffer. Sychronous call, can be used to perform operations on the buffer before it is delivered to the RetrieveBuffer caller if required.

Base implementation does not need to be called.

Parameters
[in]aBufferA pointer to the buffer being retrieved from the stream object.

The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com