XrdClientAbs.hh

Go to the documentation of this file.

//                                                                      //
// XrdClientAbs                                                     // 
//                                                                      //
// Author: Fabrizio Furano (INFN Padova, 2004)                          //
// Adapted from TXNetFile (root.cern.ch) originally done by             //
//  Alvise Dorigo, Fabrizio Furano                                      //
//          INFN Padova, 2003                                           //
//                                                                      //
// Base class for objects handling redirections keeping open files      //
//                                                                      //

//       $Id$

#ifndef XRD_ABSCLIENTBASE_H
#define XRD_ABSCLIENTBASE_H

#include "XrdClient/XrdClientUnsolMsg.hh"
#include "XrdClient/XrdClientConn.hh"

class XrdClientCallback;

class XrdClientAbs: public XrdClientAbsUnsolMsgHandler {

   // Do NOT abuse of this
   friend class XrdClientConn;


protected:
   XrdClientConn*              fConnModule;

   char                        fHandle[4];  // The file handle returned by the server,
                                            // to be used for successive requests


   XrdClientCallback*          fXrdCcb;
   void *                      fXrdCcbArg;
   
   // After a redirection the file must be reopened.
   virtual bool OpenFileWhenRedirected(char *newfhandle, 
                                       bool &wasopen) = 0;

   // In some error circumstances (e.g. when writing)
   // a redirection on error must be denied
   virtual bool CanRedirOnError() = 0;

public:

   XrdClientAbs(XrdClientCallback *XrdCcb = 0, void *XrdCcbArg = 0) {
      memset( fHandle, 0, sizeof(fHandle) );

      // Set the callback object, if any
      fXrdCcb = XrdCcb;
      fXrdCcbArg = XrdCcbArg;
   }

   virtual bool IsOpen_wait() {
     return true;
   };

   void SetParm(const char *parm, int val);
   void SetParm(const char *parm, double val);

   // Hook to the open connection (needed by TXNetFile)
   XrdClientConn              *GetClientConn() const { return fConnModule; }

   inline XrdClientUrlInfo GetCurrentUrl() {
      if (fConnModule)
         return fConnModule->GetCurrentUrl();
      else {
         XrdClientUrlInfo empty;
         return empty;
      }
   }

   // The last response got from a non-async request
   struct ServerResponseHeader *LastServerResp() {
     IsOpen_wait();
      if (fConnModule) return &fConnModule->LastServerResp;
      else return 0;
   }

   struct ServerResponseBody_Error *LastServerError() {
      if (fConnModule) return &fConnModule->LastServerError;
      else return 0;
   }

   // Asks for the value of some parameter
   //---------------------------------------------------------------------------
   //---------------------------------------------------------------------------
   bool Query(kXR_int16 ReqCode, const kXR_char *Args, kXR_char *Resp, kXR_int32 MaxResplen);

   //---------------------------------------------------------------------------
   //---------------------------------------------------------------------------
   bool Query( kXR_int16 ReqCode, const kXR_char *Args, kXR_char **Resp, kXR_int32 MaxResplen );

};

#endif