ACE/ace/SOCK_Netlink.h

   1 //=============================================================================
   2 /**
   3  *  @file    SOCK_Netlink.h
   4  *
   5  *  @author Robert Iakobashvilli <coroberti@gmail.com>
   6  *  @author Raz Ben Yehuda <raziebe@013.net.il>
   7  */
   8 //=============================================================================
   9
  10 #ifndef ACE_SOCK_NETLINK_H
  11 #define ACE_SOCK_NETLINK_H
  12
  13 #include /**/ "ace/pre.h"
  14
  15 #include /**/ "ace/config-all.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18   #pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #ifdef ACE_HAS_NETLINK
  22
  23 #include "ace/SOCK.h"
  24 #include "ace/Netlink_Addr.h"
  25 #include "ace/Addr.h"
  26
  27 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 /**
  30  * @class ACE_SOCK_Netlink
  31  *
  32  * @brief Defines the member functions for the ACE_SOCK Netlink
  33  * abstraction.
  34
  35  * Netlink sockets are used in Linux as a communication facilty of kernel to user
  36  * and user to kernel.
  37  * This code was created so one could use ACE reactor
  38  * as a gateway to a linux kernel.
  39  */
  40 class ACE_Export ACE_SOCK_Netlink : public ACE_SOCK
  41 {
  42 public:
  43   /// Default constructor.
  44   ACE_SOCK_Netlink();
  45   ~ACE_SOCK_Netlink();
  46   ACE_SOCK_Netlink (ACE_Netlink_Addr &local,
  47                     int protocol_family,
  48                     int protocol);
  49   /**
  50    * opens a RAW socket over an ACE_SOCK and binds it
  51    *
  52    **/
  53   int open (ACE_Netlink_Addr &local,
  54             int protocol_family,
  55             int protocol);
  56
  57   /**
  58    *  receives abuffer with the size n
  59    */
  60   ssize_t recv (void *buf,
  61                 size_t n,
  62                 int flags) const;
  63   /**
  64    * send a buffer of size n bytes
  65    *
  66    */
  67   ssize_t send (void *buf,
  68                 size_t n,
  69                 int flags) const;
  70
  71   /**
  72    *  Recieves an iovec of size @a n to the netlink socket
  73   */
  74   ssize_t recv (iovec iov[],
  75                 int n,
  76                 ACE_Addr &addr,
  77                 int flags = 0) const;
  78
  79   /**
  80    *  Sends an iovec of size @a n to the netlink socket
  81   */
  82   ssize_t send (const iovec iov[],
  83                 int n,
  84                 const ACE_Addr &addr,
  85                 int flags = 0) const;
  86
  87   /// Declare the dynamic allocation hooks.
  88   ACE_ALLOC_HOOK_DECLARE;
  89 };
  90
  91 ACE_END_VERSIONED_NAMESPACE_DECL
  92
  93 #if defined (__ACE_INLINE__)
  94 #include "ace/SOCK_Netlink.inl"
  95 #endif /* __ACE_INLINE__ */
  96
  97 #endif /* ACE_HAS_NETLINK */
  98
  99 #include /**/ "ace/post.h"
 100
 101 #endif /* ACE_SOCK_NETLINK_H */
 102