YARP
Yet Another Robot Platform
yarp::os::PortReaderBufferBase Class Reference

#include <yarp/os/PortReaderBufferBase.h>

+ Inheritance diagram for yarp::os::PortReaderBufferBase:

Detailed Description

Definition at line 26 of file PortReaderBufferBase.h.

Classes

class  Private
 

Public Member Functions

 PortReaderBufferBase (unsigned int maxBuffer)
 
virtual ~PortReaderBufferBase ()
 
void setCreator (PortReaderBufferBaseCreator *creator)
 
void setReplier (yarp::os::PortReader &reader)
 
void setPrune (bool flag=true)
 
void setTargetPeriod (double period)
 
std::string getName () const
 
unsigned int getMaxBuffer ()
 
bool isClosed ()
 
void clear ()
 
virtual yarp::os::PortReadercreate ()
 
int check ()
 
virtual bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
yarp::os::PortReaderreadBase (bool &missed, bool cleanup)
 
void interrupt ()
 
void attachBase (yarp::os::Port &port)
 
virtual bool acceptObjectBase (yarp::os::PortReader *obj, yarp::os::PortWriter *wrapper)
 Careful! merge with ::read – very similar code Until merge, don't change one without looking at other :-(. More...
 
virtual bool forgetObjectBase (yarp::os::PortReader *obj, yarp::os::PortWriter *wrapper)
 
virtual bool getEnvelope (PortReader &envelope)
 
void * acquire ()
 
void release (void *key)
 
void setAllowReuse (bool flag=true)
 
void release (yarp::os::PortReader *completed)
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 

Constructor & Destructor Documentation

◆ PortReaderBufferBase()

PortReaderBufferBase::PortReaderBufferBase ( unsigned int  maxBuffer)

Definition at line 355 of file PortReaderBufferBase.cpp.

◆ ~PortReaderBufferBase()

PortReaderBufferBase::~PortReaderBufferBase ( )
virtual

Definition at line 360 of file PortReaderBufferBase.cpp.

Member Function Documentation

◆ acceptObjectBase()

bool PortReaderBufferBase::acceptObjectBase ( yarp::os::PortReader obj,
yarp::os::PortWriter wrapper 
)
virtual

Careful! merge with ::read – very similar code Until merge, don't change one without looking at other :-(.

Definition at line 559 of file PortReaderBufferBase.cpp.

◆ acquire()

void * PortReaderBufferBase::acquire ( )

Definition at line 621 of file PortReaderBufferBase.cpp.

◆ attachBase()

void PortReaderBufferBase::attachBase ( yarp::os::Port port)

Definition at line 548 of file PortReaderBufferBase.cpp.

◆ check()

int PortReaderBufferBase::check ( )

Definition at line 373 of file PortReaderBufferBase.cpp.

◆ clear()

void PortReaderBufferBase::clear ( )

Definition at line 639 of file PortReaderBufferBase.cpp.

◆ create()

yarp::os::PortReader * PortReaderBufferBase::create ( )
virtual

Definition at line 365 of file PortReaderBufferBase.cpp.

◆ forgetObjectBase()

bool PortReaderBufferBase::forgetObjectBase ( yarp::os::PortReader obj,
yarp::os::PortWriter wrapper 
)
virtual

Definition at line 610 of file PortReaderBufferBase.cpp.

◆ getEnvelope()

bool PortReaderBufferBase::getEnvelope ( PortReader envelope)
virtual

Definition at line 634 of file PortReaderBufferBase.cpp.

◆ getMaxBuffer()

unsigned int PortReaderBufferBase::getMaxBuffer ( )

Definition at line 538 of file PortReaderBufferBase.cpp.

◆ getName()

std::string PortReaderBufferBase::getName ( ) const

Definition at line 533 of file PortReaderBufferBase.cpp.

◆ interrupt()

void PortReaderBufferBase::interrupt ( )

Definition at line 382 of file PortReaderBufferBase.cpp.

◆ isClosed()

bool PortReaderBufferBase::isClosed ( )

Definition at line 543 of file PortReaderBufferBase.cpp.

◆ read()

bool PortReaderBufferBase::read ( yarp::os::ConnectionReader reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 444 of file PortReaderBufferBase.cpp.

◆ readBase()

PortReader * PortReaderBufferBase::readBase ( bool &  missed,
bool  cleanup 
)

Definition at line 388 of file PortReaderBufferBase.cpp.

◆ release() [1/2]

void PortReaderBufferBase::release ( void *  key)

Definition at line 626 of file PortReaderBufferBase.cpp.

◆ release() [2/2]

void PortReaderBufferBase::release ( yarp::os::PortReader completed)

Definition at line 651 of file PortReaderBufferBase.cpp.

◆ setAllowReuse()

void PortReaderBufferBase::setAllowReuse ( bool  flag = true)

Definition at line 661 of file PortReaderBufferBase.cpp.

◆ setCreator()

void PortReaderBufferBase::setCreator ( PortReaderBufferBaseCreator creator)

Definition at line 513 of file PortReaderBufferBase.cpp.

◆ setPrune()

void PortReaderBufferBase::setPrune ( bool  flag = true)

Definition at line 523 of file PortReaderBufferBase.cpp.

◆ setReplier()

void PortReaderBufferBase::setReplier ( yarp::os::PortReader reader)

Definition at line 518 of file PortReaderBufferBase.cpp.

◆ setTargetPeriod()

void PortReaderBufferBase::setTargetPeriod ( double  period)

Definition at line 528 of file PortReaderBufferBase.cpp.


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