dw::framework::ChannelFactory Class Reference

Detailed Description

Shared allocator and context for Channels.

Definition at line 56 of file ChannelFactory.hpp.

Public Types
using	OnDispatchDataReady = dw::core::Function< void(void *opaque, ChannelObject::PacketPool::OnDataReady)>

Public Member Functions
	ChannelFactory (dwContextHandle_t ctx=DW_NULL_HANDLE)
	Construct a new Channel Factory object. More...
NvSciSyncModule	getNvSciSyncModule ()
ChannelPacketFactoryPtr	getPacketFactory ()
std::shared_ptr< ChannelObject >	makeChannel (const char *channelParams)
dw::core::Optional< ChannelError >	popError ()
dw::core::Optional< ChannelEvent >	popEvent (dwTime_t timeout)
void	setAffinity (uint32_t affinity)
void	setFsiComCreateOverrider (std::function< std::shared_ptr< IChannelFsiCom >(uint8_t, const char *)> &&overrider)
void	setOnDispatchDataReady (OnDispatchDataReady dispatchDataReady)
void	setPriority (int32_t priority)
void	startServices ()
void	stopServices ()
virtual	~ChannelFactory ()=default

Static Public Member Functions
static void	registerPacketConstructor (const ChannelPacketConstructorSignature &signature, const ChannelPacketConstructor &constructor)
static void	unregisterPacketConstructor (const ChannelPacketConstructorSignature &signature)

Member Typedef Documentation

OnDispatchDataReady

using dw::framework::ChannelFactory::OnDispatchDataReady = dw::core::Function<void(void* opaque, ChannelObject::PacketPool::OnDataReady)>

Definition at line 135 of file ChannelFactory.hpp.

Constructor & Destructor Documentation

ChannelFactory()

dw::framework::ChannelFactory::ChannelFactory ( dwContextHandle_t  ctx = DW_NULL_HANDLE )

explicit

Construct a new Channel Factory object.

Parameters

ctx	the DriveWorks context

~ChannelFactory()

virtual dw::framework::ChannelFactory::~ChannelFactory ( )

virtualdefault

Member Function Documentation

getNvSciSyncModule()

NvSciSyncModule dw::framework::ChannelFactory::getNvSciSyncModule

(

)

getPacketFactory()

ChannelPacketFactoryPtr dw::framework::ChannelFactory::getPacketFactory

(

)

makeChannel()

std::shared_ptr< ChannelObject > dw::framework::ChannelFactory::makeChannel

(

const char *

channelParams

)

Create a Channel

Parameters

channelParams

the parameters of the Channel

Returns

std::shared_ptr<ChannelObject>

popError()

dw::core::Optional< ChannelError > dw::framework::ChannelFactory::popError

(

)

Pop the oldest error

Returns

dw::core::Optional<ChannelError>

popEvent()

dw::core::Optional< ChannelEvent > dw::framework::ChannelFactory::popEvent

(

dwTime_t

timeout

)

Pop the oldest event.

Note

this method is not thread-safe.

Parameters

[in]

timeout

timeout for the wait

Returns

ChannelEvent if it came

registerPacketConstructor()

static void dw::framework::ChannelFactory::registerPacketConstructor ( const ChannelPacketConstructorSignature &  signature, const ChannelPacketConstructor &  constructor  )

static

Register a packet constructor to the factory.

Note

A packet class must be registered to the ChannelFactory before a corresponding ChannelObject which the application intends to use with said packet class is created.

Thread-safe

init-time only

Parameters

signature	The signature under chich to register the constructor.
constructor	The constructor to register.

setAffinity()

void dw::framework::ChannelFactory::setAffinity

(

uint32_t

affinity

)

Set affinity of services

Parameters

[in]

affinity

affinity mask

setFsiComCreateOverrider()

void dw::framework::ChannelFactory::setFsiComCreateOverrider

(

std::function< std::shared_ptr< IChannelFsiCom >(uint8_t, const char *)> &&

overrider

)

Override a factory function to create IChannelFsiCom

Parameters

overrider

a function pointer to a factory function for instantiating IChannelFsiCom

setOnDispatchDataReady()

void dw::framework::ChannelFactory::setOnDispatchDataReady

(

OnDispatchDataReady

dispatchDataReady

)

setPriority()

void dw::framework::ChannelFactory::setPriority

(

int32_t

priority

)

Set priority of services

Parameters

[in]

priority

priority

startServices()

void dw::framework::ChannelFactory::startServices

(

)

Start the background services of the Channels.

Note

Until services are started, Channels may not properly connect or get notified when new data is ready.

Performance to create Channels will be very slow due to contention of background services. Hence it is recommended to create all Channels before starting services.

stopServices()

void dw::framework::ChannelFactory::stopServices

(

)

Stop the background services of the Channels.

Note

While services are stopped, Channels may not properly be able to get notified when new data is ready.

Performance to delete Channels will be very slow due to contention of background services. Hence it is recommended to stop services before deleting any Channels.

unregisterPacketConstructor()

static void dw::framework::ChannelFactory::unregisterPacketConstructor ( const ChannelPacketConstructorSignature &  signature )

static

Unregister a packet constructor from the factory.

Note

Thread-safe

deinit-time only

Parameters

signature

The signature to unregister.

---

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

• src/dwcgf/channel/ChannelFactory.hpp