Drizzled Public API Documentation

scoreboard_slot.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 
31 #pragma once
32 
33 #include "status_vars.h"
34 #include "user_commands.h"
35 
36 #include <drizzled/session.h>
37 #include <string>
38 
40 {
41 public:
42  ScoreboardSlot();
43 
44  ~ScoreboardSlot();
45 
46  ScoreboardSlot(const ScoreboardSlot &scoreboad_slot);
47 
48  UserCommands* getUserCommands();
49 
50  StatusVars* getStatusVars();
51 
52  void setSessionId(drizzled::session_id_t in_session_id);
53 
54  drizzled::session_id_t getSessionId();
55 
56  void setInUse(bool in_in_use);
57 
58  bool isInUse();
59 
60  void setUser(std::string in_user);
61 
62  const std::string& getUser();
63 
64  void setIp(std::string in_ip);
65 
66  const std::string& getIp();
67 
68  void reset();
69 
70  void merge(ScoreboardSlot *score_board_slot);
71 
72 private:
73  UserCommands *user_commands;
74  StatusVars *status_vars;
75  std::string user;
76  std::string ip;
77  bool in_use;
78  drizzled::session_id_t session_id;
79 };
80