XrdClS3::File Class Reference

#include <XrdClS3File.hh>

Inheritance diagram for XrdClS3::File:

Collaboration diagram for XrdClS3::File:

Public Member Functions
	File (XrdCl::Log *log)
virtual	~File () noexcept
virtual XrdCl::XRootDStatus	Close (XrdCl::ResponseHandler *handler, time_t timeout) override
virtual bool	GetProperty (const std::string &name, std::string &value) const override
virtual bool	IsOpen () const override
virtual XrdCl::XRootDStatus	Open (const std::string &url, XrdCl::OpenFlags::Flags flags, XrdCl::Access::Mode mode, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	PgRead (uint64_t offset, uint32_t size, void *buffer, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	Read (uint64_t offset, uint32_t size, void *buffer, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual bool	SetProperty (const std::string &name, const std::string &value) override
virtual XrdCl::XRootDStatus	Stat (bool force, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	VectorRead (const XrdCl::ChunkList &chunks, void *buffer, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	Write (uint64_t offset, uint32_t size, const void *buffer, XrdCl::ResponseHandler *handler, time_t timeout) override
virtual XrdCl::XRootDStatus	Write (uint64_t offset, XrdCl::Buffer &&buffer, XrdCl::ResponseHandler *handler, time_t timeout) override
Public Member Functions inherited from XrdCl::FilePlugIn
virtual	~FilePlugIn ()
	Destructor.
virtual XRootDStatus	Clone (const CloneLocations &locs, ResponseHandler *handler, time_t timeout)
virtual std::unique_ptr< ExportedFileTemplate >	ExportTemplate () const
virtual XRootDStatus	Fcntl (const Buffer &arg, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Fcntl (QueryCode::Code queryCode, const Buffer &arg, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	OpenUsingTemplate (ExportedFileTemplate *templ, const std::string &url, OpenFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	PgWrite (uint64_t offset, uint32_t nbpgs, const void *buffer, std::vector< uint32_t > &cksums, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	PreRead (const TractList &tracts, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Read (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus	Sync (ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Truncate (uint64_t size, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	VectorWrite (const ChunkList &chunks, ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus	Visa (ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Write (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus	WriteV (uint64_t offset, const struct iovec *iov, int iovcnt, ResponseHandler *handler, time_t timeout=0)

Detailed Description

Definition at line 36 of file XrdClS3File.hh.

Constructor & Destructor Documentation

File()

File::File

(

XrdCl::Log *

log

)

Definition at line 86 of file XrdClS3File.cc.

                        :
        m_logger(log),
        m_wrapped_file()
{
}

References File().

Referenced by File().

Here is the call graph for this function:

Here is the caller graph for this function:

~File()

File::~File ( )

virtualnoexcept

Definition at line 92 of file XrdClS3File.cc.

{}

Member Function Documentation

Close()

XrdCl::XRootDStatus File::Close ( XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::File::Close

Reimplemented from XrdCl::FilePlugIn.

Definition at line 95 of file XrdClS3File.cc.

{
    return m_wrapped_file->Close(new CloseResponseHandler(&m_is_opened, handler), timeout);
}

GetProperty()

bool File::GetProperty ( const std::string & name, std::string & value ) const

overridevirtual

See also

XrdCl::File::GetProperty

Reimplemented from XrdCl::FilePlugIn.

Definition at line 108 of file XrdClS3File.cc.

{
    std::unique_lock lock(m_properties_mutex);
    const auto p = m_properties.find(name);
    if (p == std::end(m_properties)) {
        return false;
    }
 
    value = p->second;
    return true;
}

IsOpen()

bool File::IsOpen ( ) const

overridevirtual

See also

XrdCl::File::IsOpen

Reimplemented from XrdCl::FilePlugIn.

Definition at line 102 of file XrdClS3File.cc.

{
    return m_is_opened;
}

Referenced by Open().

Here is the caller graph for this function:

Open()

XrdCl::XRootDStatus File::Open ( const std::string & url, XrdCl::OpenFlags::Flags flags, XrdCl::Access::Mode mode, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::File::Open

Reimplemented from XrdCl::FilePlugIn.

Definition at line 165 of file XrdClS3File.cc.

{
    if (IsOpen()) {
        m_logger->Error(kLogXrdClS3, "URL %s already open", url.c_str());
        return XrdCl::XRootDStatus(XrdCl::stError, XrdCl::errInvalidOp);
    }
 
    if (flags & (XrdCl::OpenFlags::Write | XrdCl::OpenFlags::Update |
                 XrdCl::OpenFlags::Delete | XrdCl::OpenFlags::New)) {
        std::string https_url, obj, err_msg;
        if (!Factory::GenerateHttpUrl(url, https_url, &obj, err_msg)) {
            return XrdCl::XRootDStatus(XrdCl::stError, XrdCl::errInvalidAddr, 0, err_msg);
        }
        auto query = obj.find('?');
        if (query != std::string::npos) {
            obj.erase(query);
        }
        if (obj.empty() || obj.back() == '/') {
            m_logger->Error(kLogXrdClS3, "Cannot open a directory: %s", url.c_str());
            return XrdCl::XRootDStatus(XrdCl::stError, XrdCl::errErrorResponse, kXR_isDirectory, "Cannot open a directory");
        }
    }
 
    auto [st, https_url, fs] = GetFileHandle(url);
    if (!st.IsOK()) {
        return st;
    }
 
    return fs->Open(https_url, flags, mode, new OpenResponseHandler(&m_is_opened, handler), timeout);
}

References XrdCl::OpenFlags::Delete, XrdCl::errErrorResponse, XrdCl::errInvalidAddr, XrdCl::errInvalidOp, XrdClS3::Factory::GenerateHttpUrl(), IsOpen(), XrdClS3::kLogXrdClS3, kXR_isDirectory, XrdCl::OpenFlags::New, XrdCl::stError, XrdCl::OpenFlags::Update, and XrdCl::OpenFlags::Write.

Here is the call graph for this function:

PgRead()

XrdCl::XRootDStatus File::PgRead ( uint64_t offset, uint32_t size, void * buffer, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl:File PgRead

Reimplemented from XrdCl::FilePlugIn.

Definition at line 201 of file XrdClS3File.cc.

{
    return m_wrapped_file->PgRead(offset, size, buffer, handler, timeout);
}

Read()

XrdCl::XRootDStatus File::Read ( uint64_t offset, uint32_t size, void * buffer, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::File::Read

Reimplemented from XrdCl::FilePlugIn.

Definition at line 211 of file XrdClS3File.cc.

{
 
    return m_wrapped_file->Read(offset, size, buffer, handler, timeout);
}

SetProperty()

bool File::SetProperty ( const std::string & name, const std::string & value )

overridevirtual

See also

XrdCl::File::SetProperty

Reimplemented from XrdCl::FilePlugIn.

Definition at line 222 of file XrdClS3File.cc.

{
    std::unique_lock lock(m_properties_mutex);
    m_properties[name] = value;
    return true;
}

Stat()

XrdCl::XRootDStatus File::Stat ( bool force, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::File::Stat

Reimplemented from XrdCl::FilePlugIn.

Definition at line 231 of file XrdClS3File.cc.

{
    return m_wrapped_file->Stat(force, handler, timeout);
}

VectorRead()

XrdCl::XRootDStatus File::VectorRead ( const XrdCl::ChunkList & chunks, void * buffer, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::File::VectorRead

Reimplemented from XrdCl::FilePlugIn.

Definition at line 239 of file XrdClS3File.cc.

{
    return m_wrapped_file->VectorRead(chunks, buffer, handler, timeout);
}

Write() [1/2]

XrdCl::XRootDStatus File::Write ( uint64_t offset, uint32_t size, const void * buffer, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::File::Write

Reimplemented from XrdCl::FilePlugIn.

Definition at line 248 of file XrdClS3File.cc.

{
    return m_wrapped_file->Write(offset, size, buffer, handler, timeout);
}

Write() [2/2]

XrdCl::XRootDStatus File::Write ( uint64_t offset, XrdCl::Buffer && buffer, XrdCl::ResponseHandler * handler, time_t timeout )

overridevirtual

See also

XrdCl::File::Write

Reimplemented from XrdCl::FilePlugIn.

Definition at line 258 of file XrdClS3File.cc.

{
    return m_wrapped_file->Write(offset, std::move(buffer), handler, timeout);
}

---

The documentation for this class was generated from the following files:

• XrdClS3File.hh
• XrdClS3File.cc