Drizzled Public API Documentation

scoreboard.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 
00031 #pragma once
00032 
00033 #include "scoreboard_slot.h"
00034 #include <boost/thread/shared_mutex.hpp>
00035 
00036 #include <vector>
00037 
00038 class Scoreboard
00039 {
00040 public:
00041   Scoreboard(uint32_t in_number_sessions, uint32_t in_number_buckets);
00042 
00043   ~Scoreboard();
00044 
00055   ScoreboardSlot* findScoreboardSlotToLog(drizzled::Session *session);
00056 
00063   ScoreboardSlot* findOurScoreboardSlot(drizzled::Session *session);
00064 
00065   uint32_t getBucketNumber(drizzled::Session *session);
00066 
00067   uint32_t getNumberBuckets()
00068   {
00069     return number_buckets;
00070   }
00071 
00072   uint32_t getNumberPerBucket()
00073   {
00074     return number_per_bucket;
00075   }
00076 
00077   uint64_t getScoreboardSizeBytes()
00078   {
00079     return scoreboard_size_bytes;
00080   } 
00081 
00082   std::vector<boost::shared_mutex* >* getVectorOfScoreboardLocks()
00083   {
00084     return &vector_of_scoreboard_locks;
00085   }
00086 
00087   std::vector<std::vector<ScoreboardSlot* >* >* getVectorOfScoreboardVectors()
00088   {
00089     return &vector_of_scoreboard_vectors; 
00090   }
00091 
00092 private:
00093   uint32_t number_sessions;
00094   uint32_t number_per_bucket;
00095   uint32_t number_buckets;
00096   uint64_t scoreboard_size_bytes;
00097   std::vector<std::vector<ScoreboardSlot* >* > vector_of_scoreboard_vectors;
00098   std::vector<boost::shared_mutex* > vector_of_scoreboard_locks;
00099 
00100   ScoreboardSlot* claimOpenScoreboardSlot(drizzled::Session *session); 
00101 };
00102