Qore ConnectionProvider Module Reference  1.3
FilesystemConnection.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore FilesystemConnection class definition
3 
4 /* FilesystemConnection.qc Copyright 2016 - 2019 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 
25 
27 namespace ConnectionProvider {
29 
33 
34 public:
36  const Options = {
37  "readonly": True,
38  };
39 
41  const OptionList = Options.keys();
42 
44 
53  deprecated
54  constructor(string name, string desc, string url, bool monitor, *hash opts, hash n_urlh)
55  ;
56 
57 
59 
67  constructor(string name, string description, string url, hash attributes = {}, hash options = {})
68  ;
69 
70 
71 private:
72  constructorInit();
73 public:
74 
75 
77  string getType();
78 
79 
81 
86 protected:
87  Dir getImpl(bool connect = True, *hash rtopts);
88 public:
89 
90 
92 
95  hash getOptions();
96 
97 
99 
101  deprecated
102  static FilesystemConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh);
103  };
104 }; // ConnectionProvider namespace
bool monitor
monitoring flag
Definition: AbstractConnection.qc.dox.h:65
static deprecated FilesystemConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh)
DEPRECATED: static constructor.
class for filesystem connections; returns an object of type Qore::Dir; this can be used to monitor fi...
Definition: FilesystemConnection.qc.dox.h:32
const Options
FilesystemConnection object connection options.
Definition: FilesystemConnection.qc.dox.h:36
const True
string name
connection name
Definition: AbstractConnection.qc.dox.h:35
hash< auto > urlh
broken down URL hash (as returned by Qore::parse_url())
Definition: AbstractConnection.qc.dox.h:53
Dir getImpl(bool connect=True, *hash rtopts)
returns a Qore::Dir object
*hash< auto > opts
connection options
Definition: AbstractConnection.qc.dox.h:50
const OptionList
FilesystemConnection object connection option list.
Definition: FilesystemConnection.qc.dox.h:41
abstract base class for connections
Definition: AbstractConnection.qc.dox.h:31
string desc
connection description
Definition: AbstractConnection.qc.dox.h:38
deprecated constructor(string name, string desc, string url, bool monitor, *hash opts, hash n_urlh)
DEPRECATED: creates the FilesystemConnection object.
hash< auto > hash(object obj)
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:41
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:27