dep/ACE_wrappers/ace/Ping_Socket.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Ping_Socket.h
   6  *
   7  *  $Id: Ping_Socket.h 81737 2008-05-20 09:46:39Z johnnyw $
   8  *
   9  *  @author Robert S. Iakobashvili <coroberti@gmail.com> <coroberti@walla.co.il>
  10  *  @author Gonzalo A. Diethelm <gonzalo.diethelm@aditiva.com>
  11  */
  12 //=============================================================================
  13
  14 #ifndef ACE_PING_SOCKET_H
  15 #define ACE_PING_SOCKET_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_HAS_ICMP_SUPPORT) && (ACE_HAS_ICMP_SUPPORT == 1)
  26
  27 #include "ace/ICMP_Socket.h"
  28
  29 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  30
  31 class ACE_INET_Addr;
  32
  33 /**
  34  * @class ACE_Ping_Socket
  35  *
  36  * @brief This class is useful to perform ICMP echo checks (pinging)
  37  * on the party of your interest.  It may be used as well to check
  38  * LAN-adapters against 3rd parties.
  39  */
  40 class ACE_Export ACE_Ping_Socket : public ACE_ICMP_Socket
  41 {
  42   typedef ACE_ICMP_Socket inherited;
  43
  44 public:
  45
  46   // = Initialization and termination methods.
  47
  48   /// Default constructor.
  49   ACE_Ping_Socket (void);
  50
  51   ACE_Ping_Socket (ACE_Addr const & local,
  52                    int protocol    = IPPROTO_ICMP,
  53                    int reuse_addr  = 0);
  54
  55   /// Destructor.
  56   ~ACE_Ping_Socket (void);
  57
  58   /// Wrapper around the BSD-style @c socket system call (no QoS).
  59   int open (ACE_Addr const & local = ACE_Addr::sap_any,
  60             int protocol = IPPROTO_ICMP,
  61             int reuse_addr = 0);
  62
  63   /// @a toConnect = 1 - makes connect to remote address
  64   int send_echo_check (ACE_INET_Addr & remote_addr,
  65                        bool to_connect = false);
  66
  67   /// To receive @c ICMP_ECHOREPLY. To be called after successfully
  68   /// sending @c ICMP_ECHO.
  69   int process_incoming_dgram (char * ptr, ssize_t len);
  70
  71   /// @a toConnect = 1 - makes connect to remote address
  72   int make_echo_check (ACE_INET_Addr & remote_addr,
  73                        bool to_connect = false,
  74                        ACE_Time_Value const * timeout = &time_default_);
  75
  76   char * icmp_recv_buff (void);
  77
  78   /// Dump the state of an object.
  79   void dump (void) const;
  80
  81   /// Declare the dynamic allocation hooks.
  82   ACE_ALLOC_HOOK_DECLARE;
  83
  84 public:
  85
  86   enum
  87     {
  88       PING_BUFFER_SIZE = (1024 * 2)
  89     };
  90
  91   static ACE_Time_Value const time_default_;
  92
  93 private:
  94
  95   int receive_echo_reply (ACE_Time_Value const * timeout);
  96
  97   /// Do not allow this function to percolate up to this interface.
  98   int get_remote_addr (ACE_INET_Addr &addr) const;
  99
 100   char icmp_send_buff_[PING_BUFFER_SIZE];
 101   char icmp_recv_buff_[PING_BUFFER_SIZE];
 102
 103   ACE_UINT16 sequence_number_;
 104
 105   bool connected_socket_;
 106 };
 107
 108 ACE_END_VERSIONED_NAMESPACE_DECL
 109
 110 #if defined (__ACE_INLINE__)
 111 # include "ace/Ping_Socket.inl"
 112 #endif /* __ACE_INLINE__ */
 113
 114 #endif  /* ACE_HAS_ICMP_SUPPORT == 1 */
 115
 116 #include /**/ "ace/post.h"
 117
 118 #endif /* ACE_PING_SOCKET_H */