aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/libpqxx/include/pqxx/basic_connection.hxx
blob: 6e7372195ae19bdd8e75f9b5baf2505b68b9d175 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/** Definition of the pqxx::basic_connection class template.
 *
 * Instantiations of basic_connection bring connections and policies together.
 *
 * DO NOT INCLUDE THIS FILE DIRECTLY; include pqxx/basic_connection instead.
 *
 * Copyright (c) 2000-2019, Jeroen T. Vermeulen.
 *
 * See COPYING for copyright license.  If you did not receive a file called
 * COPYING with this source code, please notify the distributor of this mistake,
 * or contact the author.
 */
#ifndef PQXX_H_BASIC_CONNECTION
#define PQXX_H_BASIC_CONNECTION

#include "pqxx/compiler-public.hxx"
#include "pqxx/compiler-internal-pre.hxx"

#include <cstddef>
#include <memory>
#include <string>

#include "pqxx/connection_base.hxx"


namespace pqxx
{

/// Base-class template for all libpqxx connection types.
/** @deprecated In libpqxx 7, all built-in connection types will be implemented
 * as a single class.  You'll specify the connection policy as an optional
 * constructor argument.
 *
 * Combines connection_base (the highly complex class implementing essentially
 * all connection-related functionality) with a connection policy (a simpler
 * helper class determining the rules that govern the process of setting up the
 * underlying connection to the backend).
 *
 * The pattern used to combine these classes is the same as for
 * basic_transaction.  Through use of the template mechanism, the policy object
 * is embedded in the basic_connection object so that it does not need to be
 * allocated separately.  This also avoids the need for virtual functions in
 * this class.
 */
template<typename CONNECTPOLICY> class basic_connection_base :
  public connection_base
{
public:
  basic_connection_base() :
    connection_base(m_policy),
    m_options(std::string{}),
    m_policy(m_options)
	{ init(); }

  /// The parsing of options is the same as libpq's PQconnect.
  /// See: https://www.postgresql.org/docs/10/static/libpq-connect.html
  explicit basic_connection_base(const std::string &opt) :
    connection_base(m_policy),
    m_options(opt),
    m_policy(m_options)
	{init();}

  /// See: @c basic_connection(const std::string &opt)
  explicit basic_connection_base(const char opt[]) :
    basic_connection_base(opt ? std::string{opt} : std::string{}) {}

  explicit basic_connection_base(std::nullptr_t) : basic_connection_base() {}

  ~basic_connection_base() noexcept
	{ close(); }

  const std::string &options() const noexcept				//[t01]
	{return m_policy.options();}

private:
  /// Connect string.  @warn Must be initialized before the connector!
  std::string m_options;
  /// Connection policy.  @warn Must be initialized after the connect string!
  CONNECTPOLICY m_policy;
};


/// Concrete connection type template.
/** @deprecated In libpqxx 7, all built-in connection types will be implemented
 * as a single class.  You'll specify the connection policy as an optional
 * constructor argument.
 */
template<typename CONNECTPOLICY> struct basic_connection :
	basic_connection_base<CONNECTPOLICY>
{
  PQXX_DEPRECATED basic_connection() =default;
  PQXX_DEPRECATED explicit basic_connection(const std::string &opt) :
	basic_connection(opt) {}
  PQXX_DEPRECATED explicit basic_connection(const char opt[]) :
	basic_connection(opt) {}

  PQXX_DEPRECATED explicit basic_connection(std::nullptr_t) :
	basic_connection() {}

  using basic_connection_base<CONNECTPOLICY>::options;
};

} // namespace

#include "pqxx/compiler-internal-post.hxx"

#endif