|virtual ReturnCode||activate ()=0|
|virtual ReturnCode||deactivate ()=0|
|virtual ReturnCode||init (coil::Properties &prop)=0|
|Initializing configuration. |
|virtual bool||isActive ()=0|
|If publisher is active state. |
|virtual void||release ()|
|Release the Publisher. |
|virtual ReturnCode||setBuffer (BufferBase< cdrMemoryStream > *buffer)=0|
|Setting buffer pointer. |
|virtual ReturnCode||setConsumer (InPortConsumer *consumer)=0|
|Store InPort consumer. |
|virtual ReturnCode||setListener (ConnectorInfo &info, ConnectorListeners *listeners)=0|
|Set the listener. |
|virtual ReturnCode||write (const cdrMemoryStream &data, unsigned long sec, unsigned long usec)=0|
|Write data. |
|virtual DATAPORTSTATUS_ENUM||~PublisherBase (void)|
Base class of Publisher.
This is a base class of Publisher*. This class manages data send timing. Variation of Publisher* which implements details of Publisher inherits this PublisherBase class.
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 operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.
|virtual bool RTC::PublisherBase::isActive||(||)||
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.
|virtual void RTC::PublisherBase::release||(||)||
|virtual ReturnCode RTC::PublisherBase::setBuffer||(||BufferBase< cdrMemoryStream > *||buffer||)||
Setting buffer pointer.
This operation sets a buffer that is associated with this object. If the buffer object is NULL, INVALID_ARGS will be returned.
|buffer||A pointer to a CDR buffer object.|
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.|
|virtual ReturnCode RTC::PublisherBase::setListener||(||ConnectorInfo &||info,|
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|
|virtual ReturnCode RTC::PublisherBase::write||(||const cdrMemoryStream &||data,|
This function writes data into the 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 etc. will be performed.
When publisher writes data, 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|