PublisherFlush class.
More...
#include <PublisherFlush.h>
Protected Member Functions |
void | onSend (const cdrMemoryStream &data) |
| Notify an ON_SEND event to listners.
|
void | onReceived (const cdrMemoryStream &data) |
| Notify an ON_RECEIVED event to listeners.
|
void | onReceiverFull (const cdrMemoryStream &data) |
| Notify an ON_RECEIVER_FULL event to listeners.
|
void | onReceiverTimeout (const cdrMemoryStream &data) |
| Notify an ON_RECEIVER_TIMEOUT event to listeners.
|
void | onReceiverError (const cdrMemoryStream &data) |
| Notify an ON_RECEIVER_ERROR event to listeners.
|
Detailed Description
PublisherFlush class.
This is a Publisher class of Flush type. This class sends unsend data that has been stored in the buffer. This executes Consumer that waits for the data send timing in the same thread as its send side.
Member Typedef Documentation
Constructor & Destructor Documentation
Constructor.
Consrtuctor.
virtual RTC::PublisherFlush::~PublisherFlush |
( |
void |
| ) |
|
|
virtual |
Member Function Documentation
virtual ReturnCode RTC::PublisherFlush::activate |
( |
| ) |
|
|
virtual |
activation
This function activates the publisher. By calling this function, this publisher starts the thread that pushes data to InPort. If precondition such as initialization process and so on is not met, the error code PRECONDITION_NOT_MET is returned.
- Returns
- PORT_OK normal return PRECONDITION_NOT_MET precondition is not met
Implements RTC::PublisherBase.
virtual ReturnCode RTC::PublisherFlush::deactivate |
( |
| ) |
|
|
virtual |
deactivation
This function deactivates the publisher. By calling this function, this publisher stops the thread that pushes data to InPort. If precondition such as initialization process and so on is not met, the error code PRECONDITION_NOT_MET is returned.
- Returns
- PORT_OK normal return PRECONDITION_NOT_MET precondition is not met
Implements RTC::PublisherBase.
initialization
This function have to be called before using this class object. However, this PublisherFlush class has no parameters to be initialized.
- Parameters
-
property | Property objects that includes the control information of this Publisher |
- Returns
- ReturnCode PORT_OK normal return INVALID_ARGS Properties with invalid values.
Implements RTC::PublisherBase.
virtual bool RTC::PublisherFlush::isActive |
( |
| ) |
|
|
virtual |
If publisher is active state.
A Publisher can be activated/deactivated synchronized with the data port. The active state and the non-active state are made transition by the "activate()" and the "deactivate()" functions respectively. This function confirms if the publisher is in active state.
- Returns
- Result of state confirmation (Active state:true, Inactive state:false)
Implements RTC::PublisherBase.
void RTC::PublisherFlush::onReceived |
( |
const cdrMemoryStream & |
data | ) |
|
|
inlineprotected |
Notify an ON_RECEIVED event to listeners.
- Parameters
-
References RTC::ON_RECEIVED.
void RTC::PublisherFlush::onReceiverError |
( |
const cdrMemoryStream & |
data | ) |
|
|
inlineprotected |
void RTC::PublisherFlush::onReceiverFull |
( |
const cdrMemoryStream & |
data | ) |
|
|
inlineprotected |
void RTC::PublisherFlush::onReceiverTimeout |
( |
const cdrMemoryStream & |
data | ) |
|
|
inlineprotected |
void RTC::PublisherFlush::onSend |
( |
const cdrMemoryStream & |
data | ) |
|
|
inlineprotected |
Notify an ON_SEND event to listners.
- Parameters
-
References RTC::ON_SEND.
virtual ReturnCode RTC::PublisherFlush::setBuffer |
( |
CdrBufferBase * |
buffer | ) |
|
|
virtual |
Setting buffer pointer.
Since PublisherFlush does not use any buffers, This function always returns PORT_OK.
- Parameters
-
- Returns
- PORT_OK
virtual ReturnCode RTC::PublisherFlush::setConsumer |
( |
InPortConsumer * |
consumer | ) |
|
|
virtual |
Store InPort consumer.
This operation sets a consumer that is associated with this object. If the consumer object is NULL, INVALID_ARGS will be returned.
- Parameters
-
consumer | A pointer to a consumer object. |
- Returns
- ReturnCode PORT_OK normal return INVALID_ARGS given argument has invalid value
Implements RTC::PublisherBase.
Set the listener.
This function sets ConnectorListeners listener object to the Publisher. By setting ConnectorListeners containing various listeners objects, these listeners are called at the time of reading and writing of a buffer, and transmission of data etc. Since the ownership of the ConnectorListeners object is owned by Port or RTObject, the Publisher never deletes the ConnectorListeners object. If the given ConnectorListeners' pointer is NULL, this function returns INVALID_ARGS.
- Parameters
-
- Returns
- PORT_OK Normal return INVALID_ARGS Invalid arguments
Implements RTC::PublisherBase.
virtual ReturnCode RTC::PublisherFlush::write |
( |
const cdrMemoryStream & |
data, |
|
|
unsigned long |
sec, |
|
|
unsigned long |
usec |
|
) |
| |
|
virtual |
Write data.
This function writes data into the consumer associated with this Publisher. If this function is called without initializing correctly such as a consumer, listeners, etc., error code PRECONDITION_NOT_MET will be returned and no operation of the writing to the consumer etc. will be performed.
When publisher writes data to the buffer, if the consumer returns full-status, returns error, is returned with timeout, error codes BUFFER_FULL, BUFFER_ERROR and BUFFER_TIMEOUT will be returned respectively.
In other cases, PROT_ERROR will be returned.
- Parameters
-
data | Data to be wrote to the buffer |
sec | Timeout time in unit seconds |
nsec | Timeout time in unit nano-seconds |
- Returns
- PORT_OK Normal return PRECONDITION_NO_MET Precondition does not met. A consumer, a buffer, listenes are not set properly. SEND_FULL Data was sent but full-status returned SEND_TIMEOUT Data was sent but timeout occurred CONNECTION_LOST detected that the connection has been lost
Implements RTC::PublisherBase.