|typedef coil::Condition< Mutex >||Condition|
|typedef coil::Guard< coil::Mutex >||Guard|
|virtual ReturnCode||activate ()|
|virtual ReturnCode||deactivate ()|
|virtual ReturnCode||init (coil::Properties &prop)|
|virtual bool||isActive ()|
|If publisher is active state. |
|virtual ReturnCode||setBuffer (CdrBufferBase *buffer)|
|Setting buffer pointer. |
|virtual ReturnCode||setConsumer (InPortConsumer *consumer)|
|Store InPort consumer. |
|virtual ::RTC::DataPortStatus::Enum||setListener (ConnectorInfo &profile, RTC::ConnectorListeners *listeners)|
|Set the listener. |
|virtual ReturnCode||write (const cdrMemoryStream &data, unsigned long sec, unsigned long usec)|
|Write data. |
|void||onReceived (const cdrMemoryStream &data)|
|Notify an ON_RECEIVED event to listeners. |
|void||onReceiverError (const cdrMemoryStream &data)|
|Notify an ON_RECEIVER_ERROR 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||onSend (const cdrMemoryStream &data)|
|Notify an ON_SEND event to listners. |
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.
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.
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.
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|
If publisher is active state.
Confirm to activate.
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.
|void RTC::PublisherFlush::onReceived||(||const cdrMemoryStream &||data||)||
|void RTC::PublisherFlush::onReceiverError||(||const cdrMemoryStream &||data||)||
|void RTC::PublisherFlush::onReceiverFull||(||const cdrMemoryStream &||data||)||
|void RTC::PublisherFlush::onReceiverTimeout||(||const cdrMemoryStream &||data||)||
|void RTC::PublisherFlush::onSend||(||const cdrMemoryStream &||data||)||
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.|
|RTC::DataPortStatus::Enum RTC::PublisherFlush::setListener||(||ConnectorInfo &||profile,|
Set the listener.
Setting buffer pointer.
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|
|PublisherBase::ReturnCode RTC::PublisherFlush::write||(||const cdrMemoryStream &||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|