$darkmode

| Qore ConnectionProvider Module Reference 1.7.4

FilesystemConnection.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore FilesystemConnection class definition
3
4/* FilesystemConnection.qc Copyright 2016 - 2023 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23*/
24
26 namespace ConnectionProvider {
28
36 class FilesystemConnection : public AbstractConnectionWithInfo {
37
38 public:
40 const ConnectionScheme = <ConnectionSchemeInfo>{
41 "cls": Class::forName("FilesystemConnection"),
42 "options": {
43 "readonly": <ConnectionOptionInfo>{
44 "type": "bool",
45 "desc": "does not mark the connection as down if the directory is read only; use for example "
46 "if the connection should point to a read-only base directory; interface directories "
47 "should normally be writable",
48 "default_value": False,
49 },
50 },
51 };
52
54
64 constructor(string name, string description, string url, hash<auto> attributes = {}, hash<auto> options = {})
65 ;
66
67
69 string getType();
70
71
73
79 protected:
80 Dir getImpl(bool connect = True, *hash rtopts);
81 public:
82
83
85 protected:
86 hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
87 public:
88
89};
90}; // ConnectionProvider namespace
ConnectionProvider::AbstractConnection::url
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:44
ConnectionProvider::AbstractConnection::name
string name
connection name
Definition: AbstractConnection.qc.dox.h:38
ConnectionProvider::AbstractConnectionWithInfo
abstract base class for connections
Definition: AbstractConnectionWithInfo.qc.dox.h:32
ConnectionProvider::FilesystemConnection
class for filesystem connections; returns an object of type Qore::Dir
Definition: FilesystemConnection.qc.dox.h:36
ConnectionProvider::FilesystemConnection::constructor
constructor(string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
creates the FilesystemConnection object
ConnectionProvider::FilesystemConnection::ConnectionScheme
const ConnectionScheme
Connection entry info.
Definition: FilesystemConnection.qc.dox.h:40
ConnectionProvider::FilesystemConnection::getType
string getType()
returns "dir"
ConnectionProvider::FilesystemConnection::getConnectionSchemeInfoImpl
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
ConnectionProvider::FilesystemConnection::getImpl
Dir getImpl(bool connect=True, *hash rtopts)
returns a Qore::Dir object
True
const True
False
const False
hash
hash< auto > hash(object obj)
ConnectionProvider
The ConnectionProvider namespace.
Definition: AbstractConnection.qc.dox.h:28
ConnectionProvider::ConnectionOptionInfo
Connection option information.
Definition: ConnectionSchemeCache.qc.dox.h:38
ConnectionProvider::ConnectionSchemeInfo
Connection provider information.
Definition: ConnectionSchemeCache.qc.dox.h:59