Drizzled Public API Documentation

scoreboard_slot.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 "status_vars.h"
00034 #include "user_commands.h"
00035 
00036 #include <drizzled/session.h>
00037 #include <string>
00038 
00039 class ScoreboardSlot
00040 {
00041 public:
00042   ScoreboardSlot(); 
00043 
00044   ~ScoreboardSlot(); 
00045 
00046   ScoreboardSlot(const ScoreboardSlot &scoreboad_slot);
00047 
00048   UserCommands* getUserCommands();
00049 
00050   StatusVars* getStatusVars();
00051 
00052   void setSessionId(drizzled::session_id_t in_session_id);
00053 
00054   drizzled::session_id_t getSessionId();
00055 
00056   void setInUse(bool in_in_use);
00057 
00058   bool isInUse();
00059 
00060   void setUser(std::string in_user);
00061 
00062   const std::string& getUser();
00063 
00064   void setIp(std::string in_ip);
00065 
00066   const std::string& getIp();
00067 
00068   void reset();
00069 
00070   void merge(ScoreboardSlot *score_board_slot);
00071 
00072 private:
00073   UserCommands *user_commands;
00074   StatusVars *status_vars;
00075   std::string user;
00076   std::string ip;
00077   bool in_use;
00078   drizzled::session_id_t session_id;
00079 };
00080