Server/include/plaqui/server/command.h

   1 // vim: set noexpandtab tabstop=4 shiftwidth=4:
   2 //----------------------------------------------------------------------------
   3 //                                  PlaQui
   4 //----------------------------------------------------------------------------
   5 // This file is part of PlaQui.
   6 //
   7 // PlaQui is free software; you can redistribute it and/or modify it under the
   8 // terms of the GNU General Public License as published by the Free Software
   9 // Foundation; either version 2 of the License, or (at your option) any later
  10 // version.
  11 //
  12 // PlaQui is distributed in the hope that it will be useful, but WITHOUT ANY
  13 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  15 // details.
  16 //
  17 // You should have received a copy of the GNU General Public License along
  18 // with PlaQui; if not, write to the Free Software Foundation, Inc., 59 Temple
  19 // Place, Suite 330, Boston, MA  02111-1307  USA
  20 //----------------------------------------------------------------------------
  21 // Creado:  sáb nov  8 17:02:44 ART 2003
  22 // Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23 //----------------------------------------------------------------------------
  24 //
  25 // $Id$
  26 //
  27
  28 #ifndef PLAQUI_COMMAND_H
  29 #define PLAQUI_COMMAND_H
  30
  31 #include "httprequest.h"
  32 #include <string>
  33 #include <vector>
  34 #include <istream>
  35 #include <ostream>
  36
  37 namespace PlaQui {
  38
  39 namespace Server {
  40
  41         /// Pedido HTTP.
  42         class Command: private HTTPRequest {
  43
  44                 // Tipos.
  45
  46                 public:
  47
  48                         /// Tipo de métodos HTTP reconocidos.
  49                         typedef std::vector<std::string> Arguments;
  50
  51                 // Atributos.
  52
  53                 private:
  54
  55                         /// Destinatario del comando.
  56                         std::string target;
  57
  58                         /// Comando.
  59                         std::string command;
  60
  61                         /// Lista de argumentos que recibe el comando.
  62                         Arguments args;
  63
  64                 // Métodos.
  65
  66                 private:
  67
  68                         /**
  69                          * Construye el URI.
  70                          */
  71                         void build(void);
  72
  73                 public:
  74
  75                         /**
  76                          * Destructor.
  77                          */
  78                         virtual ~Command(void);
  79
  80                         /**
  81                          * Constructor.
  82                          */
  83                         Command(const std::string& target = "",
  84                                         const std::string& command = "");
  85
  86                         /**
  87                          * Establece el destino.
  88                          */
  89                         void set_target(const std::string& _target);
  90
  91                         /**
  92                          * Obtiene el destino.
  93                          */
  94                         const std::string& get_target(void) const;
  95
  96                         /**
  97                          * Establece el comando.
  98                          */
  99                         void set_command(const std::string& _command);
 100
 101                         /**
 102                          * Obtiene el comand.
 103                          */
 104                         const std::string& get_command(void) const;
 105
 106                         /**
 107                          * Establece los argumentos.
 108                          */
 109                         void set_args(const Arguments& _args);
 110
 111                         /**
 112                          * Obtiene los argumentos.
 113                          */
 114                         const Arguments& get_args(void) const;
 115
 116                         /**
 117                          * Agrega un argumentos.
 118                          */
 119                         void add_arg(const std::string& arg);
 120
 121                         /**
 122                          * Obtiene el comando desde un pedido HTTP completo.
 123                          */
 124                         friend std::istream& operator>>(std::istream& is,
 125                                         Command& command);
 126
 127                         /**
 128                          * Convierte el comando a un pedido HTTP completo.
 129                          */
 130                         friend std::ostream& operator<<(std::ostream& os,
 131                                         const Command& command);
 132
 133         };
 134
 135 }
 136
 137 }
 138
 139 #endif // PLAQUI_COMMAND_H