arp_cache.h
Go to the documentation of this file.
1 /**
2  * @file arp_cache.h
3  * @brief ARP cache management
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _ARP_CACHE_H
32 #define _ARP_CACHE_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "ipv4/arp.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //ARP related functions
44 void arpChangeState(ArpCacheEntry *entry, ArpState newState);
45 
48 
49 void arpFlushCache(NetInterface *interface);
50 
51 void arpSendQueuedPackets(NetInterface *interface, ArpCacheEntry *entry);
52 void arpFlushQueuedPackets(NetInterface *interface, ArpCacheEntry *entry);
53 
54 //C++ guard
55 #ifdef __cplusplus
56 }
57 #endif
58 
59 #endif
ArpCacheEntry * arpFindEntry(NetInterface *interface, Ipv4Addr ipAddr)
Search the ARP cache for a given IPv4 address.
Definition: arp_cache.c:156
uint32_t Ipv4Addr
IPv4 network address.
Definition: ipv4.h:297
void arpFlushQueuedPackets(NetInterface *interface, ArpCacheEntry *entry)
Flush packet queue.
Definition: arp_cache.c:262
#define NetInterface
Definition: net.h:36
ArpState
ARP cache entry states.
Definition: arp.h:127
void arpSendQueuedPackets(NetInterface *interface, ArpCacheEntry *entry)
Send packets that are waiting for address resolution.
Definition: arp_cache.c:222
void arpChangeState(ArpCacheEntry *entry, ArpState newState)
Update ARP cache entry state.
Definition: arp_cache.c:55
ARP cache entry.
Definition: arp.h:189
Ipv4Addr ipAddr
Definition: ipcp.h:105
ArpCacheEntry * arpCreateEntry(NetInterface *interface)
Create a new entry in the ARP cache.
Definition: arp_cache.c:74
TCP/IP stack core.
ARP (Address Resolution Protocol)
void arpFlushCache(NetInterface *interface)
Flush ARP cache.
Definition: arp_cache.c:188