summaryrefslogtreecommitdiff
path: root/qpid/cpp/src/qpid/broker/DeliveryRecord.h
blob: d388ba94beb2513b4f2944abf85bc3cf30fe94ca (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
132
133
134
135
136
137
138
139
140
141
142
143
#ifndef QPID_BROKER_DELIVERYRECORD_H
#define QPID_BROKER_DELIVERYRECORD_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 <algorithm>
#include <deque>
#include <vector>
#include <ostream>
#include "qpid/framing/SequenceSet.h"
#include "qpid/broker/BrokerImportExport.h"
#include "qpid/broker/QueuedMessage.h"
#include "qpid/broker/DeliveryId.h"
#include "qpid/broker/Message.h"

namespace qpid {
namespace broker {

class TransactionContext;
class SemanticState;
struct AckRange;

/**
 * Record of a delivery for which an ack is outstanding.
 */
class DeliveryRecord
{
    QueuedMessage msg;
    mutable boost::shared_ptr<Queue> queue;
    std::string tag;
    DeliveryId id;
    bool acquired : 1;
    bool acceptExpected : 1;
    bool cancelled : 1;
    bool completed : 1;
    bool ended : 1;
    bool windowing : 1;

    /**
     * Record required credit on construction as the pointer to the
     * message may be reset once we no longer need to deliver it
     * (e.g. when it is accepted), but we will still need to be able
     * to reallocate credit when it is completed (which could happen
     * after that).
     */
    uint32_t credit;

  public:
    QPID_BROKER_EXTERN DeliveryRecord(const QueuedMessage& msg,
                                      const boost::shared_ptr<Queue>& queue, 
                                      const std::string& tag,
                                      bool acquired,
                                      bool accepted,
                                      bool windowing,
                                      uint32_t credit=0       // Only used if msg is empty.
    );
    
    bool coveredBy(const framing::SequenceSet* const range) const { return range->contains(id); }
    
    void dequeue(TransactionContext* ctxt = 0) const;
    void requeue() const;
    void release(bool setRedelivered);
    void reject();
    void cancel(const std::string& tag);
    void redeliver(SemanticState* const);
    void acquire(DeliveryIds& results);
    void complete();
    bool accept(TransactionContext* ctxt); // Returns isRedundant()
    bool setEnded();            // Returns isRedundant()
    void committed() const;

    bool isAcquired() const { return acquired; }
    bool isComplete() const { return completed; }
    bool isRedundant() const { return ended && (!windowing || completed); }
    bool isCancelled() const { return cancelled; }
    bool isAccepted() const { return !acceptExpected; }
    bool isEnded() const { return ended; }
    bool isWindowing() const { return windowing; }
    
    uint32_t getCredit() const;
    const std::string& getTag() const { return tag; }

    void deliver(framing::FrameHandler& h, DeliveryId deliveryId, uint16_t framesize);
    void setId(DeliveryId _id) { id = _id; }

    typedef std::deque<DeliveryRecord> DeliveryRecords;
    static AckRange findRange(DeliveryRecords& records, DeliveryId first, DeliveryId last);
    const QueuedMessage& getMessage() const { return msg; }
    framing::SequenceNumber getId() const { return id; }
    boost::shared_ptr<Queue> getQueue() const { return queue; }

    friend std::ostream& operator<<(std::ostream&, const DeliveryRecord&);
};

inline bool operator<(const DeliveryRecord& a, const DeliveryRecord& b) { return a.getId() < b.getId(); }
inline bool operator<(const framing::SequenceNumber& a, const DeliveryRecord& b) { return a < b.getId(); }
inline bool operator<(const DeliveryRecord& a, const framing::SequenceNumber& b) { return a.getId() < b; }

struct AcquireFunctor
{
    DeliveryIds& results;

    AcquireFunctor(DeliveryIds& _results) : results(_results) {}

    void operator()(DeliveryRecord& record)
    {
        record.acquire(results);
    }
};

typedef DeliveryRecord::DeliveryRecords DeliveryRecords;

struct AckRange
{
    DeliveryRecords::iterator start;
    DeliveryRecords::iterator end;    
    AckRange(DeliveryRecords::iterator _start, DeliveryRecords::iterator _end) : start(_start), end(_end) {}
};

}
}


#endif  /*!QPID_BROKER_DELIVERYRECORD_H*/