Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_Details_MpiCommRequest.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_DETAILS_MPICOMMREQUEST_HPP
43 #define TEUCHOS_DETAILS_MPICOMMREQUEST_HPP
44 
46 
47 namespace Teuchos {
48 namespace Details {
49 
70 class MpiCommRequest : public MpiCommRequestBase<int> {
71 public:
88  MpiCommRequest (MPI_Request rawMpiRequest,
89  const ArrayRCP<const char>& buffer);
90 
92  virtual ~MpiCommRequest ();
93 
94 private:
96  ArrayRCP<const char> buffer_;
97 
98  MpiCommRequest (); // Not defined
99  MpiCommRequest (const MpiCommRequest&); // Not defined
100  MpiCommRequest& operator= (const MpiCommRequest&); // Not defined
101 };
102 
111 mpiCommRequest (MPI_Request rawMpiRequest,
112  const ArrayRCP<const char>& buffer);
113 
114 } // namespace Details
115 } // namespace Teuchos
116 
117 #endif // TEUCHOS_DETAILS_MPICOMMREQUEST_HPP
MPI implementation of CommRequest<int>.
Namespace of implementation details.
virtual ~MpiCommRequest()
Destructor; cancels the request if it is still pending.
Implementation of Teuchos wrappers for MPI.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines.
Smart reference counting pointer class for automatic garbage collection.