XrdClientAbsMonIntf.hh

Go to the documentation of this file.

#ifndef __XRDCLIABSMONINTF_H__
#define __XRDCLIABSMONINTF_H__

// XrdClientAbsMonIntf
// Public interface to generic monitoring systems
//
  
//       $Id$

class XrdClientAbsMonIntf {
public:


  // Initialization of the external library
  virtual int Init(const char *src, const char *dest, int debug=0, void *parm=0) = 0;
  virtual int DeInit() = 0;

  // To get the name of the library and other info
  virtual int GetMonLibInfo(char **name, char **version, char **remarks) = 0;


  // To submit a set of info about the progress of something
  // Set force to true to be sure that the info is sent and not eventually skipped
  virtual int PutProgressInfo(long long bytecount=0,
                              long long size=0,
                              float percentage=0.0,
                              bool force=false) = 0;


  XrdClientAbsMonIntf() {};
  virtual ~XrdClientAbsMonIntf() {};
};




/******************************************************************************/
/*                X r d C l i e n t A b s M o n I n t f . h  h               */
/******************************************************************************/
  
// The XrdClientMonIntf() function is called when the shared library containing
// implementation of this class is loaded. It must exist in the library as an
// 'extern "C"' defined function.


#define XrdClientMonIntfArgs const char *src, const char *dst

extern "C" {
  typedef XrdClientAbsMonIntf *(*XrdClientMonIntfHook)(XrdClientMonIntfArgs);
XrdClientAbsMonIntf *XrdClientgetMonIntf(XrdClientMonIntfArgs);
}




#endif