FilesystemConnection.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore FilesystemConnection class definition
/* FilesystemConnection.qc Copyright 2016 - 2019 Qore Technologies, s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
namespace ConnectionProvider {
class FilesystemConnection : public AbstractConnection {
public:
const Options = {
"readonly": True,
};
const OptionList = Options.keys();
deprecated
constructor(string name, string desc, string url, bool monitor, *hash opts, hash n_urlh)
;
constructor(string name, string description, string url, hash attributes = {}, hash options = {})
;
private:
constructorInit();
public:
string getType();
protected:
Dir getImpl(bool connect = True, *hash rtopts);
public:
hash getOptions();
deprecated
static FilesystemConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh);
};
}; // ConnectionProvider namespace
ConnectionProvider
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:27
ConnectionProvider::AbstractConnection
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:31
ConnectionProvider::AbstractConnection::name
string name
connection name
Definition: AbstractConnection.qc.dox.h:35
ConnectionProvider::FilesystemConnection::constructor
deprecated constructor(string name, string desc, string url, bool monitor, *hash opts, hash n_urlh)
DEPRECATED: creates the FilesystemConnection object.
ConnectionProvider::AbstractConnection::desc
string desc
connection description
Definition: AbstractConnection.qc.dox.h:38
True
const True
ConnectionProvider::AbstractConnection::opts
*hash< auto > opts
connection options
Definition: AbstractConnection.qc.dox.h:50
ConnectionProvider::FilesystemConnection::getOptions
hash getOptions()
gets options
ConnectionProvider::FilesystemConnection
class for filesystem connections; returns an object of type Qore::Dir; this can be used to monitor fi...
Definition: FilesystemConnection.qc.dox.h:32
ConnectionProvider::AbstractConnection::urlh
hash< auto > urlh
broken down URL hash (as returned by Qore::parse_url())
Definition: AbstractConnection.qc.dox.h:53
ConnectionProvider::FilesystemConnection::make
static deprecated FilesystemConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh)
DEPRECATED: static constructor.
ConnectionProvider::FilesystemConnection::Options
const Options
FilesystemConnection object connection options.
Definition: FilesystemConnection.qc.dox.h:36
hash
hash< auto > hash(object obj)
ConnectionProvider::AbstractConnection::url
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:41
ConnectionProvider::FilesystemConnection::getType
string getType()
returns "dir"
ConnectionProvider::FilesystemConnection::getImpl
Dir getImpl(bool connect=True, *hash rtopts)
returns a Qore::Dir object
ConnectionProvider::AbstractConnection::monitor
bool monitor
monitoring flag
Definition: AbstractConnection.qc.dox.h:65
ConnectionProvider::FilesystemConnection::OptionList
const OptionList
FilesystemConnection object connection option list.
Definition: FilesystemConnection.qc.dox.h:41