summaryrefslogtreecommitdiff
path: root/cpp/src/qpid/broker/AsyncStore.h
blob: af9b7be601cca94f06b3e124d139927e283ca89e (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
/*
 * 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.
 */

#ifndef qpid_broker_AsyncStore_h_
#define qpid_broker_AsyncStore_h_

// TODO: See if we can replace this with a forward declaration, but current definition of qpid::types::Variant::Map
// does not allow it. Using a local map<std::string, Variant> definition also precludes forward declaration.
#include "qpid/types/Variant.h" // qpid::types::Variant::Map

#include <stdint.h>
#include <string>

namespace qpid {

namespace broker {

// Defined by broker, implements qpid::messaging::Handle-type template to hide ref counting:
class BrokerContext;

// Subclassed by broker:
class DataSource {
public:
    virtual ~DataSource();
    virtual uint64_t getSize() = 0;
    virtual void write(char* target) = 0;
};

// Defined by store, all implement qpid::messaging::Handle-type template to hide ref counting:
class ConfigHandle;
class QueueHandle;
class TxnHandle;
class EventHandle;
class MessageHandle;
class EnqueueHandle;

// Callback definition:
struct AsyncResult
{
    int errNo; // 0 implies no error
    std::string errMsg;
    AsyncResult();
    AsyncResult(const int errNo,
                const std::string& errMsg);
    void destroy();
};
typedef void (*ResultCallback)(const AsyncResult*, BrokerContext*);

// Subclassed by store:
class AsyncStore {
public:
    AsyncStore();
    virtual ~AsyncStore();

    // Factory methods for creating handles

    virtual TxnHandle createTxnHandle(const std::string& xid=std::string()) = 0;
    virtual ConfigHandle createConfigHandle() = 0;
    virtual QueueHandle createQueueHandle(const std::string& name, const qpid::types::Variant::Map& opts) = 0;
    virtual EventHandle createEventHandle(QueueHandle&, const std::string& key=std::string()) = 0;
    virtual MessageHandle createMessageHandle(const DataSource*) = 0;
    virtual EnqueueHandle createEnqueueHandle(MessageHandle&, QueueHandle&) = 0;


    // Store async interface

    virtual void submitPrepare(TxnHandle&, ResultCallback, BrokerContext*) = 0; // Distributed txns only
    virtual void submitCommit(TxnHandle&, ResultCallback, BrokerContext*) = 0;
    virtual void submitAbort(TxnHandle&, ResultCallback, BrokerContext*) = 0;

    virtual void submitCreate(ConfigHandle&, const DataSource*, ResultCallback, BrokerContext*) = 0;
    virtual void submitDestroy(ConfigHandle&, ResultCallback, BrokerContext*) = 0;

    virtual void submitCreate(QueueHandle&, const DataSource*, ResultCallback, BrokerContext*) = 0;
    virtual void submitDestroy(QueueHandle&, ResultCallback, BrokerContext*) = 0;
    virtual void submitFlush(QueueHandle&, ResultCallback, BrokerContext*) = 0;

    virtual void submitCreate(EventHandle&, const DataSource*, ResultCallback, BrokerContext*) = 0;
    virtual void submitCreate(EventHandle&, const DataSource*, TxnHandle&, ResultCallback, BrokerContext*) = 0;
    virtual void submitDestroy(EventHandle&, ResultCallback, BrokerContext*) = 0;
    virtual void submitDestroy(EventHandle&, TxnHandle&, ResultCallback, BrokerContext*) = 0;

    virtual void submitEnqueue(EnqueueHandle&, ResultCallback, BrokerContext*) = 0;
    virtual void submitEnqueue(EnqueueHandle&, TxnHandle&, ResultCallback, BrokerContext*) = 0;
    virtual void submitDequeue(EnqueueHandle&, ResultCallback, BrokerContext*) = 0;
    virtual void submitDequeue(EnqueueHandle&, TxnHandle&, ResultCallback, BrokerContext*) = 0;

    // Legacy - Restore FTD message, is NOT async!
    virtual int loadContent(MessageHandle&, QueueHandle&, char* data, uint64_t offset, const uint64_t length) = 0;
};


}} // namespace qpid::broker

#endif // qpid_broker_AsyncStore_h_