JEEP::JFunctionAdaptor< JReturn_t, Args > Struct Template Reference

Function adaptor. More...

#include <JFunctionAdaptor.hh>

Inheritance diagram for JEEP::JFunctionAdaptor< JReturn_t, Args >:

Public Types
typedef JReturn_t(*	pF )(Args...)
	Type definition of method. More...

Public Member Functions
	JFunctionAdaptor ()
	Default constructor. More...
	JFunctionAdaptor (pF pf)
	Constructor. More...
	JFunctionAdaptor (const std::string &libso, const std::string &symbol)
	Constructor. More...
JReturn_t	operator() (Args...args) const
	Function operation. More...
bool	is_valid () const
	Check validity of function. More...
void	reset ()
	Reset function adaptor helper. More...
void	set (JReturn_t(*)(Args...)pf)
	Set function. More...
void	get (const char *symbol)
	Get function with given name according to specific protocol. More...
bool	is_open () const
	Check if shared library file is open. More...
void	open (const char *file_name)
	Open file. More...
void	close ()
	Close file. More...
void	load (const std::string &libso, const std::string &symbol)
	Load function from shared library. More...
void	reload ()
	Reload function from shared library. More...
void	initialise ()
	Initialise counter. More...
void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object. More...
bool	detach ()
	Detach. More...
const int	getCount ()
	Get count. More...

Static Public Attributes
static const char	SEPARATOR
	Separation character between library file name and function name. More...

Protected Attributes
void *	handle
JReturn_t(*)(Args...)	function
std::string	libso
std::string	symbol
int *	counter

Detailed Description

template<class JReturn_t = void, class... Args>
struct JEEP::JFunctionAdaptor< JReturn_t, Args >

Function adaptor.

Definition at line 301 of file JFunctionAdaptor.hh.

Member Typedef Documentation

template<class JReturn_t = void, class... Args>

typedef JReturn_t(* JEEP::JFunctionAdaptor< JReturn_t, Args >::pF)(Args...)

Type definition of method.

Definition at line 307 of file JFunctionAdaptor.hh.

Constructor & Destructor Documentation

template<class JReturn_t = void, class... Args>

JEEP::JFunctionAdaptor< JReturn_t, Args >::JFunctionAdaptor ( )

inline

Default constructor.

Definition at line 313 of file JFunctionAdaptor.hh.

                       :
      JFunctionAdaptorHelper<pF>()
    {}

template<class JReturn_t = void, class... Args>

JEEP::JFunctionAdaptor< JReturn_t, Args >::JFunctionAdaptor ( pF  pf )

inline

Constructor.

Parameters

pf	pointer to function

Definition at line 323 of file JFunctionAdaptor.hh.

                            :
      JFunctionAdaptorHelper<pF>(pf)
    {}

template<class JReturn_t = void, class... Args>

JEEP::JFunctionAdaptor< JReturn_t, Args >::JFunctionAdaptor ( const std::string &  libso, const std::string &  symbol  )

inline

Constructor.

Parameters

libso	file name
symbol	function name

Definition at line 334 of file JFunctionAdaptor.hh.

                                              :
      JFunctionAdaptorHelper<pF>(libso, symbol)
    {}

Member Function Documentation

template<class JReturn_t = void, class... Args>

JReturn_t JEEP::JFunctionAdaptor< JReturn_t, Args >::operator() ( Args...  args ) const

inline

Function operation.

Parameters

args

arguments

Returns

return value

Definition at line 346 of file JFunctionAdaptor.hh.

    {
      return this->function(args...);
    }

bool JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::is_valid ( ) const

inlineinherited

Check validity of function.

Returns

true if valid function; else false

Definition at line 56 of file JFunctionAdaptor.hh.

    {
      return (function != NULL);
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::reset ( )

inlineinherited

Reset function adaptor helper.

Definition at line 65 of file JFunctionAdaptor.hh.

    {
      if (detach()) {
        close();
      }
      
      function = NULL;
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::set ( JReturn_t(*)(Args...)  pf )

inlineinherited

Set function.

Parameters

pf	pointer to function

Definition at line 80 of file JFunctionAdaptor.hh.

    {
      reset();
      
      function = pf;
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::get ( const char *  symbol )

inlineinherited

Get function with given name according to specific protocol.

Parameters

symbol

function name

Definition at line 93 of file JFunctionAdaptor.hh.

    {
      function = NULL;

      if (handle != NULL) {

        dlerror();                 // reset errors

        function = (__pF__) dlsym(handle, symbol);

        const char* error = dlerror();

        if (error != NULL) {
          THROW(JFileReadException, error);
        }

      } else {

        THROW(JFileReadException, "Invalid handle.");
      }
    }

bool JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::is_open ( ) const

inlineinherited

Check if shared library file is open.

Returns

true if open; else false

Definition at line 121 of file JFunctionAdaptor.hh.

    {
      return (handle != NULL);
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::open ( const char *  file_name )

inlineinherited

Open file.

Parameters

file_name

file name

Definition at line 132 of file JFunctionAdaptor.hh.

    {
      reset();
      
      handle = dlopen(file_name, RTLD_LOCAL | RTLD_LAZY);

      if (!handle) {
        THROW(JFileOpenException, dlerror());
      }

      initialise();
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::close ( )

inlineinherited

Close file.

Note that the file should remain open as long as the library function is used.

Definition at line 151 of file JFunctionAdaptor.hh.

    {
      if (handle != NULL) {
        dlclose(handle);
        dlclose(handle);
      }

      handle = NULL;
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::load ( const std::string &  libso, const std::string &  symbol  )

inlineinherited

Load function from shared library.

Parameters

libso	file name
symbol	function name

Definition at line 168 of file JFunctionAdaptor.hh.

    {
      this->libso  = libso;
      this->symbol = symbol;

      reload();
    }

void JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::reload ( )

inlineinherited

Reload function from shared library.

Definition at line 180 of file JFunctionAdaptor.hh.

    {
      open(libso.c_str());

      get(symbol.c_str());
    }

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

    {
      detach();

      counter = new int(1);
    }

void JLANG::JSharedCounter::attach ( const JSharedCounter &  object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object

shared counter

Definition at line 46 of file JSharedCounter.hh.

    {
      detach();

      counter = object.counter;

      if (counter != NULL) {
        ++(*counter);
      }
    }

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns

true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

    {
      if (counter != NULL) {

        if (--(*counter) == 0) {

          delete counter;

          counter = NULL;

          return true;
        }

        counter = NULL;
      }

      return false;
    }

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns

count

Definition at line 88 of file JSharedCounter.hh.

    {
      return (counter != NULL ? *counter : 0);
    }

Member Data Documentation

const char JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::SEPARATOR

staticinherited

Separation character between library file name and function name.

Definition at line 39 of file JFunctionAdaptor.hh.

void* JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::handle

protectedinherited

Definition at line 290 of file JFunctionAdaptor.hh.

JReturn_t(*)(Args...) JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::function

protectedinherited

Definition at line 291 of file JFunctionAdaptor.hh.

std::string JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::libso

protectedinherited

Definition at line 292 of file JFunctionAdaptor.hh.

std::string JEEP::JFunctionAdaptorHelper< JReturn_t(*)(Args...) >::symbol

protectedinherited

Definition at line 293 of file JFunctionAdaptor.hh.

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

---

The documentation for this struct was generated from the following file:

• JFunctionAdaptor.hh