ds3d::GuardDataFilter Class Reference

Detailed Description

GuardDataFilter is the safe access entry for abiDataFilter.

Applications can use it to make C-based APIs safer. it would manage abiRefDataFilter automatically. with that, App user do not need to refCopy_i or destroy abiRefDataFilter manually.

For example: abiRefDataFilter* rawRef = creator(); GuardDataFilter guardFilter(rawRef, true); // take the ownership of rawRef guardFilter.setUserData(userdata, [](void*){ ...free... }); guardFilter.setErrorCallback([](ErrCode c, const char* msg){ stderr << msg; }); ErrCode c = guardFilter.start(config, path); DS_ASSERT(isGood(c)); c = guardFilter.start(config, path); // invoke abiDataFilter::start_i(...) GuardDataMap inputData = ...; // prepare input data // invoke abiDataFilter::process_i(...) c = guardFilter.process(inputData, [](ErrCode c, const abiRefDataMap* d){ GuardDataMap outputData(<em>d); // output data processing std::cout << "output data processing starts" << std::endl; }, [](ErrCode c, const abiRefDataMap d){ GuardDataMap doneData(*d); std::cout << "input data consumed" << std::endl; }); DS_ASSERT(isGood(c)); //... wait for all data processed before stop c = guardFilter.flush(); c = guardFilter.stop(); // invoke abiDataFilter::stop_i(...) guardFilter.reset(); // destroy abiRefDataFilter, when all reference // destroyed, abiDataFilter would be freed.

Definition at line 55 of file datafilter.hpp.

Inheritance diagram for ds3d::GuardDataFilter:

Collaboration diagram for ds3d::GuardDataFilter:

Public Types
using	abiRefType = abiRefT< abiDataFilter >

Public Member Functions
template<typename... Args>
	GuardDataFilter (Args &&... args)
	~GuardDataFilter ()=default
ErrCode	process (GuardDataMap datamap, abiOnDataCB::CppFunc outputDataCB, abiOnDataCB::CppFunc inputConsumedCB)
void	setUserData (void *data, DelF delF)
virtual void *	getUserData () const
void	setErrorCallback (abiErrorCB::CppFunc errCb)
ErrCode	start (const std::string &content, const std::string &path="")
ErrCode	flush ()
ErrCode	stop ()
State	state () const
std::string	getCaps (CapsPort port)
std::string	getOutputCaps ()
std::string	getInputCaps ()
GuardTy	cast ()
abiDataFilter *	ptr () const
abiDataFilter *	operator-> () const
	operator bool () const
	operator ShrdPtr< abiDataFilter > ()
abiRefT< abiDataFilter > *	release ()
void	reset (abiRefT< abiDataFilter > *abiref=nullptr)
abiRefT< abiDataFilter > *	abiRef () const

Member Typedef Documentation

abiRefType

using ds3d::GuardDataT< abiDataFilter >::abiRefType = abiRefT<abiDataFilter >

inherited

Definition at line 333 of file obj.hpp.

Constructor & Destructor Documentation

GuardDataFilter()

template<typename... Args>

ds3d::GuardDataFilter::GuardDataFilter ( Args &&...  args )

inline

Definition at line 60 of file datafilter.hpp.

~GuardDataFilter()

ds3d::GuardDataFilter::~GuardDataFilter ( )

default

Member Function Documentation

abiRef()

abiRefT< abiDataFilter > * ds3d::GuardRef< abiRefT< abiDataFilter > , >::abiRef

inlineinherited

Definition at line 269 of file obj.hpp.

cast()

GuardTy ds3d::GuardDataT< abiDataFilter >::cast

inlineinherited

Definition at line 356 of file obj.hpp.

flush()

ErrCode ds3d::GuardDataProcess< abiDataFilter , >::flush

inlineinherited

Definition at line 76 of file dataprocess.hpp.

getCaps()

std::string ds3d::GuardDataProcess< abiDataFilter , >::getCaps ( CapsPort  port )

inlineinherited

Definition at line 94 of file dataprocess.hpp.

getInputCaps()

std::string ds3d::GuardDataProcess< abiDataFilter , >::getInputCaps

inlineinherited

Definition at line 101 of file dataprocess.hpp.

getOutputCaps()

std::string ds3d::GuardDataProcess< abiDataFilter , >::getOutputCaps

inlineinherited

Definition at line 100 of file dataprocess.hpp.

getUserData()

virtual void* ds3d::GuardDataProcess< abiDataFilter , >::getUserData

inlinevirtualinherited

Definition at line 55 of file dataprocess.hpp.

operator bool()

ds3d::GuardDataT< abiDataFilter >::operator bool

inlineinherited

Definition at line 370 of file obj.hpp.

operator ShrdPtr< abiDataFilter >()

ds3d::GuardDataT< abiDataFilter >::operator ShrdPtr< abiDataFilter >

inlineinherited

Definition at line 372 of file obj.hpp.

operator->()

abiDataFilter * ds3d::GuardDataT< abiDataFilter >::operator->

inlineinherited

Definition at line 368 of file obj.hpp.

process()

ErrCode ds3d::GuardDataFilter::process ( GuardDataMap  datamap, abiOnDataCB::CppFunc  outputDataCB, abiOnDataCB::CppFunc  inputConsumedCB  )

inline

Definition at line 65 of file datafilter.hpp.

References ds3d::GuardRef< ref, >::abiRef(), ds3d::GuardRef< abiCB >::abiRef(), DS_ASSERT, ds3d::abiDataFilter::process_i(), ds3d::GuardDataT< abiDataFilter >::ptr(), and ds3d::GuardCB< abiCB >::setFn().

ptr()

abiDataFilter * ds3d::GuardDataT< abiDataFilter >::ptr

inlineinherited

Definition at line 361 of file obj.hpp.

release()

abiRefT< abiDataFilter > * ds3d::GuardRef< abiRefT< abiDataFilter > , >::release

inlineinherited

Definition at line 253 of file obj.hpp.

reset()

void ds3d::GuardRef< abiRefT< abiDataFilter > , >::reset ( abiRefT< abiDataFilter > *  abiref = nullptr )

inlineinherited

Definition at line 260 of file obj.hpp.

setErrorCallback()

void ds3d::GuardDataProcess< abiDataFilter , >::setErrorCallback ( abiErrorCB::CppFunc  errCb )

inlineinherited

Definition at line 62 of file dataprocess.hpp.

setUserData()

void ds3d::GuardDataProcess< abiDataFilter , >::setUserData ( void *  data, DelF  delF  )

inlineinherited

Definition at line 44 of file dataprocess.hpp.

start()

ErrCode ds3d::GuardDataProcess< abiDataFilter , >::start ( const std::string &  content, const std::string &  path = ""  )

inlineinherited

Definition at line 70 of file dataprocess.hpp.

state()

State ds3d::GuardDataProcess< abiDataFilter , >::state

inlineinherited

Definition at line 88 of file dataprocess.hpp.

stop()

ErrCode ds3d::GuardDataProcess< abiDataFilter , >::stop

inlineinherited

Definition at line 82 of file dataprocess.hpp.

---

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

• datafilter.hpp