libnl  3.2.24-rc1
Callbacks/Customization

Related sections in the development guide: More...

Enumerations

enum  nl_cb_action {
  NL_OK,
  NL_SKIP,
  NL_STOP
}
 Callback actions. More...
 
enum  nl_cb_kind {
  NL_CB_DEFAULT,
  NL_CB_VERBOSE,
  NL_CB_DEBUG,
  NL_CB_CUSTOM,
  __NL_CB_KIND_MAX
}
 Callback kinds. More...
 
enum  nl_cb_type {
  NL_CB_VALID,
  NL_CB_FINISH,
  NL_CB_OVERRUN,
  NL_CB_SKIPPED,
  NL_CB_ACK,
  NL_CB_MSG_IN,
  NL_CB_MSG_OUT,
  NL_CB_INVALID,
  NL_CB_SEQ_CHECK,
  NL_CB_SEND_ACK,
  NL_CB_DUMP_INTR,
  __NL_CB_TYPE_MAX
}
 Callback types. More...
 

Callback Handle Management

struct nl_cb * nl_cb_alloc (enum nl_cb_kind kind)
 Allocate a new callback handle. More...
 
struct nl_cb * nl_cb_clone (struct nl_cb *orig)
 Clone an existing callback handle. More...
 
struct nl_cb * nl_cb_get (struct nl_cb *cb)
 
void nl_cb_put (struct nl_cb *cb)
 
enum nl_cb_type nl_cb_active_type (struct nl_cb *cb)
 Obtain type of current active callback. More...
 

Callback Setup

int nl_cb_set (struct nl_cb *cb, enum nl_cb_type type, enum nl_cb_kind kind, nl_recvmsg_msg_cb_t func, void *arg)
 Set up a callback. More...
 
int nl_cb_set_all (struct nl_cb *cb, enum nl_cb_kind kind, nl_recvmsg_msg_cb_t func, void *arg)
 Set up a all callbacks. More...
 
int nl_cb_err (struct nl_cb *cb, enum nl_cb_kind kind, nl_recvmsg_err_cb_t func, void *arg)
 Set up an error callback. More...
 

Overwriting

void nl_cb_overwrite_recvmsgs (struct nl_cb *cb, int(*func)(struct nl_sock *, struct nl_cb *))
 Overwrite internal calls to nl_recvmsgs() More...
 
void nl_cb_overwrite_recv (struct nl_cb *cb, int(*func)(struct nl_sock *, struct sockaddr_nl *, unsigned char **, struct ucred **))
 Overwrite internal calls to nl_recv() More...
 
void nl_cb_overwrite_send (struct nl_cb *cb, int(*func)(struct nl_sock *, struct nl_msg *))
 Overwrite internal calls to nl_send() More...
 

Callback Typedefs

typedef int(* nl_recvmsg_msg_cb_t )(struct nl_msg *msg, void *arg)
 nl_recvmsgs() callback for message processing customization More...
 
typedef int(* nl_recvmsg_err_cb_t )(struct sockaddr_nl *nla, struct nlmsgerr *nlerr, void *arg)
 nl_recvmsgs() callback for error message processing customization More...
 

Detailed Description

Related sections in the development guide:

Header

#include <netlink/handlers.h>

Typedef Documentation

typedef int(* nl_recvmsg_msg_cb_t)(struct nl_msg *msg, void *arg)

nl_recvmsgs() callback for message processing customization

Parameters
msgnetlink message being processed
argargument passwd on through caller

Definition at line 41 of file handlers.h.

typedef int(* nl_recvmsg_err_cb_t)(struct sockaddr_nl *nla, struct nlmsgerr *nlerr, void *arg)

nl_recvmsgs() callback for error message processing customization

Parameters
nlanetlink address of the peer
nlerrnetlink error message being processed
argargument passed on through caller

Definition at line 50 of file handlers.h.

Enumeration Type Documentation

Callback actions.

Enumerator
NL_OK 

Proceed with wathever would come next.

NL_SKIP 

Skip this message.

NL_STOP 

Stop parsing altogether and discard remaining messages.

Definition at line 59 of file handlers.h.

enum nl_cb_kind

Callback kinds.

Enumerator
NL_CB_DEFAULT 

Default handlers (quiet)

NL_CB_VERBOSE 

Verbose default handlers (error messages printed)

NL_CB_DEBUG 

Debug handlers for debugging.

NL_CB_CUSTOM 

Customized handler specified by the user.

Definition at line 72 of file handlers.h.

enum nl_cb_type

Callback types.

Enumerator
NL_CB_VALID 

Message is valid.

NL_CB_FINISH 

Last message in a series of multi part messages received.

NL_CB_OVERRUN 

Report received that data was lost.

NL_CB_SKIPPED 

Message wants to be skipped.

NL_CB_ACK 

Message is an acknowledge.

NL_CB_MSG_IN 

Called for every message received.

NL_CB_MSG_OUT 

Called for every message sent out except for nl_sendto()

NL_CB_INVALID 

Message is malformed and invalid.

NL_CB_SEQ_CHECK 

Called instead of internal sequence number checking.

NL_CB_SEND_ACK 

Sending of an acknowledge message has been requested.

NL_CB_DUMP_INTR 

Flag NLM_F_DUMP_INTR is set in message.

Definition at line 90 of file handlers.h.

Function Documentation

struct nl_cb* nl_cb_alloc ( enum nl_cb_kind  kind)
read

Allocate a new callback handle.

Parameters
kindcallback kind to be used for initialization
Returns
Newly allocated callback handle or NULL

Definition at line 201 of file handlers.c.

References nl_cb_err(), and nl_cb_set().

Referenced by nl_cb_clone(), and nl_socket_alloc().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

struct nl_cb* nl_cb_clone ( struct nl_cb *  orig)
read

Clone an existing callback handle.

Parameters
origoriginal callback handle
Returns
Newly allocated callback handle being a duplicate of orig or NULL

Definition at line 230 of file handlers.c.

References nl_cb_alloc(), and NL_CB_DEFAULT.

Referenced by nl_cache_mngr_data_ready(), nl_pickup(), and nl_wait_for_ack().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

enum nl_cb_type nl_cb_active_type ( struct nl_cb *  cb)

Obtain type of current active callback.

Parameters
cbcallback to query
Returns
type or __NL_CB_TYPE_MAX if none active

Definition at line 271 of file handlers.c.

int nl_cb_set ( struct nl_cb *  cb,
enum nl_cb_type  type,
enum nl_cb_kind  kind,
nl_recvmsg_msg_cb_t  func,
void *  arg 
)

Set up a callback.

Parameters
cbcallback set
typecallback to modify
kindkind of implementation
funccallback function (NL_CB_CUSTOM)
argargument passed to callback
Returns
0 on success or a negative error code

Definition at line 293 of file handlers.c.

References NL_CB_CUSTOM.

Referenced by nl_cache_mngr_data_ready(), nl_cb_alloc(), nl_cb_set_all(), nl_pickup(), nl_socket_disable_seq_check(), nl_socket_modify_cb(), and nl_wait_for_ack().

+ Here is the caller graph for this function:

int nl_cb_set_all ( struct nl_cb *  cb,
enum nl_cb_kind  kind,
nl_recvmsg_msg_cb_t  func,
void *  arg 
)

Set up a all callbacks.

Parameters
cbcallback set
kindkind of callback
funccallback function
argargument to be passwd to callback function
Returns
0 on success or a negative error code

Definition at line 322 of file handlers.c.

References nl_cb_set().

+ Here is the call graph for this function:

int nl_cb_err ( struct nl_cb *  cb,
enum nl_cb_kind  kind,
nl_recvmsg_err_cb_t  func,
void *  arg 
)

Set up an error callback.

Parameters
cbcallback set
kindkind of callback
funccallback function
argargument to be passed to callback function

Definition at line 343 of file handlers.c.

References NL_CB_CUSTOM.

Referenced by nl_cb_alloc(), and nl_socket_modify_err_cb().

+ Here is the caller graph for this function:

void nl_cb_overwrite_recvmsgs ( struct nl_cb *  cb,
int(*)(struct nl_sock *, struct nl_cb *)  func 
)

Overwrite internal calls to nl_recvmsgs()

Parameters
cbcallback set
funcreplacement callback for nl_recvmsgs()

Definition at line 372 of file handlers.c.

void nl_cb_overwrite_recv ( struct nl_cb *  cb,
int(*)(struct nl_sock *, struct sockaddr_nl *, unsigned char **, struct ucred **)  func 
)

Overwrite internal calls to nl_recv()

Parameters
cbcallback set
funcreplacement callback for nl_recv()

Definition at line 383 of file handlers.c.

void nl_cb_overwrite_send ( struct nl_cb *  cb,
int(*)(struct nl_sock *, struct nl_msg *)  func 
)

Overwrite internal calls to nl_send()

Parameters
cbcallback set
funcreplacement callback for nl_send()

Definition at line 395 of file handlers.c.