PortCoreOutputUnit.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_IMPL_PORTCOREOUTPUTUNIT_H
#define YARP_OS_IMPL_PORTCOREOUTPUTUNIT_H
 
#include <yarp/os/OutputProtocol.h>
#include <yarp/os/Semaphore.h>
#include <yarp/os/impl/PortCore.h>
#include <yarp/os/impl/PortCoreUnit.h>
 
#include <mutex>
 
namespace yarp::os::impl {
 
class PortCoreOutputUnit :
        public PortCoreUnit
{
public:
    PortCoreOutputUnit(PortCore& owner, int index, OutputProtocol* op);
 
    ~PortCoreOutputUnit() override;
 
    bool start() override;
 
    void run() override;
 
    virtual void runSingleThreaded();
 
    // documented in PortCoreUnit
    bool isOutput() override
    {
        return true;
    }
 
    // documented in PortCoreUnit
    void close() override
    {
        closeMain();
    }
 
    // documented in PortCoreUnit
    bool isFinished() override
    {
        return finished;
    }
 
    const std::string& getName()
    {
        return name;
    }
 
    // documented in PortCoreUnit
    Route getRoute() override;
 
    // documented in PortCoreUnit
    void* send(const yarp::os::PortWriter& writer,
               yarp::os::PortReader* reader,
               const yarp::os::PortWriter* callback,
               void* tracker,
               const std::string& envelopeString,
               bool waitAfter,
               bool waitBefore,
               bool* gotReply) override;
 
    // documented in PortCoreUnit
    void* takeTracker() override;
 
    // documented in PortCoreUnit
    bool isBusy() override;
 
    // documented in PortCoreUnit
    void setCarrierParams(const yarp::os::Property& params) override;
 
    // documented in PortCoreUnit
    void getCarrierParams(yarp::os::Property& params) override;
 
    // return the protocol object
    OutputProtocol* getOutPutProtocol();
 
private:
    OutputProtocol *op; 
    bool closing;       
    bool finished;      
    bool running;       
    bool threaded;      
    bool sending;       
    std::string name;
    yarp::os::Semaphore phase;        
    yarp::os::Semaphore activate;     
    std::mutex trackerMutex; 
    const yarp::os::PortWriter* cachedWriter;   
    yarp::os::PortReader *cachedReader;   
    const yarp::os::PortWriter* cachedCallback; 
    void *cachedTracker;        
    std::string cachedEnvelope;      
 
    bool sendHelper();
 
    void closeBasic();
 
    void closeMain();
};
 
} // namespace yarp::os::impl
 
#endif // YARP_OS_IMPL_PORTCOREOUTPUTUNIT_H