• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  * \cond skip
3  * vim:syntax=doxygen
4  * \endcond
5 
6 \page auto_ack_warning Disabling Auto-ACK
7 
8 \attention Disabling Auto-ACK (nl_socket_disable_auto_ack()) will cause this
9            function to return immediately after sending the netlink message.
10 	   The function will not wait for an eventual error message. It is
11 	   the responsibility of the caller to handle any error messages or
12 	   ACKs returned.
13 
14 \page pointer_lifetime_warning Pointer Lifetime
15 
16 \attention The reference counter of the returned object is not incremented.
17            Therefore, the returned pointer is only valid during the lifetime
18 	   of the parent object. Increment the reference counter if the object
19 	   is supposed to stay around after the parent object was freed.
20 
21 \page private_struct Private Structure
22 
23 \note The definition of this structure is private to allow modification
24       without breaking API. Use the designated accessor functions to
25       access individual object attributes.
26 
27 \page read_only_attribute Read-Only Attribute
28 
29 \note The attribute this accessor is modifying is a read-only attribute
30       which can not be modified in the kernel. Any changes to the
31       attribute only have an effect on the local copy of the object. The
32       accessor function is provided solely for the purpose of creating
33       objects for comparison and filtering.
34 
35 \page low_level_api Low Level API
36 
37 \note This is a low level API function. A high level function implementing
38       the same functionality with a simplified usage pattern exists. This
39       function is available as an alternative if the default library
40       behaviour is not desirable.
41 
42 */
43