Connection.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
 * All rights reserved.
 *
 * This software may be modified and distributed under the terms of the
 * BSD-3-Clause license. See the accompanying LICENSE file for details.
 */
 
#ifndef YARP_OS_CONNECTION_H
#define YARP_OS_CONNECTION_H
 
#include <yarp/os/api.h>
 
#include <string>
 
namespace yarp {
namespace os {
 
class Bytes;
class ConnectionReader;
class PortWriter;
class PortReader;
class Property;
 
class YARP_os_API Connection
{
public:
    virtual ~Connection();
 
    virtual bool isValid() const;
 
    virtual bool isTextMode() const = 0;
 
    virtual bool isBareMode() const;
 
    virtual void handleEnvelope(const std::string& envelope) = 0;
 
 
    virtual bool canEscape() const = 0;
 
    virtual bool requireAck() const = 0;
 
    virtual bool supportReply() const = 0;
 
    virtual bool isLocal() const = 0;
 
 
    virtual bool isPush() const = 0;
 
    virtual bool isConnectionless() const = 0;
 
 
    virtual bool isBroadcast() const = 0;
 
 
    virtual bool isActive() const = 0;
 
 
    virtual bool modifiesIncomingData() const = 0;
 
    virtual yarp::os::ConnectionReader& modifyIncomingData(yarp::os::ConnectionReader& reader) = 0;
 
    virtual bool acceptIncomingData(yarp::os::ConnectionReader& reader) = 0;
 
    virtual bool modifiesOutgoingData() const = 0;
 
    virtual const PortWriter& modifyOutgoingData(const PortWriter& writer) = 0;
 
    virtual bool acceptOutgoingData(const PortWriter& writer) = 0;
 
    virtual bool modifiesReply() const = 0;
 
    virtual PortReader& modifyReply(PortReader& reader) = 0;
 
    virtual void setCarrierParams(const yarp::os::Property& params) = 0;
 
    virtual void getCarrierParams(yarp::os::Property& params) const = 0;
 
    virtual void getHeader(yarp::os::Bytes& header) const = 0;
 
    virtual void prepareDisconnect() = 0;
 
    virtual std::string getName() const = 0;
};
 
} // namespace os
} // namespace yarp
 
 
#endif // YARP_OS_CONNECTION_H