ArnPipe.hpp

Go to the documentation of this file.

// Copyright (C) 2010-2022 Michael Wiklund.
// All rights reserved.
// Contact: arnlib@wiklunden.se
//
// This file is part of the ArnLib - Active Registry Network.
// Parts of ArnLib depend on Qt and/or other libraries that have their own
// licenses. Usage of these other libraries is subject to their respective
// license agreements.
//
// GNU Lesser General Public License Usage
// This file may be used under the terms of the GNU Lesser General Public
// License version 2.1 as published by the Free Software Foundation and
// appearing in the file LICENSE_LGPL.txt included in the packaging of this
// file. In addition, as a special exception, you may use the rights described
// in the Nokia Qt LGPL Exception version 1.1, included in the file
// LGPL_EXCEPTION.txt in this package.
//
// GNU General Public License Usage
// Alternatively, this file may be used under the terms of the GNU General Public
// License version 3.0 as published by the Free Software Foundation and appearing
// in the file LICENSE_GPL.txt included in the packaging of this file.
//
// Other Usage
// Alternatively, this file may be used in accordance with the terms and conditions
// contained in a signed written agreement between you and Michael Wiklund.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
// PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
//

#ifndef ARNPIPE_HPP
#define ARNPIPE_HPP

#include "ArnLib_global.hpp"
#include "ArnItemB.hpp"
#include "ArnCompat.hpp"

class ArnPipePrivate;



class ARNLIBSHARED_EXPORT ArnPipe : public ArnItemB
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(ArnPipe)

public:

    ArnPipe( QObject* parent = arnNullptr);


    ArnPipe( const QString& path, QObject* parent = arnNullptr);

    virtual  ~ArnPipe();


    bool  openUuid( const QString& path)
    {return ArnItemB::openUuidPipe( path);}


    ArnPipe&  setMaster()
    {ArnItemB::setMaster(); return *this;}

    bool  isMaster()  const
    {return ArnItemB::isMaster();}


    ArnPipe&  setAutoDestroy()
    {ArnItemB::setAutoDestroy(); return *this;}

    bool  isAutoDestroy()  const
    {return ArnItemB::isAutoDestroy();}

    ArnPipe&  operator=( const QByteArray& value);


    void  setValueOverwrite( const QByteArray& value, const ARN_RegExp& rx);


    bool  isSendSeq()  const;


    void  setSendSeq( bool useSendSeq);


    bool  isCheckSeq()  const;


    void  setCheckSeq( bool useCheckSeq);

public slots:

    void  setValue( const QByteArray& value);

signals:

    void  changed( const QByteArray& value);


    void  outOfSequence();

protected:
    virtual void  itemUpdated( const ArnLinkHandle& handleData, const QByteArray* value = arnNullptr);

    ArnPipe( ArnPipePrivate& dd, QObject* parent);

private slots:

private:
    void  init();
    void  setupSeq( ArnLinkHandle& handleData);
};

#endif // ARNPIPE_HPP