| Qore ConnectionProvider Module Reference 2.0.1

Loading...
Searching...
No Matches
HttpBasedConnection.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
2// Qore HttpBasedConnection class definition
3
4/* HttpBasedConnection.qc Copyright 2016 - 2024 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
28 namespace ConnectionProvider {
30
32 class HttpBasedConnection : public AbstractConnectionWithInfo {
33
34 public:
36
46 constructor(string name, string desc, string url, hash<auto> attributes, hash<auto> options, *Logger logger) ;
47
48
50
67 constructor(hash<auto> config, *hash<auto> attr) ;
68
69
71
75 bool supportsPollingApi();
76
77
79
86 Qore::AbstractPollOperation startPollConnect(*Logger::LoggerInterface logger);
87
88
90
94 protected:
95 setRealUrl(*string url);
96 public:
97
98};
99}; // ConnectionProvider namespace
ConnectionProvider::AbstractConnection::desc
string desc
Connection description with markdown formatting.
Definition AbstractConnection.qc.dox.h:82
ConnectionProvider::AbstractConnection::url
string url
Connection URL (potentially with password info)
Definition AbstractConnection.qc.dox.h:85
ConnectionProvider::AbstractConnection::name
string name
Connection name.
Definition AbstractConnection.qc.dox.h:73
ConnectionProvider::AbstractConnectionWithInfo
abstract base class for connections
Definition AbstractConnectionWithInfo.qc.dox.h:32
ConnectionProvider::HttpBasedConnection
base class for HTTP-based connections that need their URLs rewritten to create the real connection ob...
Definition HttpBasedConnection.qc.dox.h:32
ConnectionProvider::HttpBasedConnection::setRealUrl
setRealUrl(*string url)
Called by the constructor to set the real URL.
ConnectionProvider::HttpBasedConnection::startPollConnect
Qore::AbstractPollOperation startPollConnect(*Logger::LoggerInterface logger)
Called to start the connection if the connection supports the polling API.
ConnectionProvider::HttpBasedConnection::constructor
constructor(string name, string desc, string url, hash< auto > attributes, hash< auto > options, *Logger logger)
Creates the connection object.
ConnectionProvider::HttpBasedConnection::supportsPollingApi
bool supportsPollingApi()
returns True, since this connection type supports the Qore Socket-based polling API
ConnectionProvider::HttpBasedConnection::constructor
constructor(hash< auto > config, *hash< auto > attr)
Creates the connection object.
Qore::AbstractPollOperation
ConnectionProvider
The ConnectionProvider namespace.
Definition AbstractConnection.qc.dox.h:28