ACE/ace/LSOCK.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    LSOCK.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef ACE_LOCAL_SOCK_H
  13 #define ACE_LOCAL_SOCK_H
  14
  15 #include /**/ "ace/pre.h"
  16
  17 #include /**/ "ace/ACE_export.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #if !defined (ACE_LACKS_UNIX_DOMAIN_SOCKETS)
  24
  25 #include "ace/SOCK.h"
  26
  27 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 /**
  30  * @class ACE_LSOCK
  31  *
  32  * @brief Create a Local ACE_SOCK, which is used for passing file
  33  * descriptors.
  34  */
  35 class ACE_Export ACE_LSOCK
  36 {
  37 public:
  38 #if defined (ACE_HAS_MSG)
  39   /// Send an open FD to another process.
  40   ssize_t send_handle (const ACE_HANDLE handle) const;
  41
  42   /// Recv an open FD from another process.
  43   ssize_t recv_handle (ACE_HANDLE &handles,
  44                        char *pbuf = 0,
  45                        ssize_t *len = 0) const;
  46 #endif /* ACE_HAS_MSG */
  47
  48   /// Dump the state of an object.
  49   void dump () const;
  50
  51   /// Declare the dynamic allocation hooks.
  52   ACE_ALLOC_HOOK_DECLARE;
  53
  54 protected:
  55   // = Ensure that ACE_LSOCK is an abstract base class
  56
  57   /// Default constructor.
  58   ACE_LSOCK ();
  59
  60   /// Initialize based on @a handle.
  61   ACE_LSOCK (ACE_HANDLE handle);
  62
  63   /// Get handle.
  64   ACE_HANDLE get_handle () const;
  65
  66   /// Set handle.
  67   void set_handle (ACE_HANDLE handle);
  68
  69 private:
  70   /// An auxiliary handle used to avoid virtual base classes...
  71   ACE_HANDLE aux_handle_;
  72 };
  73
  74 ACE_END_VERSIONED_NAMESPACE_DECL
  75
  76 #if defined (__ACE_INLINE__)
  77 #include "ace/LSOCK.inl"
  78 #endif /* __ACE_INLINE__ */
  79
  80 #endif /* ACE_LACKS_UNIX_DOMAIN_SOCKETS */
  81 #include /**/ "ace/post.h"
  82 #endif /* ACE_LOCAL_SOCK_H */