cRequestBroker

This is the default implementation of IStreamingRequests used by requestable_writer. More...

Inheritance diagram for cRequestBroker:

Public Member Functions
	cRequestBroker (cSampleWriter *pWriter=nullptr)
	Default constructor. More...
	~cRequestBroker () override
	Destructor.
void	SetCallbacks (std::function< void(uint32_t, const base::IProperties *)> fnEnable, std::function< void(uint32_t)> fnDisable)
	Sets the callbacks for enabling and disabling specific Substreams. More...
void	UpdateType (const ucom::ant::iobject_ptr< const IStreamType > &pType)
	Call this when you updated your Substreams type. More...
void	DisableCurrentRequests (bool bCallDisableCallback=false)
	This will disable all current requests. More...
tResult	RequestSamples (ucom::ant::iobject_ptr< IStreamingRequest > &pRequest, uint32_t nSubStreamId, const base::ant::IProperties *pRequestProperties=nullptr) override
void	RegisterStreamTypeHandler (IStreamTypeHandler &oHandler) override
void	UnregisterStreamTypeHandler (IStreamTypeHandler &oHandler) override
Public Member Functions inherited from object< Bases >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object. More...
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying. More...
void	Destroy () const override
	Destruct and deallocate instantiations of type IObject. More...
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast() More...

Private Attributes
std::unique_ptr< cImplementation >	m_pImplementation

Additional Inherited Members
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

This is the default implementation of IStreamingRequests used by requestable_writer.

Definition at line 27 of file requestable_writer.h.

Constructor & Destructor Documentation

cRequestBroker()

cRequestBroker

(

cSampleWriter *

pWriter = nullptr

)

Default constructor.

Parameters

[in]

pWriter

The writer instance that this broker is associated with. This is used for error handling.

Member Function Documentation

DisableCurrentRequests()

void DisableCurrentRequests

(

bool

bCallDisableCallback = false

)

This will disable all current requests.

Parameters

[in]

bCallDisableCallback

if true, the callback for disabling Substreams will be called for each currently enabled Substream.

SetCallbacks()

void SetCallbacks	(	std::function< void(uint32_t, const base::IProperties *)>	fnEnable,
		std::function< void(uint32_t)>	fnDisable
	)

Sets the callbacks for enabling and disabling specific Substreams.

Parameters

[in]	fnEnable	This is called when the first consumer requests a specific Substream.
[in]	fnDisable	This is called when the last consumer cancels its request for a Substream.

UpdateType()

void UpdateType

(

const ucom::ant::iobject_ptr< const IStreamType > &

pType

)

Call this when you updated your Substreams type.

Parameters

[in]

pType

The new Stream Type.