ACE/ace/FILE.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    FILE.h
   6  *
   7  *  @author Gerhard Lenzer
   8  */
   9 //=============================================================================
  10
  11 #ifndef ACE_FILE_H
  12 #define ACE_FILE_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include "ace/IO_SAP.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include "ace/FILE_Addr.h"
  22
  23 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  24
  25 /**
  26  * @class ACE_FILE_Info
  27  *
  28  * @brief Abstracts basic OS FILE information.
  29  */
  30 class ACE_Export ACE_FILE_Info
  31 {
  32 public:
  33   /// Mode of file
  34   mode_t mode_;
  35
  36   /// No of links
  37   nlink_t nlink_;
  38
  39   /// Size of file
  40   ACE_OFF_T size_;
  41 };
  42
  43 /**
  44  * @class ACE_FILE
  45  *
  46  * @brief Defines the core methods of the ACE_FILE abstraction.
  47  */
  48 class ACE_Export ACE_FILE : public ACE_IO_SAP
  49 {
  50 public:
  51   /// Close the ACE_FILE handle without removing the ACE_FILE from
  52   /// the file system.
  53   int close (void);
  54
  55   /// Close and remove the ACE_FILE from the file system.
  56   int remove (void);
  57
  58   /// Remove the ACE_FILE from the file system without closing the
  59   /// ACE_FILE handle.
  60   int unlink (void);
  61
  62   /// Get information on this ACE_FILE.
  63   int get_info (ACE_FILE_Info *finfo);
  64
  65   /// Get information on this ACE_FILE.
  66   int get_info (ACE_FILE_Info &finfo);
  67
  68   /// Set filesize to length byte.
  69   int truncate (ACE_OFF_T length);
  70
  71   /**
  72    * Sets the file pointer as follows:
  73    *    o If @ whence is @c SEEK_SET, the pointer is set to @a offset
  74    *      bytes.
  75    *
  76    *    o If @a whence> is @c SEEK_CUR, the pointer is set to its
  77    *      current location plus @a offset.
  78    *
  79    *    o If @a whence is @c SEEK_END, the pointer is set to the size
  80    *       of the file plus offset.
  81    */
  82   ACE_OFF_T seek (ACE_OFF_T offset,
  83                   int whence = SEEK_CUR);
  84
  85   /// Return an offset for the file handle.
  86   ACE_OFF_T tell (void);
  87
  88   /**
  89    * Disable signal @a signum
  90    * This is here to prevent Win32 from
  91    * disabling SPIPE using socket calls
  92    */
  93   int disable (int signum) const ;
  94
  95   /// Return the local endpoint address in the referenced ACE_Addr.
  96   /// Returns 0 if successful, else -1.
  97   int get_local_addr (ACE_Addr &) const;
  98
  99   /// Return the same thing as get_local_addr().
 100   int get_remote_addr (ACE_Addr &) const;
 101
 102   /// Dump the state of an object.
 103   void dump (void) const;
 104
 105   /// Declare the dynamic allocation hooks.
 106   ACE_ALLOC_HOOK_DECLARE;
 107
 108 protected:
 109   /// Ensure that this class is only created by the
 110   /// ACE_FILE_Connector.
 111   ACE_FILE (void);
 112
 113   /// File we are "connected" with...
 114   ACE_FILE_Addr addr_;
 115 };
 116
 117 ACE_END_VERSIONED_NAMESPACE_DECL
 118
 119 #if defined (__ACE_INLINE__)
 120 #include "ace/FILE.inl"
 121 #endif /* __ACE_INLINE__ */
 122
 123 #include /**/ "ace/post.h"
 124 #endif /* ACE_FILE_H */