xref: /freebsd/contrib/kyua/store/write_transaction.hpp (revision 7877fdebeeb35fad1cbbafce22598b1bdf97c786)
1 // Copyright 2011 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file store/write_transaction.hpp
30 /// Implementation of write-only transactions on the backend.
31 
32 #if !defined(STORE_WRITE_TRANSACTION_HPP)
33 #define STORE_WRITE_TRANSACTION_HPP
34 
35 #include "store/write_transaction_fwd.hpp"
36 
37 extern "C" {
38 #include <stdint.h>
39 }
40 
41 #include <memory>
42 #include <string>
43 
44 #include "model/context_fwd.hpp"
45 #include "model/test_program_fwd.hpp"
46 #include "model/test_result_fwd.hpp"
47 #include "store/write_backend_fwd.hpp"
48 #include "utils/datetime_fwd.hpp"
49 #include "utils/fs/path_fwd.hpp"
50 #include "utils/optional_fwd.hpp"
51 
52 namespace store {
53 
54 
55 /// Representation of a write-only transaction.
56 ///
57 /// Transactions are the entry place for high-level calls that access the
58 /// database.
59 class write_transaction {
60     struct impl;
61 
62     /// Pointer to the shared internal implementation.
63     std::shared_ptr< impl > _pimpl;
64 
65     friend class write_backend;
66     write_transaction(write_backend&);
67 
68 public:
69     ~write_transaction(void);
70 
71     void commit(void);
72     void rollback(void);
73 
74     void put_context(const model::context&);
75     int64_t put_test_program(const model::test_program&);
76     int64_t put_test_case(const model::test_program&, const std::string&,
77                           const int64_t);
78     utils::optional< int64_t > put_test_case_file(const std::string&,
79                                                   const utils::fs::path&,
80                                                   const int64_t);
81     int64_t put_result(const model::test_result&, const int64_t,
82                        const utils::datetime::timestamp&,
83                        const utils::datetime::timestamp&);
84 };
85 
86 
87 }  // namespace store
88 
89 #endif  // !defined(STORE_WRITE_TRANSACTION_HPP)
90