Logo ROOT   6.30.04
Reference Guide
 All Namespaces Files Pages
TNetFile.h
Go to the documentation of this file.
1 // @(#)root/net:$Id$
2 // Author: Fons Rademakers 14/08/97
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #ifndef ROOT_TNetFile
13 #define ROOT_TNetFile
14 
15 
16 //////////////////////////////////////////////////////////////////////////
17 // //
18 // TNetFile //
19 // //
20 // A TNetFile is like a normal TFile except that it reads and writes //
21 // its data via a rootd server. //
22 // //
23 //////////////////////////////////////////////////////////////////////////
24 
25 #include "TFile.h"
26 #include "TUrl.h"
27 #include "TFTP.h"
28 #include "TSystem.h"
29 #include "MessageTypes.h"
30 
31 class TSocket;
32 
33 
34 class TNetFile : public TFile {
35 
36 protected:
37  TUrl fEndpointUrl; //URL of realfile (after possible redirection)
38  TString fUser; //remote user name
39  TSocket *fSocket; //connection to rootd server
40  Int_t fProtocol; //rootd protocol level
41  Int_t fErrorCode; //error code returned by rootd (matching gRootdErrStr)
42  Int_t fNetopt; //initial network options (used for ReOpen())
43 
44  TNetFile(const TNetFile&); // NetFile cannot be copied
45  TNetFile& operator=(const TNetFile&); // NetFile cannot be copied
46 
47  TNetFile(const char *url, const char *ftitle, Int_t comp, Bool_t);
48  virtual void ConnectServer(Int_t *stat, EMessageTypes *kind, Int_t netopt,
49  Int_t tcpwindowsize, Bool_t forceOpen,
50  Bool_t forceRead);
51  virtual void Create(const char *url, Option_t *option, Int_t netopt);
52  virtual void Create(TSocket *s, Option_t *option, Int_t netopt);
53  void Init(Bool_t create);
54  void Print(Option_t *option) const;
55  void PrintError(const char *where, Int_t err);
56  Int_t Recv(Int_t &status, EMessageTypes &kind);
57  Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode);
58  Int_t SysClose(Int_t fd);
59  Int_t SysStat(Int_t fd, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime);
60 
61 public:
62  TNetFile(const char *url, Option_t *option = "", const char *ftitle = "",
63  Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt = 0);
64  TNetFile() : fEndpointUrl(), fUser(), fSocket(0), fProtocol(0), fErrorCode(0), fNetopt(0) { }
65  virtual ~TNetFile();
66 
67  void Close(Option_t *option=""); // *MENU*
68  void Flush();
69  Int_t GetErrorCode() const { return fErrorCode; }
70  Bool_t IsOpen() const;
71  Bool_t Matches(const char *url);
72  Int_t ReOpen(Option_t *mode);
73  Bool_t ReadBuffer(char *buf, Int_t len);
74  Bool_t ReadBuffer(char *buf, Long64_t pos, Int_t len);
75  Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf);
76  Bool_t WriteBuffer(const char *buf, Int_t len);
77  void Seek(Long64_t offset, ERelativeTo pos = kBeg);
78 
79  const TUrl *GetEndpointUrl() const { return &fEndpointUrl; }
80 
81  ClassDef(TNetFile,1) //A ROOT file that reads/writes via a rootd server
82 };
83 
84 
85 class TNetSystem : public TSystem {
86 
87 private:
88  Bool_t fDir; // true if a directory is open remotely
89  void *fDirp; // directory handler
90  TFTP *fFTP; // Connection to rootd
91  TString fHost; // Remote host
92  Bool_t fFTPOwner; // True if owner of the FTP instance
93  TString fUser; // Remote user
94  Int_t fPort; // Remote port
95 
96  TNetSystem(const TNetSystem&); // not implemented
97  TNetSystem& operator=(const TNetSystem&); // not implemented
98 
99  void *GetDirPtr() const { return fDirp; }
100 
101 protected:
102  Bool_t fIsLocal; // TRUE if the path points to this host
103  TString fLocalPrefix; // if fIsLocal, prefix to be prepend locally
104 
105  void Create(const char *url, TSocket *sock = 0);
106  void InitRemoteEntity(const char *url);
107 
108 public:
109  TNetSystem(Bool_t ftpowner = kTRUE);
110  TNetSystem(const char *url, Bool_t ftpowner = kTRUE);
111  virtual ~TNetSystem();
112 
113  Bool_t ConsistentWith(const char *path, void *dirptr);
114  Int_t MakeDirectory(const char *name);
115  void *OpenDirectory(const char *name);
116  void FreeDirectory(void *dirp = 0);
117  const char *GetDirEntry(void *dirp = 0);
118  Int_t GetPathInfo(const char *path, FileStat_t &buf);
119  Bool_t AccessPathName(const char *path, EAccessMode mode);
120  int Unlink(const char *path);
121 
122  ClassDef(TNetSystem,0) // Directory handler for NetSystem
123 };
124 
125 #endif