Drizzled Public API Documentation

cumulative_stats.h
1 /*
2  * Copyright (C) 2010 Joseph Daly <skinny.moey@gmail.com>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  * * Neither the name of Joseph Daly 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 "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #pragma once
31 
32 #include "scoreboard_slot.h"
33 #include "scoreboard.h"
34 #include "global_stats.h"
35 
36 #include <drizzled/atomics.h>
37 
38 #include <vector>
39 
40 static const int32_t INVALID_INDEX= -1;
41 
43 {
44 public:
45  CumulativeStats(uint32_t in_cumulative_stats_by_user_max);
46 
47  ~CumulativeStats();
48 
49  void logUserStats(ScoreboardSlot* scoreboard_slot, bool reserveSlot);
50 
51  void logGlobalStats(ScoreboardSlot* scoreboard_slot);
52 
53  void logGlobalStatusVars(ScoreboardSlot* scoreboard_slot);
54 
55  std::vector<ScoreboardSlot* > *getCumulativeStatsByUserVector()
56  {
57  return cumulative_stats_by_user_vector;
58  }
59 
60  GlobalStats *getGlobalStats()
61  {
62  return global_stats;
63  }
64 
65  StatusVars *getGlobalStatusVars()
66  {
67  return global_status_vars;
68  }
69 
70  int32_t getCumulativeStatsByUserMax() const
71  {
72  return cumulative_stats_by_user_max;
73  }
74 
75  uint64_t getCumulativeSizeBytes() const
76  {
77  return cumulative_size_bytes;
78  }
79 
80  int32_t getCumulativeStatsLastValidIndex() const;
81 
82  bool hasOpenUserSlots() const
83  {
84  return isOpenUserSlots;
85  }
86 
87  void sumCurrentScoreboard(Scoreboard*, StatusVars*, UserCommands*);
88 
89 private:
90  std::vector<ScoreboardSlot*>* cumulative_stats_by_user_vector;
91  GlobalStats *global_stats;
92  StatusVars *global_status_vars;
93  uint64_t cumulative_size_bytes;
94  int32_t cumulative_stats_by_user_max;
95  drizzled::atomic<int32_t> last_valid_index;
96  bool isOpenUserSlots;
97 };
98