Loading...
Searching...
No Matches
HttpBasedConnection.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore HttpBasedConnection class definition
/* HttpBasedConnection.qc Copyright 2016 - 2023 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 HttpBasedConnection : public AbstractConnectionWithInfo {
public:
string real_url;
constructor(string name, string desc, string url, hash<auto> attributes, hash<auto> options) ;
bool supportsPollingApi();
Qore::AbstractPollOperation startPollConnect();
};
}; // ConnectionProvider namespace
ConnectionProvider::AbstractConnection::desc
string desc
connection description
Definition: AbstractConnection.qc.dox.h:41
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::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::supportsPollingApi
bool supportsPollingApi()
returns True, since this connection type supports the Qore Socket-based polling API
ConnectionProvider::HttpBasedConnection::startPollConnect
Qore::AbstractPollOperation startPollConnect()
Called to start the connection if the connection supports the polling API.
ConnectionProvider::HttpBasedConnection::real_url
string real_url
A string containing the real URL using a http/https scheme.
Definition: HttpBasedConnection.qc.dox.h:36
ConnectionProvider::HttpBasedConnection::constructor
constructor(string name, string desc, string url, hash< auto > attributes, hash< auto > options)
Creates the connection object.
Qore::AbstractPollOperation
ConnectionProvider
The ConnectionProvider namespace.
Definition: AbstractConnection.qc.dox.h:28