dw::framework::ChannelObject::Producer Class Reference

Detailed Description

Child interface to produce packets on the channel

Definition at line 149 of file Channel.hpp.

Inheritance diagram for dw::framework::ChannelObject::Producer:

Collaboration diagram for dw::framework::ChannelObject::Producer:

Public Member Functions
virtual dwStatus	get (GenericData *data)=0
virtual dwStatus	send (void *data)=0
Public Member Functions inherited from dw::framework::ChannelObject::PacketPool
SyncSignaler &	getSyncSignaler ()
SyncWaiter &	getSyncWaiter ()
virtual void	setOnDataReady (void *opaque, OnDataReady onDataReady)=0
virtual dwStatus	wait (dwTime_t timeout)=0

Additional Inherited Members
Public Types inherited from dw::framework::ChannelObject::PacketPool
using	OnDataReady = dw::core::Function< void()>

Member Function Documentation

get()

virtual dwStatus dw::framework::ChannelObject::Producer::get ( GenericData *  data )

pure virtual

Get writeable packet

Parameters

[out]

data

The packet information is returned here on DW_SUCCESS.

Returns

DW_NOT_AVAILABLE No free packets available DW_SUCCESS

Referenced by dw::framework::PortOutput< T >::getFreeElement().

send()

virtual dwStatus dw::framework::ChannelObject::Producer::send ( void *  data )

pure virtual

Send packet

Parameters

[in]

data

The packet data to be sent, must have come from get() call to the same instance. On DW_SUCCESS, write access is relinquished.

Returns

DW_BUFFER_FULL A consumer's buffers are full and was unable to receive the packet. DW_SUCCESS

Referenced by dw::framework::PortOutput< T >::send().

---

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

• src/dwcgf/channel/Channel.hpp