git-master/UnbufferedContactable_8h_source.html

/*

 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)

 * SPDX-License-Identifier: BSD-3-Clause

 */


#ifndef YARP_OS_UNBUFFEREDCONTACTABLE_H

#define YARP_OS_UNBUFFEREDCONTACTABLE_H


#include <yarp/os/Contactable.h>


namespace yarp::os {


class YARP_os_API UnbufferedContactable : public Contactable

{

public:

    virtual bool write(const PortWriter& writer,

                       const PortWriter* callback = nullptr) const = 0;


    virtual bool write(const PortWriter& writer,

                       PortReader& reader,

                       const PortWriter* callback = nullptr) const = 0;


    virtual bool read(PortReader& reader, bool willReply = false) = 0;


    virtual bool reply(PortWriter& writer) = 0;


    virtual bool replyAndDrop(PortWriter& writer) = 0;

};


} // namespace yarp::os


#endif // YARP_OS_UNBUFFEREDCONTACTABLE_H

Contactable.h

yarp::os::Contactable
An abstract port.
Definition: Contactable.h:28

yarp::os::PortReader
Interface implemented by all objects that can read themselves from the network, such as Bottle object...
Definition: PortReader.h:24

yarp::os::PortWriter
Interface implemented by all objects that can write themselves to the network, such as Bottle objects...
Definition: PortWriter.h:23

yarp::os::UnbufferedContactable
An abstract unbuffered port.
Definition: UnbufferedContactable.h:18

yarp::os::UnbufferedContactable::write
virtual bool write(const PortWriter &writer, PortReader &reader, const PortWriter *callback=nullptr) const =0
Write an object to the port, then expect one back.

yarp::os::UnbufferedContactable::read
virtual bool read(PortReader &reader, bool willReply=false)=0
Read an object from the port.

yarp::os::UnbufferedContactable::write
virtual bool write(const PortWriter &writer, const PortWriter *callback=nullptr) const =0
Write an object to the port.

yarp::os::UnbufferedContactable::reply
virtual bool reply(PortWriter &writer)=0
Send an object as a reply to an object read from the port.

yarp::os::UnbufferedContactable::replyAndDrop
virtual bool replyAndDrop(PortWriter &writer)=0
Same as reply(), but closes connection after reply.

yarp::os
An interface to the operating system, including Port based communication.
Definition: AbstractCarrier.h:13

YARP_os_API
#define YARP_os_API
Definition: api.h:18