FileHandle.cci

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
//


/** \file
    \brief FileHandle inline non-template implementation
 */

//#include "FileHandle.ih"

// Custom includes
#include <senf/Utils/senfassert.hh>

#define prefix_ inline
//-/////////////////////////////////////////////////////////////////////////////////////////////////

prefix_ void * senf::FileHandleAccess::extraPtr(FileHandle const & fh)
{
    return fh.extraPtr();
}

prefix_ void senf::FileHandleAccess::extraPtr(FileHandle fh, void * ptr)
{
    fh.extraPtr(ptr);
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::FileBody

prefix_ senf::FileBody::FileBody(int fd)
    : fd_(fd), extraPtr_(nullptr)
{}

prefix_ senf::FileHandle senf::FileBody::handle()
{
    return FileHandle(ptr(this));
}

prefix_ int senf::FileBody::fd()
    const
{
    return fd_;
}

prefix_ void senf::FileBody::fd(int fd)
{
    fd_ = fd;
}

prefix_ void * senf::FileBody::extraPtr()
    const
{
    return extraPtr_;
}

prefix_ void senf::FileBody::extraPtr(void * ptr)
{
    extraPtr_ = ptr;
}

prefix_ bool senf::FileBody::eof()
    const
{
    return v_eof();
}

prefix_ bool senf::FileBody::valid()
    const
{
    return fd_!=-1 && v_valid();
}

prefix_ bool senf::FileBody::readable()
    const
{
    return pollCheck(fd(),true,0);
}

prefix_ bool senf::FileBody::waitReadable(senf::ClockService::clock_type timeout)
    const
{
    return pollCheck(fd(), true,
                     (timeout==senf::ClockService::clock_type(-1)?-1:senf::ClockService::in_milliseconds(timeout)) );
}

prefix_ bool senf::FileBody::writeable()
    const
{
    return pollCheck(fd(),false,0);
}

prefix_ bool senf::FileBody::waitWriteable(senf::ClockService::clock_type timeout)
    const
{
    return pollCheck(fd(), false,
                     (timeout==senf::ClockService::clock_type(-1)?-1:senf::ClockService::in_milliseconds(timeout)) );
}

prefix_ bool senf::FileBody::oobReadable()
    const
{
    return pollCheck(fd(),true,0,true);
}

prefix_ bool senf::FileBody::waitOOBReadable(senf::ClockService::clock_type timeout)
    const
{
    return pollCheck(fd(), true,
                     (timeout==senf::ClockService::clock_type(-1)?-1:senf::ClockService::in_milliseconds(timeout)), true);
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::FileHandle

prefix_ senf::FileBody & senf::FileHandle::body()
{
    SENF_ASSERT(body_, "dereferencing in-valid() FileHandle");
    return *body_;
}

prefix_ senf::FileBody const & senf::FileHandle::body()
    const
{
    SENF_ASSERT(body_, "dereferencing in-valid() FileHandle");
    return *body_;
}

prefix_ void senf::FileHandle::close()
{
    body().close();
}

prefix_ void senf::FileHandle::terminate()
{
    body().terminate();
}

prefix_ bool senf::FileHandle::readable()
    const
{
    return body().readable();
}

prefix_ bool senf::FileHandle::waitReadable(senf::ClockService::clock_type timeout)
    const
{
    return body().waitReadable(timeout);
}

prefix_ bool senf::FileHandle::writeable()
    const
{
    return body().writeable();
}

prefix_ bool senf::FileHandle::waitWriteable(senf::ClockService::clock_type timeout)
    const
{
    return body().waitWriteable(timeout);
}

prefix_ bool senf::FileHandle::oobReadable()
    const
{
    return body().oobReadable();
}

prefix_ bool senf::FileHandle::waitOOBReadable(senf::ClockService::clock_type timeout)
    const
{
    return body().waitOOBReadable(timeout);
}

prefix_ bool senf::FileHandle::blocking()
    const
{
    return body().blocking();
}

prefix_ void senf::FileHandle::blocking(bool status)
{
    body().blocking(status);
}

prefix_ bool senf::FileHandle::eof()
    const
{
    return body().eof();
}

prefix_ bool senf::FileHandle::valid()
    const
{
    return body_ && body().valid();
}

prefix_ bool senf::FileHandle::boolean_test()
    const
{
    return valid() && !eof();
}

prefix_ int senf::FileHandle::fd()
    const
{
    return body().fd();
}

prefix_ int senf::FileHandle::refcount()
    const
{
    return valid() ? body().refcount() : 0;
}

prefix_ bool senf::FileHandle::is_shared()
    const
{
    return valid() ? body().is_shared() : false;
}

prefix_ senf::FileHandle::FileHandle()
    : body_(nullptr)
{}

prefix_ senf::FileHandle::~FileHandle()
{
    if (body_ && ! body().is_shared())
        body().destroyClose();
}

prefix_  senf::FileHandle::FileHandle(std::unique_ptr<FileBody> body)
    : body_(body.release())
{}

prefix_ senf::FileHandle::FileHandle(FileBody::ptr body)
    : body_(body)
{}

prefix_ senf::FileBody & senf::FileHandle::body(FileHandle & handle)
{
    return handle.body();
}

prefix_ senf::FileBody const & senf::FileHandle::body(FileHandle const & handle)
{
    return handle.body();
}

prefix_ void senf::FileHandle::fd(int fd)
{
    body().fd(fd);
}

prefix_ void * senf::FileHandle::extraPtr()
    const
{
    return body().extraPtr();
}

prefix_ void senf::FileHandle::extraPtr(void * ptr)
{
    body().extraPtr(ptr);
}

prefix_ senf::FileHandle senf::FileHandle::cast_static(FileHandle handle)
{
    return handle;
}

prefix_ senf::FileHandle senf::FileHandle::cast_dynamic(FileHandle handle)
{
    return handle;
}

prefix_ int senf::retrieve_filehandle(FileHandle handle)
{
    return handle.fd();
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#undef prefix_


// 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: