ACE/protocols/ace/INet/FTP_Session.h

   1 /**
   2  * @file FTP_Session.h
   3  *
   4  * @author Martin Corino <mcorino@remedy.nl>
   5  */
   6
   7 #ifndef ACE_FTP_SESSION_H
   8 #define ACE_FTP_SESSION_H
   9
  10 #include /**/ "ace/pre.h"
  11
  12 #include "ace/SString.h"
  13 #include "ace/Countdown_Time.h"
  14 #include "ace/SOCK_Connector.h"
  15 #include "ace/INET_Addr.h"
  16 #include "ace/INet/INet_Export.h"
  17 #include "ace/INet/FTP_Request.h"
  18 #include "ace/INet/FTP_Response.h"
  19 #include "ace/INet/StreamHandler.h"
  20 #include "ace/INet/Sock_IOStream.h"
  21
  22 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  23
  24 namespace ACE
  25   {
  26     namespace FTP
  27       {
  28         /**
  29         * @class ACE_FTP_Session
  30         *
  31         * @brief Encapsulates FTP session.
  32         *
  33         */
  34         template <ACE_SYNCH_DECL>
  35         class Session_T
  36           {
  37             public:
  38               typedef ACE::IOS::StreamHandler<ACE_SOCK_STREAM, ACE_SYNCH_USE> connection_type;
  39
  40               enum
  41               {
  42                 FTP_PORT = 21
  43               };
  44
  45               Session_T ();
  46
  47               Session_T (const ACE_Time_Value& timeout);
  48
  49               virtual ~Session_T ();
  50
  51               bool is_connected () const;
  52
  53               bool is_new_connection () const;
  54
  55               void set_host (const ACE_CString& host, u_short port);
  56
  57               void set_host (const ACE_CString& host);
  58
  59               void set_port (u_short port);
  60
  61               const ACE_CString& get_host () const;
  62
  63               u_short get_port () const;
  64
  65               bool connect (bool use_reactor = false);
  66
  67               bool connect (connection_type* connection);
  68
  69               bool send_request (Request& request);
  70
  71               bool receive_response (Response& response);
  72
  73               bool send_interrupt ();
  74
  75               void close ();
  76
  77               bool supports_ftp_extensions () const;
  78
  79               void set_ftp_extension_support (bool f);
  80
  81               bool is_reactive () const;
  82
  83               const ACE_Time_Value& timeout () const;
  84
  85               void get_local_addr (ACE_INET_Addr& loc_addr) const;
  86
  87             private:
  88               enum
  89               {
  90                 DEFAULT_TIMEOUT = 30,           // sec
  91
  92                 INTERRUPT = 244   // Telnet IP signal
  93               };
  94
  95               ACE_CString host_;
  96               u_short port_;
  97
  98               typedef ACE::IOS::Sock_IOStreamBase<ACE_SYNCH_USE> sock_stream_type;
  99
 100               bool reactive_;
 101               connection_type* connection_;
 102               sock_stream_type* sock_stream_;
 103               ACE_Time_Value ftp_timeout_;
 104               bool cannot_reconnect_;
 105               bool has_ftp_ext_; // RFC 2428 - IPv6 and NAT
 106               bool new_connect_;
 107           };
 108
 109         typedef Session_T<ACE_NULL_SYNCH> Session;
 110       }
 111   }
 112
 113 ACE_END_VERSIONED_NAMESPACE_DECL
 114
 115 #include "ace/INet/FTP_Session.cpp"
 116
 117 #include /**/ "ace/post.h"
 118 #endif /* ACE_FTP_SESSION_H */