diff options
Diffstat (limited to 'ace/IPC/FILE.h')
-rw-r--r-- | ace/IPC/FILE.h | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/ace/IPC/FILE.h b/ace/IPC/FILE.h new file mode 100644 index 00000000000..e9fbfc1d749 --- /dev/null +++ b/ace/IPC/FILE.h @@ -0,0 +1,140 @@ +/* -*- C++ -*- */ + +//============================================================================= +/** + * @file FILE.h + * + * $Id$ + * + * @author Gerhard Lenzer + */ +//============================================================================= + +#ifndef ACE_FILE_H +#define ACE_FILE_H +#include "ace/pre.h" + +#include "ace/IO_SAP.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +#include "ace/FILE_Addr.h" + +// The following is necessary since many C++ compilers don't support +// typedef'd types inside of classes used as formal template +// arguments... ;-(. Luckily, using the C++ preprocessor I can hide +// most of this nastiness! + +#if defined (ACE_HAS_TEMPLATE_TYPEDEFS) +#define ACE_FILE_CONNECTOR ACE_FILE_Connector +#define ACE_FILE_STREAM ACE_FILE_IO +#else /* TEMPLATES are broken (must be a cfront-based compiler...) */ +#define ACE_FILE_CONNECTOR ACE_FILE_Connector, ACE_FILE_Addr +#define ACE_FILE_STREAM ACE_FILE_IO, ACE_FILE_Addr +#endif /* ACE_TEMPLATE_TYPEDEFS */ + +/** + * @class ACE_FILE_Info + * + * @brief Abstracts basic OS FILE information. + */ +class ACE_Export ACE_FILE_Info +{ +public: + /// mode of file + mode_t mode_; + + /// no of links + nlink_t nlink_; + + /// size of file + off_t size_; +}; + +/** + * @class ACE_FILE + * + * @brief Defines the core methods of the <ACE_FILE> abstraction. + */ +class ACE_Export ACE_FILE : public ACE_IO_SAP +{ +public: + /// Close the <ACE_FILE> handle without removing the <ACE_FILE> from + /// the file system. + int close (void); + + /// Close and remove the <ACE_FILE> from the file system. + int remove (void); + + /// Remove the <ACE_FILE> from the file system without closing the + /// <ACE_FILE> handle. + int unlink (void); + + /// Get information on this <ACE_FILE>. + int get_info (ACE_FILE_Info *finfo); + + /// Get information on this <ACE_FILE>. + int get_info (ACE_FILE_Info &finfo); + + /// Set filesize to length byte. + int truncate (off_t length); + + /** + * Sets the file pointer as follows: + * o If <whence> is <SEEK_SET>, the pointer is set to <offset> + * bytes. + * + * o If <whence> is <SEEK_CUR>, the pointer is set to its + * current location plus <offset>. + * + * o If <whence> is <SEEK_END>, the pointer is set to the size + * of the file plus offset. + * Same as <seek>, but <position> is deprecated. + */ + off_t seek (off_t offset, + int whence = SEEK_CUR); + off_t position (long offset, int startpos); + + /// Return an offset for the file handle. + off_t tell (void); + + /// Same as <tell>, but <position> is deprecated. + off_t position (void); + + /** + * Disable signal <signum> + * This is here to prevent Win32 from + * disabling SPIPE using socket calls + */ + int disable (int signum) const ; + + /// Return the local endpoint address in the referenced <ACE_Addr>. + /// Returns 0 if successful, else -1. + int get_local_addr (ACE_Addr &) const; + + /// Return the same thing as <get_local_addr>. + int get_remote_addr (ACE_Addr &) const; + + /// Dump the state of an object. + void dump (void) const; + + /// Declare the dynamic allocation hooks. + ACE_ALLOC_HOOK_DECLARE; + +protected: + /// Ensure that this class is only created by the + /// <ACE_FILE_Connector>. + ACE_FILE (void); + + /// File we are "connected" with... + ACE_FILE_Addr addr_; +}; + +#if !defined (ACE_LACKS_INLINE_FUNCTIONS) +#include "ace/FILE.i" +#endif /* ACE_LACKS_INLINE_FUNCTIONS */ + +#include "ace/post.h" +#endif /* ACE_FILE_H */ |