PortWriterBuffer.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_PORTWRITERBUFFER_H
#define YARP_OS_PORTWRITERBUFFER_H
 
#include <yarp/os/Portable.h>
#include <yarp/os/PortWriterBufferBase.h>
 
namespace yarp::os {
 
class Port;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
template <class T>
class PortWriterBufferAdaptor : public PortWriterWrapper
{
public:
    PortWriterBufferManager& creator;
    T writer;
    void* tracker;
 
    PortWriterBufferAdaptor(PortWriterBufferManager& creator,
                            void* tracker) :
            creator(creator),
            tracker(tracker)
    {
    }
 
    bool write(ConnectionWriter& connection) const override
    {
        return writer.write(connection);
    }
 
    void onCompletion() const override
    {
        writer.onCompletion();
        creator.onCompletion(tracker);
    }
 
    void onCommencement() const override
    {
        writer.onCommencement();
    }
 
    PortWriter* getInternal() override
    {
        return &writer;
    }
};
 
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
 
template <class T>
class PortWriterBuffer : public PortWriterBufferBase
{
public:
    T& prepare()
    {
        return get();
    }
 
    bool unprepare()
    {
        return releaseContent();
    }
 
    T& get()
    {
        PortWriterBufferAdaptor<T>* content = (PortWriterBufferAdaptor<T>*)getContent(); // guaranteed to be non-NULL
        return content->writer;
    }
 
    int getCount()
    {
        return PortWriterBufferBase::getCount();
    }
 
    void attach(Port& port)
    {
        PortWriterBufferBase::attach(port);
    }
 
    void write(bool forceStrict = false)
    {
        PortWriterBufferBase::write(forceStrict);
    }
 
    void waitForWrite()
    {
        PortWriterBufferBase::waitForWrite();
    }
 
    virtual PortWriterWrapper* create(PortWriterBufferManager& man,
                                      void* tracker) override
    {
        return new PortWriterBufferAdaptor<T>(man, tracker);
    }
};
 
} // namespace yarp::os
 
#endif // YARP_OS_PORTWRITERBUFFER_H