ACE/ace/IO_SAP.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    IO_SAP.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef ACE_IO_SAP_H
  13 #define ACE_IO_SAP_H
  14 #include /**/ "ace/pre.h"
  15
  16 #include "ace/Flag_Manip.h"
  17 #include "ace/os_include/sys/os_types.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  24
  25 /**
  26  * @class ACE_IO_SAP
  27  *
  28  * @brief Defines the methods for the base class of the ACE_IO_SAP
  29  * abstraction, which includes ACE_FILE and ACE_DEV.
  30  */
  31 class ACE_Export ACE_IO_SAP
  32 {
  33 public:
  34   enum
  35   {
  36     /// Be consistent with Winsock
  37     INVALID_HANDLE = -1
  38   };
  39
  40   /// Default dtor.
  41   ~ACE_IO_SAP ();
  42
  43   /// Interface for ioctl.
  44   int control (int cmd, void *) const;
  45
  46   // = Common I/O handle options related to files.
  47
  48   /**
  49    * Enable asynchronous I/O (ACE_SIGIO), urgent data (ACE_SIGURG),
  50    * non-blocking I/O (ACE_NONBLOCK), or close-on-exec (ACE_CLOEXEC),
  51    * which is passed as the @a value.
  52    */
  53   int enable (int value) const;
  54
  55   /**
  56    * Disable asynchronous I/O (ACE_SIGIO), urgent data (ACE_SIGURG),
  57    * non-blocking I/O (ACE_NONBLOCK), or close-on-exec (ACE_CLOEXEC),
  58    * which is passed as the @a value.
  59    */
  60   int disable (int value) const;
  61
  62   /// Get the underlying handle.
  63   ACE_HANDLE get_handle () const;
  64
  65   /// Set the underlying handle.
  66   void set_handle (ACE_HANDLE handle);
  67
  68   /// Dump the state of an object.
  69   void dump () const;
  70
  71   /// Declare the dynamic allocation hooks.
  72   ACE_ALLOC_HOOK_DECLARE;
  73
  74 protected:
  75   /// Ensure that ACE_IO_SAP is an abstract base class.
  76   ACE_IO_SAP ();
  77
  78 private:
  79   /// Underlying I/O handle.
  80   ACE_HANDLE handle_;
  81 };
  82
  83 ACE_END_VERSIONED_NAMESPACE_DECL
  84
  85 #if defined (__ACE_INLINE__)
  86 #include "ace/IO_SAP.inl"
  87 #endif /* __ACE_INLINE__ */
  88
  89 #include /**/ "ace/post.h"
  90 #endif /* ACE_IO_SAP_H */