RTC::InPortTcpSockConsumer< DataType > Class Template Reference

InPortTcpSockConsumer class. More...

#include <InPortTcpSockConsumer.h>

Inheritance diagram for RTC::InPortTcpSockConsumer< DataType >:

RTC::InPortConsumer

List of all members.

Public Member Functions

 InPortTcpSockConsumer (BufferBase< DataType > &buffer, Properties &prop)
 Constructor.
 InPortTcpSockConsumer (const InPortTcpSockConsumer< DataType > &consumer)
 Copy constructor.
InPortTcpSockConsumeroperator= (const InPortTcpSockConsumer< DataType > &consumer)
 Assignment operator.
virtual ~InPortTcpSockConsumer ()
 Destructor.
void push ()
 Read data from the buffer.
virtual
InPortTcpSockConsumer
clone () const
 Create clone.
virtual bool subscribeInterface (const SDOPackage::NVList &properties)
 Subscribe to the data send notification.
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)
 Unsubscribe the data send notification.


Detailed Description

template<class DataType>
class RTC::InPortTcpSockConsumer< DataType >

InPortTcpSockConsumer class.

This is an implementation class of OutPort Consumer that uses TCP socket for means of communication.

Parameters:
DataType Data type held by the buffer that attached to this provider
Since:
0.4.1

Constructor & Destructor Documentation

template<class DataType>
RTC::InPortTcpSockConsumer< DataType >::InPortTcpSockConsumer ( BufferBase< DataType > &  buffer,
Properties prop 
) [inline]

Constructor.

Constructor

Parameters:
buffer Buffer objects that are attached to this Consumer
prop Properties for TCP communication setup

template<class DataType>
RTC::InPortTcpSockConsumer< DataType >::InPortTcpSockConsumer ( const InPortTcpSockConsumer< DataType > &  consumer  )  [inline]

Copy constructor.

Copy constructor

Parameters:
consumer InPortTcpSockConsumer object of copy source

template<class DataType>
virtual RTC::InPortTcpSockConsumer< DataType >::~InPortTcpSockConsumer (  )  [inline, virtual]

Destructor.

Destructor


Member Function Documentation

template<class DataType>
InPortTcpSockConsumer& RTC::InPortTcpSockConsumer< DataType >::operator= ( const InPortTcpSockConsumer< DataType > &  consumer  )  [inline]

Assignment operator.

Assignment operator

Parameters:
consumer InPortTcpSockConsumer object of assignment source
Returns:
The assignment result

template<class DataType>
void RTC::InPortTcpSockConsumer< DataType >::push (  )  [inline, virtual]

Read data from the buffer.

Read data from the buffer and send it.

Implements RTC::InPortConsumer.

template<class DataType>
virtual InPortTcpSockConsumer* RTC::InPortTcpSockConsumer< DataType >::clone (  )  const [inline, virtual]

Create clone.

Create clone objects of this InPortTcpSockConsumer.

Returns:
Clone InPortTcpSockConsumer objects

Implements RTC::InPortConsumer.

template<class DataType>
virtual bool RTC::InPortTcpSockConsumer< DataType >::subscribeInterface ( const SDOPackage::NVList &  properties  )  [inline, virtual]

Subscribe to the data send notification.

Subscribe the data send notification according to the specified property information.

Parameters:
properties Information for subscription
Returns:
Subscription result (Successful:true, Failed:false)

Implements RTC::InPortConsumer.

template<class DataType>
virtual void RTC::InPortTcpSockConsumer< DataType >::unsubscribeInterface ( const SDOPackage::NVList &  properties  )  [inline, virtual]

Unsubscribe the data send notification.

Unsubscribe the data send notification and close the TCP stream.

Implements RTC::InPortConsumer.


Generated on Wed May 21 05:17:34 2008 for OpenRTM by  doxygen 1.5.3