Drizzled Public API Documentation

status_tool.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 "logging_stats.h"
00033 
00034 #include <drizzled/plugin/table_function.h>
00035 #include <drizzled/field.h>
00036 
00037 class StatusTool : public drizzled::plugin::TableFunction
00038 {            
00039 public:
00040 
00041   StatusTool(LoggingStats *logging_stats, bool isLocal);
00042     
00043   class Generator : public drizzled::plugin::TableFunction::Generator
00044   { 
00045   public:
00046     Generator(drizzled::Field **arg, LoggingStats *logging_stats,
00047               std::vector<drizzled::drizzle_show_var *> *all_status_vars, 
00048               bool isLocal);
00049 
00050     ~Generator();
00051 
00052     bool populate();
00053   private:
00054     LoggingStats *logging_stats;
00055     bool isLocal;
00056     StatusVars *status_var_to_display;
00057     std::vector<drizzled::drizzle_show_var *>::iterator all_status_vars_it;
00058     std::vector<drizzled::drizzle_show_var *>::iterator all_status_vars_end;
00059     void fill(const std::string &name, char *value, drizzled::SHOW_TYPE show_type); 
00060   };
00061 
00062   Generator *generator(drizzled::Field **arg)
00063   {
00064     return new Generator(arg, outer_logging_stats, &all_status_vars, isLocal);
00065   }
00066 
00067 private:
00068   LoggingStats *outer_logging_stats;
00069 
00070   bool isLocal;
00071 
00072   std::vector<drizzled::drizzle_show_var *> all_status_vars;
00073 };
00074