summaryrefslogtreecommitdiff
path: root/cpp/src/qpid/ha/QueueReplicator.h
blob: 90f38ce7e1d13545c64e9d0d8121ce41aac3668c (plain)
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
#ifndef QPID_HA_QUEUEREPLICATOR_H
#define QPID_HA_QUEUEREPLICATOR_H

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */

#include "BrokerInfo.h"
#include "hash.h"
#include "qpid/broker/Exchange.h"
#include <boost/enable_shared_from_this.hpp>
#include <boost/function.hpp>
#include <iosfwd>

namespace qpid {

namespace broker {
class Bridge;
class Link;
class Queue;
class QueueRegistry;
class SessionHandler;
class Deliverable;
}

namespace ha {
class HaBroker;
class Settings;

/**
 * Exchange created on a backup broker to replicate a queue on the primary.
 *
 * Puts replicated messages on the local queue, handles dequeue events.
 * Creates a ReplicatingSubscription on the primary by passing special
 * arguments to the consume command.
 *
 * THREAD SAFE: Called in different connection threads.
 */
class QueueReplicator : public broker::Exchange,
                        public boost::enable_shared_from_this<QueueReplicator>
{
  public:
    static const std::string QPID_SYNC_FREQUENCY;
    static const std::string REPLICATOR_PREFIX;

    static std::string replicatorName(const std::string& queueName);
    static bool isReplicatorName(const std::string&);

    QueueReplicator(HaBroker&,
                    boost::shared_ptr<broker::Queue> q,
                    boost::shared_ptr<broker::Link> l);

    ~QueueReplicator();

    void activate();    // Must be called immediately after constructor.

    std::string getType() const;
    bool bind(boost::shared_ptr<broker::Queue
              >, const std::string&, const framing::FieldTable*);
    bool unbind(boost::shared_ptr<broker::Queue>, const std::string&, const framing::FieldTable*);
    void route(broker::Deliverable&);
    bool isBound(boost::shared_ptr<broker::Queue>, const std::string* const, const framing::FieldTable* const);

    // Set if the queue has ever been subscribed to, used for auto-delete cleanup.
    void setSubscribed() { subscribed = true; }
    bool isSubscribed() { return subscribed; }

    boost::shared_ptr<broker::Queue> getQueue() const { return queue; }

    ReplicationId getMaxId();

  protected:
    typedef boost::function<void(const std::string&, sys::Mutex::ScopedLock&)> DispatchFn;
    typedef qpid::sys::unordered_map<std::string, DispatchFn> DispatchMap;

    virtual void deliver(const broker::Message&);

    sys::Mutex lock;
    HaBroker& haBroker;
    const BrokerInfo brokerInfo;
    DispatchMap dispatch;

  private:
    typedef qpid::sys::unordered_map<
      ReplicationId, QueuePosition, TrivialHasher<int32_t> > PositionMap;
    class ErrorListener;
    class QueueObserver;

    void initializeBridge(broker::Bridge& bridge, broker::SessionHandler& sessionHandler);
    void destroy();             // Called when the queue is destroyed.

    // Dispatch functions
    void dequeueEvent(const std::string& data, sys::Mutex::ScopedLock&);
    void idEvent(const std::string& data, sys::Mutex::ScopedLock&);

    std::string logPrefix;
    std::string bridgeName;
    boost::shared_ptr<broker::Queue> queue;
    boost::shared_ptr<broker::Link> link;
    boost::shared_ptr<broker::Bridge> bridge;

    bool subscribed;
    const Settings& settings;
    bool destroyed;
    PositionMap positions;
    ReplicationIdSet idSet; // Set of replicationIds on the queue.
    ReplicationId nextId;   // ID for next message to arrive.
    ReplicationId maxId;    // Max ID used so far.
};


}} // namespace qpid::ha

#endif  /*!QPID_HA_QUEUEREPLICATOR_H*/