]>
git.proxmox.com Git - mirror_frr.git/blob - lib/frr_zmq.h
2 * libzebra ZeroMQ bindings
3 * Copyright (C) 2015 David Lamparter
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26 /* linking/packaging note: this is a separate library that needs to be
27 * linked into any daemon/library/module that wishes to use its
28 * functionality. The purpose of this is to encapsulate the libzmq
29 * dependency and not make libfrr/FRR itself depend on libzmq.
31 * libfrrzmq should be put in LDFLAGS/LIBADD *before* either libfrr or
32 * libzmq, and both of these should always be listed, e.g.
33 * foo_LDFLAGS = libfrrzmq.la libfrr.la $(ZEROMQ_LIBS)
38 * this is mostly here as a convenience, it has IPv6 enabled but nothing
39 * else is tied to it; you can use a separate context without problems
41 extern void *frrzmq_context
;
43 extern void frrzmq_init (void);
44 extern void frrzmq_finish (void);
46 #define debugargdef const char *funcname, const char *schedfrom, int fromln
48 /* core event registration, one of these 2 macros should be used */
49 #define frrzmq_thread_add_read_msg(m,f,a,z) funcname_frrzmq_thread_add_read( \
50 m,f,NULL,a,z,#f,__FILE__,__LINE__)
51 #define frrzmq_thread_add_read_part(m,f,a,z) funcname_frrzmq_thread_add_read( \
52 m,NULL,f,a,z,#f,__FILE__,__LINE__)
56 /* Set up a POLLIN notification to be called from the libfrr main loop.
57 * This has the following properties:
59 * - since ZeroMQ works with edge triggered notifications, it will loop and
60 * dispatch as many events as ZeroMQ has pending at the time libfrr calls
62 * - due to this looping (which means it non-single-issue), the callback is
63 * also persistent. Do _NOT_ re-register the event inside of your
65 * - either msgfunc or partfunc will be called (only one can be specified)
66 * - msgfunc is called once for each incoming message
67 * - if partfunc is specified, the message is read and partfunc is called
68 * for each ZeroMQ multi-part subpart. Note that you can't send replies
69 * before all parts have been read because that violates the ZeroMQ FSM.
70 * - you can safely cancel the callback from within itself
71 * - installing a callback will check for pending events (ZMQ_EVENTS) and
72 * may schedule the event to run as soon as libfrr is back in its main
75 * TODO #1: add ZMQ_POLLERR / error callback
76 * TODO #2: add frrzmq_check_events() function to check for edge triggered
77 * things that may have happened after a zmq_send() call or so
79 extern struct frrzmq_cb
*funcname_frrzmq_thread_add_read(
80 struct thread_master
*master
,
81 void (*msgfunc
)(void *arg
, void *zmqsock
),
82 void (*partfunc
)(void *arg
, void *zmqsock
,
83 zmq_msg_t
*msg
, unsigned partnum
),
84 void *arg
, void *zmqsock
, debugargdef
);
86 extern void frrzmq_thread_cancel(struct frrzmq_cb
*cb
);
88 #endif /* _FRRZMQ_H */