Chris@16: // Copyright (C) 2006 Douglas Gregor <doug.gregor -at- gmail.com>.
Chris@16: 
Chris@16: // Use, modification and distribution is subject to the Boost Software
Chris@16: // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@16: // http://www.boost.org/LICENSE_1_0.txt)
Chris@16: 
Chris@16: /** @file request.hpp
Chris@16:  *
Chris@16:  *  This header defines the class @c request, which contains a request
Chris@16:  *  for non-blocking communication.
Chris@16:  */
Chris@16: #ifndef BOOST_MPI_REQUEST_HPP
Chris@16: #define BOOST_MPI_REQUEST_HPP
Chris@16: 
Chris@16: #include <boost/mpi/config.hpp>
Chris@16: #include <boost/optional.hpp>
Chris@16: #include <boost/shared_ptr.hpp>
Chris@16: #include <boost/mpi/packed_iarchive.hpp>
Chris@16: 
Chris@16: namespace boost { namespace mpi {
Chris@16: 
Chris@16: class status;
Chris@16: class communicator;
Chris@16: 
Chris@16: /**
Chris@16:  *  @brief A request for a non-blocking send or receive.
Chris@16:  *
Chris@16:  *  This structure contains information about a non-blocking send or
Chris@16:  *  receive and will be returned from @c isend or @c irecv,
Chris@16:  *  respectively.
Chris@16:  */
Chris@16: class BOOST_MPI_DECL request 
Chris@16: {
Chris@16:  public:
Chris@16:   /**
Chris@16:    *  Constructs a NULL request.
Chris@16:    */
Chris@16:   request();
Chris@16: 
Chris@16:   /**
Chris@16:    *  Wait until the communication associated with this request has
Chris@16:    *  completed, then return a @c status object describing the
Chris@16:    *  communication.
Chris@16:    */
Chris@16:   status wait();
Chris@16: 
Chris@16:   /**
Chris@16:    *  Determine whether the communication associated with this request
Chris@16:    *  has completed successfully. If so, returns the @c status object
Chris@16:    *  describing the communication. Otherwise, returns an empty @c
Chris@16:    *  optional<> to indicate that the communication has not completed
Chris@16:    *  yet. Note that once @c test() returns a @c status object, the
Chris@16:    *  request has completed and @c wait() should not be called.
Chris@16:    */
Chris@16:   optional<status> test();
Chris@16: 
Chris@16:   /**
Chris@16:    *  Cancel a pending communication, assuming it has not already been
Chris@16:    *  completed.
Chris@16:    */
Chris@16:   void cancel();
Chris@16: 
Chris@16:  private:
Chris@16:   enum request_action { ra_wait, ra_test, ra_cancel };
Chris@16:   typedef optional<status> (*handler_type)(request* self, 
Chris@16:                                            request_action action);
Chris@16: 
Chris@16:   /**
Chris@16:    * INTERNAL ONLY
Chris@16:    *
Chris@16:    * Handles the non-blocking receive of a serialized value.
Chris@16:    */
Chris@16:   template<typename T>
Chris@16:   static optional<status> 
Chris@16:   handle_serialized_irecv(request* self, request_action action);
Chris@16: 
Chris@16:   /**
Chris@16:    * INTERNAL ONLY
Chris@16:    *
Chris@16:    * Handles the non-blocking receive of an array of  serialized values.
Chris@16:    */
Chris@16:   template<typename T>
Chris@16:   static optional<status> 
Chris@16:   handle_serialized_array_irecv(request* self, request_action action);
Chris@16: 
Chris@16:  public: // template friends are not portable
Chris@16: 
Chris@16:   /// INTERNAL ONLY
Chris@16:   MPI_Request m_requests[2];
Chris@16: 
Chris@16:   /// INTERNAL ONLY
Chris@16:   handler_type m_handler;
Chris@16: 
Chris@16:   /// INTERNAL ONLY
Chris@16:   shared_ptr<void> m_data;
Chris@16: 
Chris@16:   friend class communicator;
Chris@16: };
Chris@16: 
Chris@16: } } // end namespace boost::mpi
Chris@16: 
Chris@16: #endif // BOOST_MPI_REQUEST_HPP