ACE/ace/SPIPE.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    SPIPE.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef ACE_SPIPE_H
  13 #define ACE_SPIPE_H
  14 #include /**/ "ace/pre.h"
  15
  16 #include "ace/IPC_SAP.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "ace/SPIPE_Addr.h"
  23
  24 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 /**
  27  * @class ACE_SPIPE
  28  *
  29  * @brief Defines the member functions for the base class of the
  30  * ACE_SPIPE abstraction.
  31  *
  32  * ACE_SPIPE was designed as a wrapper facade for STREAM pipes. On
  33  * Windows, however, ACE_SPIPE is a wrapper for Named Pipes. Therefore,
  34  * on Windows, it is better to use the ACE_Proactor or blocking operations
  35  * in lieu of using the ACE_Reactor.
  36  *
  37  * @sa ACE_SPIPE_Acceptor for additional notes on use with ACE_Reactor
  38  * on Windows.
  39  *
  40  * @warning Windows: Works only on Windows NT 4 and higher.
  41  * @warning Works on non-Windows platforms only when @c ACE_HAS_STREAM_PIPES
  42  * is defined.
  43  */
  44 class ACE_Export ACE_SPIPE : public ACE_IPC_SAP
  45 {
  46 public:
  47   /// Close down the SPIPE without removing the rendezvous point.
  48   /**
  49    * Closes the underlying pipe handle and sets this object's handle value
  50    * to @c ACE_INVALID_HANDLE.
  51    * @return 0 for success; -1 for failure. If a failure occurs, further
  52    * error information is available from ACE_OS::last_error().
  53    */
  54   int close ();
  55
  56   /// Close down the SPIPE and remove the rendezvous point from
  57   /// the file system.
  58   /**
  59    * @return 0 for success; -1 for failure. If a failure occurs, further
  60    * error information is available from ACE_OS::last_error().
  61    */
  62   int remove ();
  63
  64   /// Return the local address of this endpoint.
  65   /**
  66    * Returns the local address of the SPIPE's endpoint in @arg addr.
  67    * @return 0 for success; -1 for failure. If a failure occurs, further
  68    * error information is available from ACE_OS::last_error().
  69    */
  70   int get_local_addr (ACE_SPIPE_Addr &) const;
  71
  72   /**
  73    * Disable signal @arg signum.
  74    * @note This reimplements the inherited method from
  75    * ACE_IPC_SAP. Since the signal actions do not make any sense on
  76    * Windows, this method intercepts the call and NOPs it. On non-Windows,
  77    * it is passed through to ACE_IPC_SAP::disable().
  78    */
  79   int disable (int signum) const ;
  80
  81   /// Dump the state of an object.
  82   void dump () const;
  83
  84 #if defined (ACE_HAS_STREAM_PIPES)
  85   /// Temporary store of duplex pipe handle.
  86   void set_duplex_handle (ACE_HANDLE handle);
  87 #endif /* ACE_HAS_STREAM_PIPES */
  88
  89   /// Declare the dynamic allocation hooks.
  90   ACE_ALLOC_HOOK_DECLARE;
  91
  92 private:
  93 #if defined (ACE_HAS_STREAM_PIPES)
  94   /// Duplex to the pipe I/O handle.
  95   /// Stored here for latter cleaning.
  96   ACE_HANDLE duplex_pipe_handle_;
  97 #endif /* ACE_HAS_STREAM_PIPES */
  98
  99 protected:
 100   /// Ensure that this class is an abstract base class
 101   ACE_SPIPE ();
 102
 103   /// Our local address.
 104   ACE_SPIPE_Addr local_addr_;
 105 };
 106
 107 ACE_END_VERSIONED_NAMESPACE_DECL
 108
 109 #if defined (__ACE_INLINE__)
 110 #include "ace/SPIPE.inl"
 111 #endif /* __ACE_INLINE__ */
 112
 113 #include /**/ "ace/post.h"
 114 #endif /* ACE_SPIPE_H */