Big-Data-HPC-Platform/esp/clients/ws_dfsclient/ws_dfsclient.hpp

/*##############################################################################

    HPCC SYSTEMS software Copyright (C) 2022 HPCC Systems®.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
############################################################################## */

#ifndef _WS_DFSCLIENT_HPP
#define _WS_DFSCLIENT_HPP

#ifndef WS_DFSCLIENT_API

#ifdef WS_DFSCLIENT_EXPORTS
#define WS_DFSCLIENT_API DECL_EXPORT
#else
#define WS_DFSCLIENT_API DECL_IMPORT
#endif

#endif

namespace wsdfs
{

static constexpr unsigned keepAliveExpiryFrequency = 30; // may want to make configurable at some point

interface IDFSFile : extends IInterface
{
    virtual IPropertyTree *queryFileMeta() const = 0;
    virtual IPropertyTree *queryCommonMeta() const = 0;
    virtual unsigned __int64 getLockId() const = 0;
    virtual unsigned numSubFiles() const = 0; // >0 implies this is a superfile
    virtual IDFSFile *getSubFile(unsigned idx) const = 0;

// there are here in case a client wants to use them to lookup a related file (e.g. subfiles of a super)
    virtual const char *queryRemoteName() const = 0;
    virtual IUserDescriptor *queryUserDescriptor() const = 0;
    virtual unsigned queryTimeoutSecs() const = 0;
};

WS_DFSCLIENT_API IDFSFile *lookupDFSFile(const char *logicalName, unsigned timeoutSecs, unsigned keepAliveExpiryFrequency, IUserDescriptor *userDesc);
WS_DFSCLIENT_API IDistributedFile *createLegacyDFSFile(IDFSFile *dfsFile);
WS_DFSCLIENT_API IDistributedFile *lookupLegacyDFSFile(const char *logicalName, unsigned timeoutSecs, unsigned keepAliveExpiryFrequency, IUserDescriptor *userDesc);

} // end of namespace wsdfs

#endif // _WS_DFSCLIENT_HPP