Aspera Developer Documentation

CallbackFunctor Class Template Reference

Inherits Aspera::FaspManager::Functor.

List of all members.


Detailed Description

template<class T>
class Aspera::FaspManager::CallbackFunctor< T >

A class providing a functor for use in FASP management callbacks. It is required that the implementation of the callback function return quickly. Any time consuming tasks must be performed on a different thread.

Public Member Functions

FASP_MANAGER_API CallbackFunctor (T *obj, void(T::*fnct)(callback_event_e cb_event, const JobStats *, const FileStats *))
FASP_MANAGER_API CallbackFunctor (CallbackFunctor &functor)
FASP_MANAGER_API ~CallbackFunctor ()
 Destructs this FASP callback functor.
FASP_MANAGER_API FunctorClone ()
FASP_MANAGER_API void operator() (callback_event_e cb_event, const JobStats *j_stats, const FileStats *f_stats)
FASP_MANAGER_API bool CompareWith (const Functor *other)

Constructor & Destructor Documentation

FASP_MANAGER_API CallbackFunctor ( T *  obj,
void(T::*)(callback_event_e cb_event, const JobStats *, const FileStats *)  fnct 
) [inline]

Constructs this FASP callback functor.

Parameters:
obj the object used in the callback
fnct the function pointer used in the callback

FASP_MANAGER_API CallbackFunctor ( CallbackFunctor< T > &  functor  )  [inline]

Copy constructs this FASP callback functor.

Parameters:
functor the Fasp callback functor to be copy constructed


Member Function Documentation

FASP_MANAGER_API Functor* Clone (  )  [inline, virtual]

Clones this FASP callback functor.

Returns:
a clone of this FASP callback functor

Implements Functor.

FASP_MANAGER_API void operator() ( callback_event_e  cb_event,
const JobStats j_stats,
const FileStats f_stats 
) [inline, virtual]

Overloads the "()" operator (the function call operator) for this FASP callback functor.

Parameters:
cb_event the event on which the callback is performed
j_stats the FASP Job stats
f_stats the current FASP Job file stats

Implements Functor.

FASP_MANAGER_API bool CompareWith ( const Functor other  )  [inline, virtual]

Compare this instance of Functor with the parameter

Parameters:
other instance of function to compare with

Implements Functor.


Copyright © 2005 - 2008 Aspera, Inc. | asperasoft.com