]>
git.proxmox.com Git - mirror_frr.git/blob - bgpd/bgp_io.h
2 * Implements packet I/O in a pthread.
3 * Copyright (C) 2017 Cumulus Networks
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
25 #define BGP_WRITE_PACKET_MAX 10U
26 #define BGP_READ_PACKET_MAX 10U
28 #include "bgpd/bgpd.h"
29 #include "frr_pthread.h"
32 * Start function for write thread.
36 extern void *bgp_io_start(void *arg
);
39 * Start function for write thread.
41 * Uninitializes all resources and stops the thread.
43 * @param result - where to store data result, unused
45 extern int bgp_io_stop(void **result
, struct frr_pthread
*fpt
);
48 * Turns on packet writing for a peer.
50 * After this function is called, any packets placed on peer->obuf will be
51 * written to peer->fd until no more packets remain.
53 * Additionally, it becomes unsafe to perform socket actions on peer->fd.
55 * @param peer - peer to register
57 extern void bgp_writes_on(struct peer
*peer
);
60 * Turns off packet writing for a peer.
62 * After this function returns, packets placed on peer->obuf will not be
63 * written to peer->fd by the I/O thread.
65 * After this function returns it becomes safe to perform socket actions on
68 * @param peer - peer to deregister
69 * @param flush - as described
71 extern void bgp_writes_off(struct peer
*peer
);
74 * Turns on packet reading for a peer.
76 * After this function is called, any packets received on peer->fd will be read
77 * and copied into the FIFO queue peer->ibuf.
79 * Additionally, it becomes unsafe to perform socket actions on peer->fd.
81 * Whenever one or more packets are placed onto peer->ibuf, a task of type
82 * THREAD_EVENT will be placed on the main thread whose handler is
84 * bgp_packet.c:bgp_process_packet()
86 * @param peer - peer to register
88 extern void bgp_reads_on(struct peer
*peer
);
91 * Turns off packet reading for a peer.
93 * After this function is called, any packets received on peer->fd will not be
94 * read by the I/O thread.
96 * After this function returns it becomes safe to perform socket actions on
99 * @param peer - peer to deregister
101 extern void bgp_reads_off(struct peer
*peer
);
103 #endif /* _FRR_BGP_IO_H */