ACE/protocols/ace/INet/FTP_Request.h

   1 /**
   2  * @file FTP_Request.h
   3  *
   4  * @author Martin Corino <mcorino@remedy.nl>
   5  */
   6
   7 #ifndef ACE_FTP_REQUEST_H
   8 #define ACE_FTP_REQUEST_H
   9
  10 #include /**/ "ace/pre.h"
  11
  12 #include "ace/Containers_T.h"
  13 #include "ace/INet/INet_Export.h"
  14 #include "ace/INet/Request.h"
  15 #include "ace/SString.h"
  16
  17 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  18
  19 namespace ACE
  20   {
  21     namespace FTP
  22       {
  23         /**
  24         * @class ACE_FTP_Request
  25         *
  26         * @brief Encapsulates FTP requests/commands.
  27         *
  28         */
  29         class ACE_INET_Export Request
  30           : public ACE::INet::Request
  31           {
  32             public:
  33               Request ();
  34
  35               virtual ~Request ();
  36
  37               /// resets the request object
  38               void reset ();
  39
  40               /// resets the request object and sets
  41               /// new command
  42               Request& operator ()(const ACE_CString& cmd);
  43
  44               /// sets the current command
  45               void command (const ACE_CString& cmd);
  46
  47               /// returns the current command
  48               const ACE_CString& command () const;
  49
  50               /// adds a command argument
  51               /// separates multiple arguments with a space
  52               Request& operator <<(const ACE_CString& arg);
  53
  54               /// returns the arguments string
  55               const ACE_CString& arguments () const;
  56
  57               /// retrieves the arguments
  58               void arguments (ACE_Array<ACE_CString> & args) const;
  59
  60               /// Writes the FTP request to the given stream
  61               void write(std::ostream& str) const;
  62
  63               /// Reads the FTP request from the
  64               /// given stream.
  65               bool read(std::istream& str);
  66
  67               static const ACE_CString FTP_USER;
  68               static const ACE_CString FTP_PASS;
  69               static const ACE_CString FTP_QUIT;
  70               static const ACE_CString FTP_TYPE;
  71               static const ACE_CString FTP_SYST;
  72               static const ACE_CString FTP_PWD;
  73               static const ACE_CString FTP_CWD;
  74               static const ACE_CString FTP_CDUP;
  75               static const ACE_CString FTP_RNFR;
  76               static const ACE_CString FTP_RNTO;
  77               static const ACE_CString FTP_DELE;
  78               static const ACE_CString FTP_MKD;
  79               static const ACE_CString FTP_RMD;
  80               static const ACE_CString FTP_RETR;
  81               static const ACE_CString FTP_STOR;
  82               static const ACE_CString FTP_LIST;
  83               static const ACE_CString FTP_NLST;
  84               static const ACE_CString FTP_ABOR;
  85               static const ACE_CString FTP_EPRT;
  86               static const ACE_CString FTP_PORT;
  87               static const ACE_CString FTP_EPSV;
  88               static const ACE_CString FTP_PASV;
  89               static const ACE_CString FTP_STAT;
  90
  91             private:
  92               static const int eof_;
  93
  94               enum Limits
  95               {
  96                 MAX_CMD_LENGTH  = 4,
  97                 MAX_ARG_LENGTH  = 4096  // seems like a sensible maximum
  98               };
  99
 100               ACE_CString command_;
 101               ACE_CString args_;
 102           };
 103       }
 104   }
 105
 106 ACE_END_VERSIONED_NAMESPACE_DECL
 107
 108 #if defined (__ACE_INLINE__)
 109 #include "ace/INet/FTP_Request.inl"
 110 #endif
 111
 112 #include /**/ "ace/post.h"
 113 #endif /* ACE_FTP_REQUEST_H */