Public Member Functions | Protected Member Functions | Private Attributes | List of all members
RTC::InPortPushConnector Class Reference

InPortPushConnector class. More...

#include <InPortPushConnector.h>

Inheritance diagram for RTC::InPortPushConnector:
Inheritance graph
[legend]

Public Member Functions

virtual void activate ()
 Connector activation. More...
 
virtual void deactivate ()
 Connector deactivation. More...
 
virtual ReturnCode disconnect ()
 disconnect More...
 
DATAPORTSTATUS_ENUM InPortPushConnector (ConnectorInfo info, InPortProvider *provider, ConnectorListeners &listeners, CdrBufferBase *buffer=0)
 Constructor. More...
 
virtual ReturnCode read (cdrMemoryStream &data)
 Reading data. More...
 
virtual ~InPortPushConnector ()
 Destructor. More...
 
- Public Member Functions inherited from RTC::InPortConnector
virtual CdrBufferBasegetBuffer ()
 Getting Buffer. More...
 
virtual const char * id ()
 Getting Connector ID. More...
 
DATAPORTSTATUS_ENUM InPortConnector (ConnectorInfo &info, CdrBufferBase *buffer)
 Constructor. More...
 
virtual bool isLittleEndian ()
 Whether this connector's endian is little. More...
 
virtual const char * name ()
 Getting Connector name. More...
 
virtual const ConnectorInfoprofile ()
 Getting ConnectorInfo. More...
 
virtual void setEndian (const bool endian_type)
 Setting an endian type. More...
 
virtual ~InPortConnector ()
 Destructor. More...
 
- Public Member Functions inherited from RTC::ConnectorBase
virtual ~ConnectorBase ()
 Destructor. More...
 

Protected Member Functions

virtual CdrBufferBasecreateBuffer (ConnectorInfo &info)
 create buffer More...
 
void onConnect ()
 Invoke callback when connection is established. More...
 
void onDisconnect ()
 Invoke callback when connection is destroied. More...
 

Private Attributes

bool m_deleteBuffer
 
ConnectorListenersm_listeners
 A reference to a ConnectorListener. More...
 
InPortProviderm_provider
 the pointer to the InPortConsumer More...
 

Additional Inherited Members

- 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...
 
- Static Public Member Functions inherited from RTC::DataPortStatus
static const char * toString (DataPortStatus::Enum status)
 Convert DataPortStatus into the string. More...
 
- Protected Attributes inherited from RTC::InPortConnector
CdrBufferBasem_buffer
 Connector's buffer. More...
 
bool m_littleEndian
 Connected Endian. More...
 
ConnectorInfo m_profile
 ConnectorInfo. More...
 
Logger rtclog
 Logger stream. More...
 

Detailed Description

InPortPushConnector class.

Connector class of InPort for push type dataflow. When "push" is specified as dataflow_type at the time of establishing connection, this object is generated and owned by the InPort. This connector and OutPortPushConnector make a pair and realize push type dataflow of data ports. One connector corresponds to one connection which provides a data stream. Connector is distinguished by ID of the UUID that is generated at establishing connection.

InPortPushConnector owns and manages the following objects.

Data written into the OutPort are passed to the InPortProvider::put() by OutPortConnector. The data is written into the buffer in the connector.

Since
1.0.0

Definition at line 80 of file InPortPushConnector.h.

Constructor & Destructor Documentation

◆ InPortPushConnector()

RTC::InPortPushConnector::InPortPushConnector ( ConnectorInfo  profile,
InPortProvider provider,
ConnectorListeners listeners,
CdrBufferBase buffer = 0 
)

Constructor.

Mock InPortPushConnector

Definition at line 33 of file InPortPushConnector.cpp.

◆ ~InPortPushConnector()

RTC::InPortPushConnector::~InPortPushConnector ( )
virtual

Destructor.

This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.

Definition at line 64 of file InPortPushConnector.cpp.

Member Function Documentation

◆ activate()

virtual void RTC::InPortPushConnector::activate ( )
inlinevirtual

Connector activation.

This operation activates this connector

Implements RTC::ConnectorBase.

Definition at line 217 of file InPortPushConnector.h.

◆ createBuffer()

CdrBufferBase * RTC::InPortPushConnector::createBuffer ( ConnectorInfo info)
protectedvirtual

create buffer

This function creates a buffer based on given information.

Parameters
infoConnector information
Returns
The poitner to the buffer

Definition at line 148 of file InPortPushConnector.cpp.

◆ deactivate()

virtual void RTC::InPortPushConnector::deactivate ( )
inlinevirtual

Connector deactivation.

This operation deactivates this connector

Implements RTC::ConnectorBase.

Definition at line 233 of file InPortPushConnector.h.

◆ disconnect()

ConnectorBase::ReturnCode RTC::InPortPushConnector::disconnect ( )
virtual

disconnect

This operation destruct and delete the consumer, the publisher and the buffer.

Returns
PORT_OK

Implements RTC::InPortConnector.

Definition at line 119 of file InPortPushConnector.cpp.

◆ onConnect()

void RTC::InPortPushConnector::onConnect ( )
protected

Invoke callback when connection is established.

Definition at line 163 of file InPortPushConnector.cpp.

◆ onDisconnect()

void RTC::InPortPushConnector::onDisconnect ( )
protected

Invoke callback when connection is destroied.

Definition at line 175 of file InPortPushConnector.cpp.

◆ read()

ConnectorBase::ReturnCode RTC::InPortPushConnector::read ( cdrMemoryStream &  data)
virtual

Reading data.

This function reads data from the buffer. If data is read properly, this function will return PORT_OK return code. Except normal return, BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET and PORT_ERROR will be returned as error codes.

Returns
PORT_OK Normal return BUFFER_EMPTY Buffer empty TIMEOUT Timeout PRECONDITION_NOT_MET Preconditin not met PORT_ERROR Other error

Implements RTC::InPortConnector.

Definition at line 78 of file InPortPushConnector.cpp.

Member Data Documentation

◆ m_deleteBuffer

bool RTC::InPortPushConnector::m_deleteBuffer
private

Definition at line 294 of file InPortPushConnector.h.

◆ m_listeners

ConnectorListeners& RTC::InPortPushConnector::m_listeners
private

A reference to a ConnectorListener.

Definition at line 292 of file InPortPushConnector.h.

◆ m_provider

InPortProvider* RTC::InPortPushConnector::m_provider
private

the pointer to the InPortConsumer

Definition at line 283 of file InPortPushConnector.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:47