Qore ConnectionProvider Module Reference  1.4
FilesystemConnection.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore FilesystemConnection class definition
3 
4 /* FilesystemConnection.qc Copyright 2016 - 2020 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 
36 
37 public:
39  const ConnectionScheme = ...;
40 
41 
43 
53  constructor(string name, string description, string url, hash attributes = {}, hash options = {})
54  ;
55 
56 
58  string getType();
59 
60 
62 
68 protected:
69  Dir getImpl(bool connect = True, *hash rtopts);
70 public:
71 
72 
74 protected:
75  hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
76 public:
77 
78 };
79 }; // ConnectionProvider namespace
ConnectionProvider
the ConnectionProvider namespace. All classes used in the ConnectionProvider module should be inside ...
Definition: AbstractConnection.qc.dox.h:26
ConnectionProvider::AbstractConnection::name
string name
connection name
Definition: AbstractConnection.qc.dox.h:36
ConnectionProvider::FilesystemConnection::constructor
constructor(string name, string description, string url, hash attributes={}, hash options={})
creates the FilesystemConnection object
True
const True
ConnectionProvider::FilesystemConnection::getConnectionSchemeInfoImpl
hash< ConnectionSchemeInfo > getConnectionSchemeInfoImpl()
Returns the ConnectionSchemeInfo hash for this object.
ConnectionProvider::AbstractConnectionWithInfo
abstract base class for connections
Definition: AbstractConnectionWithInfo.qc.dox.h:30
ConnectionProvider::FilesystemConnection::ConnectionScheme
const ConnectionScheme
Connection entry info.
Definition: FilesystemConnection.qc.dox.h:39
ConnectionProvider::FilesystemConnection
class for filesystem connections; returns an object of type Qore::Dir
Definition: FilesystemConnection.qc.dox.h:35
hash
hash< auto > hash(object obj)
ConnectionProvider::AbstractConnection::url
string url
connection URL (potentially with password info)
Definition: AbstractConnection.qc.dox.h:42
ConnectionProvider::FilesystemConnection::getType
string getType()
returns "dir"
ConnectionProvider::FilesystemConnection::getImpl
Dir getImpl(bool connect=True, *hash rtopts)
returns a Qore::Dir object