Drizzled Public API Documentation

cumulative_stats.h
00001 /*
00002  * Copyright (C) 2010 Joseph Daly <skinny.moey@gmail.com>
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  *   * Redistributions of source code must retain the above copyright notice,
00009  *     this list of conditions and the following disclaimer.
00010  *   * Redistributions in binary form must reproduce the above copyright notice,
00011  *     this list of conditions and the following disclaimer in the documentation
00012  *     and/or other materials provided with the distribution.
00013  *   * Neither the name of Joseph Daly nor the names of its contributors
00014  *     may be used to endorse or promote products derived from this software
00015  *     without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
00027  * THE POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #pragma once
00031 
00032 #include "scoreboard_slot.h"
00033 #include "scoreboard.h"
00034 #include "global_stats.h"
00035 
00036 #include <drizzled/atomics.h>
00037 
00038 #include <vector>
00039 
00040 static const int32_t INVALID_INDEX= -1;
00041 
00042 class CumulativeStats
00043 {
00044 public:
00045   CumulativeStats(uint32_t in_cumulative_stats_by_user_max);
00046 
00047   ~CumulativeStats();
00048 
00049   void logUserStats(ScoreboardSlot* scoreboard_slot, bool reserveSlot);
00050 
00051   void logGlobalStats(ScoreboardSlot* scoreboard_slot);
00052 
00053   void logGlobalStatusVars(ScoreboardSlot* scoreboard_slot);
00054 
00055   std::vector<ScoreboardSlot* > *getCumulativeStatsByUserVector()
00056   {
00057     return cumulative_stats_by_user_vector;
00058   }
00059 
00060   GlobalStats *getGlobalStats()
00061   {
00062     return global_stats;
00063   }
00064 
00065   StatusVars *getGlobalStatusVars()
00066   {
00067     return global_status_vars;
00068   }
00069 
00070   int32_t getCumulativeStatsByUserMax()
00071   {
00072     return cumulative_stats_by_user_max; 
00073   }
00074 
00075   uint64_t getCumulativeSizeBytes()
00076   {
00077     return cumulative_size_bytes;
00078   }
00079 
00080   int32_t getCumulativeStatsLastValidIndex();
00081 
00082   bool hasOpenUserSlots()
00083   {
00084     return isOpenUserSlots;
00085   }
00086 
00087   void sumCurrentScoreboard(Scoreboard *scoreboard, 
00088                             StatusVars *current_status_vars,
00089                             UserCommands *current_user_commands);
00090 
00091 private:
00092   std::vector<ScoreboardSlot* > *cumulative_stats_by_user_vector;
00093   GlobalStats *global_stats; 
00094   StatusVars *global_status_vars;
00095   uint64_t cumulative_size_bytes;
00096   int32_t cumulative_stats_by_user_max;
00097   drizzled::atomic<int32_t> last_valid_index;
00098   bool isOpenUserSlots;
00099 };
00100