Chris@16: //
Chris@16: // basic_socket_iostream.hpp
Chris@16: // ~~~~~~~~~~~~~~~~~~~~~~~~~
Chris@16: //
Chris@101: // Copyright (c) 2003-2015 Christopher M. Kohlhoff (chris at kohlhoff dot com)
Chris@16: //
Chris@16: // Distributed under the Boost Software License, Version 1.0. (See accompanying
Chris@16: // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: 
Chris@16: #ifndef BOOST_ASIO_BASIC_SOCKET_IOSTREAM_HPP
Chris@16: #define BOOST_ASIO_BASIC_SOCKET_IOSTREAM_HPP
Chris@16: 
Chris@16: #if defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16: # pragma once
Chris@16: #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16: 
Chris@16: #include <boost/asio/detail/config.hpp>
Chris@16: 
Chris@16: #if !defined(BOOST_ASIO_NO_IOSTREAM)
Chris@16: 
Chris@16: #include <istream>
Chris@16: #include <ostream>
Chris@16: #include <boost/asio/basic_socket_streambuf.hpp>
Chris@16: #include <boost/asio/stream_socket_service.hpp>
Chris@16: 
Chris@16: #if !defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
Chris@16: 
Chris@16: # include <boost/asio/detail/variadic_templates.hpp>
Chris@16: 
Chris@16: // A macro that should expand to:
Chris@16: //   template <typename T1, ..., typename Tn>
Chris@16: //   explicit basic_socket_iostream(T1 x1, ..., Tn xn)
Chris@16: //     : std::basic_iostream<char>(
Chris@16: //         &this->detail::socket_iostream_base<
Chris@16: //           Protocol, StreamSocketService, Time,
Chris@16: //           TimeTraits, TimerService>::streambuf_)
Chris@16: //   {
Chris@16: //     if (rdbuf()->connect(x1, ..., xn) == 0)
Chris@16: //       this->setstate(std::ios_base::failbit);
Chris@16: //   }
Chris@16: // This macro should only persist within this file.
Chris@16: 
Chris@16: # define BOOST_ASIO_PRIVATE_CTR_DEF(n) \
Chris@16:   template <BOOST_ASIO_VARIADIC_TPARAMS(n)> \
Chris@16:   explicit basic_socket_iostream(BOOST_ASIO_VARIADIC_PARAMS(n)) \
Chris@16:     : std::basic_iostream<char>( \
Chris@16:         &this->detail::socket_iostream_base< \
Chris@16:           Protocol, StreamSocketService, Time, \
Chris@16:           TimeTraits, TimerService>::streambuf_) \
Chris@16:   { \
Chris@16:     this->setf(std::ios_base::unitbuf); \
Chris@16:     if (rdbuf()->connect(BOOST_ASIO_VARIADIC_ARGS(n)) == 0) \
Chris@16:       this->setstate(std::ios_base::failbit); \
Chris@16:   } \
Chris@16:   /**/
Chris@16: 
Chris@16: // A macro that should expand to:
Chris@16: //   template <typename T1, ..., typename Tn>
Chris@16: //   void connect(T1 x1, ..., Tn xn)
Chris@16: //   {
Chris@16: //     if (rdbuf()->connect(x1, ..., xn) == 0)
Chris@16: //       this->setstate(std::ios_base::failbit);
Chris@16: //   }
Chris@16: // This macro should only persist within this file.
Chris@16: 
Chris@16: # define BOOST_ASIO_PRIVATE_CONNECT_DEF(n) \
Chris@16:   template <BOOST_ASIO_VARIADIC_TPARAMS(n)> \
Chris@16:   void connect(BOOST_ASIO_VARIADIC_PARAMS(n)) \
Chris@16:   { \
Chris@16:     if (rdbuf()->connect(BOOST_ASIO_VARIADIC_ARGS(n)) == 0) \
Chris@16:       this->setstate(std::ios_base::failbit); \
Chris@16:   } \
Chris@16:   /**/
Chris@16: 
Chris@16: #endif // !defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
Chris@16: 
Chris@16: #include <boost/asio/detail/push_options.hpp>
Chris@16: 
Chris@16: namespace boost {
Chris@16: namespace asio {
Chris@16: namespace detail {
Chris@16: 
Chris@16: // A separate base class is used to ensure that the streambuf is initialised
Chris@16: // prior to the basic_socket_iostream's basic_iostream base class.
Chris@16: template <typename Protocol, typename StreamSocketService,
Chris@16:     typename Time, typename TimeTraits, typename TimerService>
Chris@16: class socket_iostream_base
Chris@16: {
Chris@16: protected:
Chris@16:   basic_socket_streambuf<Protocol, StreamSocketService,
Chris@16:     Time, TimeTraits, TimerService> streambuf_;
Chris@16: };
Chris@16: 
Chris@16: }
Chris@16: 
Chris@16: /// Iostream interface for a socket.
Chris@16: template <typename Protocol,
Chris@16:     typename StreamSocketService = stream_socket_service<Protocol>,
Chris@16: #if defined(BOOST_ASIO_HAS_BOOST_DATE_TIME) \
Chris@16:   || defined(GENERATING_DOCUMENTATION)
Chris@16:     typename Time = boost::posix_time::ptime,
Chris@16:     typename TimeTraits = boost::asio::time_traits<Time>,
Chris@16:     typename TimerService = deadline_timer_service<Time, TimeTraits> >
Chris@16: #else
Chris@16:     typename Time = steady_timer::clock_type,
Chris@16:     typename TimeTraits = steady_timer::traits_type,
Chris@16:     typename TimerService = steady_timer::service_type>
Chris@16: #endif
Chris@16: class basic_socket_iostream
Chris@16:   : private detail::socket_iostream_base<Protocol,
Chris@16:         StreamSocketService, Time, TimeTraits, TimerService>,
Chris@16:     public std::basic_iostream<char>
Chris@16: {
Chris@16: private:
Chris@16:   // These typedefs are intended keep this class's implementation independent
Chris@16:   // of whether it's using Boost.DateTime, Boost.Chrono or std::chrono.
Chris@16: #if defined(BOOST_ASIO_HAS_BOOST_DATE_TIME)
Chris@16:   typedef TimeTraits traits_helper;
Chris@16: #else
Chris@16:   typedef detail::chrono_time_traits<Time, TimeTraits> traits_helper;
Chris@16: #endif
Chris@16: 
Chris@16: public:
Chris@16:   /// The endpoint type.
Chris@16:   typedef typename Protocol::endpoint endpoint_type;
Chris@16: 
Chris@16: #if defined(GENERATING_DOCUMENTATION)
Chris@16:   /// The time type.
Chris@16:   typedef typename TimeTraits::time_type time_type;
Chris@16: 
Chris@16:   /// The duration type.
Chris@16:   typedef typename TimeTraits::duration_type duration_type;
Chris@16: #else
Chris@16:   typedef typename traits_helper::time_type time_type;
Chris@16:   typedef typename traits_helper::duration_type duration_type;
Chris@16: #endif
Chris@16: 
Chris@16:   /// Construct a basic_socket_iostream without establishing a connection.
Chris@16:   basic_socket_iostream()
Chris@16:     : std::basic_iostream<char>(
Chris@16:         &this->detail::socket_iostream_base<
Chris@16:           Protocol, StreamSocketService, Time,
Chris@16:           TimeTraits, TimerService>::streambuf_)
Chris@16:   {
Chris@16:     this->setf(std::ios_base::unitbuf);
Chris@16:   }
Chris@16: 
Chris@16: #if defined(GENERATING_DOCUMENTATION)
Chris@16:   /// Establish a connection to an endpoint corresponding to a resolver query.
Chris@16:   /**
Chris@16:    * This constructor automatically establishes a connection based on the
Chris@16:    * supplied resolver query parameters. The arguments are used to construct
Chris@16:    * a resolver query object.
Chris@16:    */
Chris@16:   template <typename T1, ..., typename TN>
Chris@16:   explicit basic_socket_iostream(T1 t1, ..., TN tn);
Chris@16: #elif defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
Chris@16:   template <typename... T>
Chris@16:   explicit basic_socket_iostream(T... x)
Chris@16:     : std::basic_iostream<char>(
Chris@16:         &this->detail::socket_iostream_base<
Chris@16:           Protocol, StreamSocketService, Time,
Chris@16:           TimeTraits, TimerService>::streambuf_)
Chris@16:   {
Chris@16:     this->setf(std::ios_base::unitbuf);
Chris@16:     if (rdbuf()->connect(x...) == 0)
Chris@16:       this->setstate(std::ios_base::failbit);
Chris@16:   }
Chris@16: #else
Chris@16:   BOOST_ASIO_VARIADIC_GENERATE(BOOST_ASIO_PRIVATE_CTR_DEF)
Chris@16: #endif
Chris@16: 
Chris@16: #if defined(GENERATING_DOCUMENTATION)
Chris@16:   /// Establish a connection to an endpoint corresponding to a resolver query.
Chris@16:   /**
Chris@16:    * This function automatically establishes a connection based on the supplied
Chris@16:    * resolver query parameters. The arguments are used to construct a resolver
Chris@16:    * query object.
Chris@16:    */
Chris@16:   template <typename T1, ..., typename TN>
Chris@16:   void connect(T1 t1, ..., TN tn);
Chris@16: #elif defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
Chris@16:   template <typename... T>
Chris@16:   void connect(T... x)
Chris@16:   {
Chris@16:     if (rdbuf()->connect(x...) == 0)
Chris@16:       this->setstate(std::ios_base::failbit);
Chris@16:   }
Chris@16: #else
Chris@16:   BOOST_ASIO_VARIADIC_GENERATE(BOOST_ASIO_PRIVATE_CONNECT_DEF)
Chris@16: #endif
Chris@16: 
Chris@16:   /// Close the connection.
Chris@16:   void close()
Chris@16:   {
Chris@16:     if (rdbuf()->close() == 0)
Chris@16:       this->setstate(std::ios_base::failbit);
Chris@16:   }
Chris@16: 
Chris@16:   /// Return a pointer to the underlying streambuf.
Chris@16:   basic_socket_streambuf<Protocol, StreamSocketService,
Chris@16:     Time, TimeTraits, TimerService>* rdbuf() const
Chris@16:   {
Chris@16:     return const_cast<basic_socket_streambuf<Protocol, StreamSocketService,
Chris@16:       Time, TimeTraits, TimerService>*>(
Chris@16:         &this->detail::socket_iostream_base<
Chris@16:           Protocol, StreamSocketService, Time,
Chris@16:           TimeTraits, TimerService>::streambuf_);
Chris@16:   }
Chris@16: 
Chris@16:   /// Get the last error associated with the stream.
Chris@16:   /**
Chris@16:    * @return An \c error_code corresponding to the last error from the stream.
Chris@16:    *
Chris@16:    * @par Example
Chris@16:    * To print the error associated with a failure to establish a connection:
Chris@16:    * @code tcp::iostream s("www.boost.org", "http");
Chris@16:    * if (!s)
Chris@16:    * {
Chris@16:    *   std::cout << "Error: " << s.error().message() << std::endl;
Chris@16:    * } @endcode
Chris@16:    */
Chris@16:   const boost::system::error_code& error() const
Chris@16:   {
Chris@16:     return rdbuf()->puberror();
Chris@16:   }
Chris@16: 
Chris@16:   /// Get the stream's expiry time as an absolute time.
Chris@16:   /**
Chris@16:    * @return An absolute time value representing the stream's expiry time.
Chris@16:    */
Chris@16:   time_type expires_at() const
Chris@16:   {
Chris@16:     return rdbuf()->expires_at();
Chris@16:   }
Chris@16: 
Chris@16:   /// Set the stream's expiry time as an absolute time.
Chris@16:   /**
Chris@16:    * This function sets the expiry time associated with the stream. Stream
Chris@16:    * operations performed after this time (where the operations cannot be
Chris@16:    * completed using the internal buffers) will fail with the error
Chris@16:    * boost::asio::error::operation_aborted.
Chris@16:    *
Chris@16:    * @param expiry_time The expiry time to be used for the stream.
Chris@16:    */
Chris@16:   void expires_at(const time_type& expiry_time)
Chris@16:   {
Chris@16:     rdbuf()->expires_at(expiry_time);
Chris@16:   }
Chris@16: 
Chris@16:   /// Get the timer's expiry time relative to now.
Chris@16:   /**
Chris@16:    * @return A relative time value representing the stream's expiry time.
Chris@16:    */
Chris@16:   duration_type expires_from_now() const
Chris@16:   {
Chris@16:     return rdbuf()->expires_from_now();
Chris@16:   }
Chris@16: 
Chris@16:   /// Set the stream's expiry time relative to now.
Chris@16:   /**
Chris@16:    * This function sets the expiry time associated with the stream. Stream
Chris@16:    * operations performed after this time (where the operations cannot be
Chris@16:    * completed using the internal buffers) will fail with the error
Chris@16:    * boost::asio::error::operation_aborted.
Chris@16:    *
Chris@16:    * @param expiry_time The expiry time to be used for the timer.
Chris@16:    */
Chris@16:   void expires_from_now(const duration_type& expiry_time)
Chris@16:   {
Chris@16:     rdbuf()->expires_from_now(expiry_time);
Chris@16:   }
Chris@16: };
Chris@16: 
Chris@16: } // namespace asio
Chris@16: } // namespace boost
Chris@16: 
Chris@16: #include <boost/asio/detail/pop_options.hpp>
Chris@16: 
Chris@16: #if !defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
Chris@16: # undef BOOST_ASIO_PRIVATE_CTR_DEF
Chris@16: # undef BOOST_ASIO_PRIVATE_CONNECT_DEF
Chris@16: #endif // !defined(BOOST_ASIO_HAS_VARIADIC_TEMPLATES)
Chris@16: 
Chris@16: #endif // !defined(BOOST_ASIO_NO_IOSTREAM)
Chris@16: 
Chris@16: #endif // BOOST_ASIO_BASIC_SOCKET_IOSTREAM_HPP