Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::LibraryPeer

VCF::LibraryPeer Class Reference

The LibraryPeer represents a generic wrapper around using DLL/SOs on systems. More...

#include <vcf/FoundationKit/LibraryPeer.h>

Inheritance diagram for VCF::LibraryPeer:

VCF::LinuxLibraryPeer VCF::OSXLibraryPeer VCF::Win32LibraryPeer List of all members.

Public Member Functions

virtual ~LibraryPeer ()
virtual void load (const String &libraryFilename)=0
 loads a dynamic library
virtual void * getFunction (const String &functionName)=0
 returns a pointer to the function named functionName.
virtual void unload ()=0
virtual OSHandleID getHandleID ()=0
 Returns an OS handle to the loaded library.

Detailed Description

The LibraryPeer represents a generic wrapper around using DLL/SOs on systems.

Implemented by a specific LibraryPeer derived OS class.

Constructor & Destructor Documentation

virtual VCF::LibraryPeer::~LibraryPeer (   )  [inline, virtual]
 

Member Function Documentation

virtual void* VCF::LibraryPeer::getFunction (  const String &  functionName  )  [pure virtual]
 

returns a pointer to the function named functionName.

Parameters:
String the name of the function to get a pointer to
Returns:
void* a pointer to the function. Must be typcasted into a valid function pointer on the caller's side. Throws RuntimeException if a failure to load the library occurs

Implemented in VCF::LinuxLibraryPeer, VCF::OSXLibraryPeer, and VCF::Win32LibraryPeer.

virtual OSHandleID VCF::LibraryPeer::getHandleID (   )  [pure virtual]
 

Returns an OS handle to the loaded library.

Implemented in VCF::LinuxLibraryPeer, VCF::OSXLibraryPeer, and VCF::Win32LibraryPeer.

virtual void VCF::LibraryPeer::load (  const String &  libraryFilename  )  [pure virtual]
 

loads a dynamic library

Implemented in VCF::LinuxLibraryPeer, VCF::OSXLibraryPeer, and VCF::Win32LibraryPeer.

virtual void VCF::LibraryPeer::unload (   )  [pure virtual]
 

Implemented in VCF::LinuxLibraryPeer, VCF::OSXLibraryPeer, and VCF::Win32LibraryPeer.

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information