FileHandle.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Socket_FileHandle_
#define HH_SENF_Socket_FileHandle_ 1

// Custom includes
#include <senf/Utils/Cpp11Support/smart_ptr.hh>
#include <senf/Utils/safe_bool.hh>
#include <senf/Scheduler/ClockService.hh>

//#include "FileHandle.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "FileHandle.ih"

namespace senf {

    class FileHandleAccess
    {
    protected:
        static void * extraPtr(FileHandle const & fh);
        static void extraPtr(FileHandle fh, void * ptr);
    };

    //\{

    class FileHandle
        : public safe_bool<FileHandle>
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        //-////////////////////////////////////////////////////////////////////////
        //\{

        FileHandle();
        ~FileHandle();

        // my default constructor
        // default copy constructor
        // default copy assignment
        // default destructor

        // no conversion constructors

        //\}
        //-////////////////////////////////////////////////////////////////////////

        void close();                

        void terminate();            

        bool readable() const;       
        bool waitReadable(senf::ClockService::clock_type timeout = senf::ClockService::clock_type(-1)) const;

        bool writeable() const;      
        bool waitWriteable(senf::ClockService::clock_type timeout = senf::ClockService::clock_type(-1)) const;

        bool oobReadable() const;    
        bool waitOOBReadable(senf::ClockService::clock_type timeout = senf::ClockService::clock_type(-1)) const;

        bool blocking() const;       
        void blocking(bool status);  

        bool eof() const;            

        bool valid() const;          

        bool boolean_test() const;  

        int fd() const;             

        int refcount() const;
        bool is_shared() const;

        static FileHandle cast_static(FileHandle handle);  
        static FileHandle cast_dynamic(FileHandle handle); 
    protected:
        explicit FileHandle(std::unique_ptr<FileBody> body);

        explicit FileHandle(FileBody::ptr body);

        FileBody & body();          
        FileBody const & body() const; 
        static FileBody & body(FileHandle & handle); 
        static FileBody const & body(FileHandle const & handle); 

        void fd(int fd);            

        void * extraPtr() const;    
        void extraPtr(void * ptr);  

    private:
        FileBody::ptr body_;

        friend class FileBody;
        friend class FileHandleAccess;
    };

    int retrieve_filehandle(FileHandle handle);

    //\}

}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "FileHandle.cci"
//#include "FileHandle.ct"
//#include "FileHandle.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// comment-column: 40
// End: