dep/ACE_wrappers/ace/LSOCK.h

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