ACE/ace/IPC_SAP.h

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