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