OpenRTM-aist
1.2.1
|
PublisherFlush class. More...
#include <PublisherFlush.h>
Public Types | |
typedef coil::Mutex | Mutex |
typedef coil::Condition< Mutex > | Condition |
typedef coil::Guard< coil::Mutex > | Guard |
Public Types inherited from RTC::DataPortStatus | |
enum | Enum { PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT, RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET, CONNECTION_LOST, UNKNOWN_ERROR } |
DataPortStatus return codes. More... | |
Public Member Functions | |
DATAPORTSTATUS_ENUM | PublisherFlush () |
Constructor. More... | |
virtual | ~PublisherFlush (void) |
Destructor. More... | |
virtual ReturnCode | init (coil::Properties &prop) |
initialization More... | |
virtual ReturnCode | setConsumer (InPortConsumer *consumer) |
Store InPort consumer. More... | |
virtual ReturnCode | setBuffer (CdrBufferBase *buffer) |
Setting buffer pointer. More... | |
virtual ::RTC::DataPortStatus::Enum | setListener (ConnectorInfo &profile, RTC::ConnectorListeners *listeners) |
Set the listener. More... | |
virtual ReturnCode | write (cdrMemoryStream &data, unsigned long sec, unsigned long usec) |
Write data. More... | |
virtual bool | isActive () |
If publisher is active state. More... | |
virtual ReturnCode | activate () |
activation More... | |
virtual ReturnCode | deactivate () |
deactivation More... | |
Public Member Functions inherited from RTC::PublisherBase | |
virtual DATAPORTSTATUS_ENUM | ~PublisherBase (void) |
Destructor. More... | |
virtual void | release () |
Release the Publisher. More... | |
Protected Member Functions | |
void | onSend (cdrMemoryStream &data) |
Notify an ON_SEND event to listners. More... | |
void | onReceived (cdrMemoryStream &data) |
Notify an ON_RECEIVED event to listeners. More... | |
void | onReceiverFull (cdrMemoryStream &data) |
Notify an ON_RECEIVER_FULL event to listeners. More... | |
void | onReceiverTimeout (cdrMemoryStream &data) |
Notify an ON_RECEIVER_TIMEOUT event to listeners. More... | |
void | onReceiverError (cdrMemoryStream &data) |
Notify an ON_RECEIVER_ERROR event to listeners. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from RTC::DataPortStatus | |
static const char * | toString (DataPortStatus::Enum status) |
Convert DataPortStatus into the string. More... | |
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.
DATAPORTSTATUS_ENUM RTC::PublisherFlush::PublisherFlush | ( | ) |
Constructor.
Consrtuctor.
|
virtual |
Destructor.
Destructor
|
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.
Implements RTC::PublisherBase.
|
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.
Implements RTC::PublisherBase.
|
virtual |
initialization
This function have to be called before using this class object. However, this PublisherFlush class has no parameters to be initialized.
property | Property objects that includes the control information of this Publisher |
Implements RTC::PublisherBase.
|
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.
Implements RTC::PublisherBase.
|
inlineprotected |
Notify an ON_RECEIVED event to listeners.
data | cdrMemoryStream |
References RTC::ON_RECEIVED.
|
inlineprotected |
Notify an ON_RECEIVER_ERROR event to listeners.
data | cdrMemoryStream |
References DLL_EXPORT, RTC::ON_RECEIVER_ERROR, and PublisherFlushInit().
|
inlineprotected |
Notify an ON_RECEIVER_FULL event to listeners.
data | cdrMemoryStream |
References RTC::ON_RECEIVER_FULL.
|
inlineprotected |
Notify an ON_RECEIVER_TIMEOUT event to listeners.
data | cdrMemoryStream |
References RTC::ON_RECEIVER_TIMEOUT.
|
inlineprotected |
|
virtual |
Setting buffer pointer.
Since PublisherFlush does not use any buffers, This function always returns PORT_OK.
buffer | CDR buffer |
Implements RTC::PublisherBase.
|
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.
consumer | A pointer to a consumer object. |
Implements RTC::PublisherBase.
|
virtual |
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.
info | ConnectorInfo that is localized object of ConnectorProfile |
listeners | ConnectorListeners that holds various listeners |
Implements RTC::PublisherBase.
|
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.
data | Data to be wrote to the buffer |
sec | Timeout time in unit seconds |
nsec | Timeout time in unit nano-seconds |
Implements RTC::PublisherBase.