[go: up one dir, main page]

File: callbacks.h

package info (click to toggle)
soci 4.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 17,944 kB
  • sloc: ansic: 169,887; cpp: 54,198; javascript: 12,258; ada: 1,973; sh: 36; makefile: 12; xml: 2
file content (51 lines) | stat: -rw-r--r-- 1,562 bytes parent folder | download
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
//
// Copyright (C) 2015 Maciej Sobczak
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// https://www.boost.org/LICENSE_1_0.txt)
//

#ifndef SOCI_CALLBACKS_H_INCLUDED
#define SOCI_CALLBACKS_H_INCLUDED

#include <string>

namespace soci
{

class session;

// Simple callback interface for reporting failover events.
// The meaning of each operation is intended to be portable,
// but the behaviour details and parameters can be backend-specific.
class failover_callback
{
public:
    failover_callback() = default;
    virtual ~failover_callback() = default;

    // Called when the failover operation has started,
    // after discovering connectivity problems.
    virtual void started() {}

    // Called after successful failover and creating a new connection;
    // the sql parameter denotes the new connection and allows the user
    // to replay any initial sequence of commands (like session configuration).
    virtual void finished(session& /* sql */) {}

    // Called when the attempt to reconnect failed,
    // if the user code sets the retry parameter to true,
    // then new connection will be attempted;
    // the newTarget connection string is a hint that can be ignored
    // by external means.
    virtual void failed(bool& /* out */ /* retry */,
        std::string& /* out */ /* newTarget */) {}

    // Called when there was a failure that prevents further failover attempts.
    virtual void aborted() {}
};

} // namespace soci

#endif // SOCI_CALLBACKS_H_INCLUDED