Helper class for handling CUDA streams. More...

#include <StreamHolder.h>

Collaboration diagram for AthCUDA::StreamHolder:

Public Member Functions
	StreamHolder ()
	Friend declaration(s). More...

	StreamHolder (void stream, IStreamPoolSvc pool)
	Constructor with the stream and the pool service. More...

	StreamHolder (const StreamHolder &)=delete
	Copy constructor. More...

	StreamHolder (StreamHolder &&parent)
	Move constructor. More...

	~StreamHolder ()
	Destructor. More...

StreamHolder &	operator= (const StreamHolder &)=delete
	Copy assignment operator. More...

StreamHolder &	operator= (StreamHolder &&rhs)
	Move assignment operator. More...

	operator bool () const
	Convenience operator for checking if the holder has a valid object. More...

Private Attributes
void *	m_stream
	The managed stream. More...

IStreamPoolSvc *	m_pool
	The pool that this holder is attached to. More...

Detailed Description

Helper class for handling CUDA streams.

This class is used to:

be able to handle CUDA streams using pure C++ code;
manage the ownership of CUDA streams during the job.

Note that objects of this type can only be moved, they can not be copied.

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 24 of file StreamHolder.h.

Constructor & Destructor Documentation

◆ StreamHolder() [1/4]

AthCUDA::StreamHolder::StreamHolder ( )

Friend declaration(s).

Default constructor

Definition at line 11 of file StreamHolder.cxx.

    : m_stream( nullptr ), m_pool( nullptr ) {
  
    }

◆ StreamHolder() [2/4]

AthCUDA::StreamHolder::StreamHolder	(	void *	stream,
		IStreamPoolSvc *	pool
	)

Constructor with the stream and the pool service.

Definition at line 16 of file StreamHolder.cxx.

    : m_stream( stream ), m_pool( pool ) {
  
    }

◆ StreamHolder() [3/4]

AthCUDA::StreamHolder::StreamHolder ( const StreamHolder & )

delete

Copy constructor.

◆ StreamHolder() [4/4]

AthCUDA::StreamHolder::StreamHolder ( StreamHolder && parent )

Move constructor.

Definition at line 21 of file StreamHolder.cxx.

    : m_stream( parent.m_stream ), m_pool( parent.m_pool ) {
  
       parent.m_stream = nullptr;
       parent.m_pool = nullptr;
    }

◆ ~StreamHolder()

AthCUDA::StreamHolder::~StreamHolder ( )

Destructor.

Definition at line 28 of file StreamHolder.cxx.

                                {
  
       if( ( m_stream != nullptr ) && ( m_pool != nullptr ) ) {
          m_pool->yieldStream( *this );
       }
    }

Member Function Documentation

◆ operator bool()

AthCUDA::StreamHolder::operator bool ( ) const

Convenience operator for checking if the holder has a valid object.

Definition at line 50 of file StreamHolder.cxx.

                                      {
  
       return ( m_stream != nullptr );
    }

◆ operator=() [1/2]

StreamHolder& AthCUDA::StreamHolder::operator= ( const StreamHolder & )

delete

Copy assignment operator.

◆ operator=() [2/2]

StreamHolder & AthCUDA::StreamHolder::operator= ( StreamHolder && rhs )

Move assignment operator.

Definition at line 35 of file StreamHolder.cxx.

                                                              {
  
       // Check if anything needs to be done.
       if( this == &rhs ) {
          return *this;
       }
  
       // Perform the move.
       m_stream = rhs.m_stream;
       rhs.m_stream = nullptr;
       m_pool = rhs.m_pool;
       rhs.m_pool = nullptr;
       return *this;
    }

Member Data Documentation

◆ m_pool

IStreamPoolSvc* AthCUDA::StreamHolder::m_pool

private

The pool that this holder is attached to.

Definition at line 55 of file StreamHolder.h.

◆ m_stream

void* AthCUDA::StreamHolder::m_stream