flowmatch_example_helper.h Source File

Reference Documentation
Platform
Napatech SmartNIC
Content Type
Reference Information
Capture Software Version
Link™ Capture Software 12.15
Napatech Software Suite: examples/flowmatch/flowmatch_example_helper.h Source File
flowmatch_example_helper.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2025 Napatech A/S. All Rights Reserved.
4  *
5  * 1. Copying, modification, and distribution of this file, or executable
6  * versions of this file, is governed by the terms of the Napatech Software
7  * license agreement under which this file was made available. If you do not
8  * agree to the terms of the license do not install, copy, access or
9  * otherwise use this file.
10  *
11  * 2. Under the Napatech Software license agreement you are granted a
12  * limited, non-exclusive, non-assignable, copyright license to copy, modify
13  * and distribute this file in conjunction with Napatech SmartNIC's and
14  * similar hardware manufactured or supplied by Napatech A/S.
15  *
16  * 3. The full Napatech Software License Agreement is included in this
17  * distribution, please see "NA-0009 Software License Agreement.pdf"
18  *
19  * 4. Redistributions of source code must retain this copyright notice,
20  * list of conditions and the following disclaimer.
21  *
22  * THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTIES, EXPRESS OR
23  * IMPLIED, AND NAPATECH DISCLAIMS ALL IMPLIED WARRANTIES INCLUDING ANY
24  * IMPLIED WARRANTY OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, OR OF
25  * FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY
26  * APPLICABLE LAW, IN NO EVENT SHALL NAPATECH BE LIABLE FOR PERSONAL INJURY,
27  * OR ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER,
28  * INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, CORRUPTION OR
29  * LOSS OF DATA, FAILURE TO TRANSMIT OR RECEIVE ANY DATA OR INFORMATION,
30  * BUSINESS INTERRUPTION OR ANY OTHER COMMERCIAL DAMAGES OR LOSSES, ARISING
31  * OUT OF OR RELATED TO YOUR USE OR INABILITY TO USE NAPATECH SOFTWARE OR
32  * SERVICES OR ANY THIRD PARTY SOFTWARE OR APPLICATIONS IN CONJUNCTION WITH
33  * THE NAPATECH SOFTWARE OR SERVICES, HOWEVER CAUSED, REGARDLESS OF THE THEORY
34  * OF LIABILITY (CONTRACT, TORT OR OTHERWISE) AND EVEN IF NAPATECH HAS BEEN
35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME JURISDICTIONS DO NOT ALLOW
36  * THE EXCLUSION OR LIMITATION OF LIABILITY FOR PERSONAL INJURY, OR OF
37  * INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS LIMITATION MAY NOT APPLY TO YOU.
38  *
39  *
40 
41  */
42 
43 #ifndef EXAMPLES_FLOWMATCH_FLOWMATCH_EXAMPLE_HELPER_H
44 #define EXAMPLES_FLOWMATCH_FLOWMATCH_EXAMPLE_HELPER_H
45 
46 #define COLOR_IPV4 0x1
47 #define COLOR_IPV6 0x2
48 
49 #define KEY_SET_ID 4
50 
51 #define STREAM_ID_MISS 1
52 #define STREAM_ID_UNHA 2
53 
54 #define KEY_ID_IPV4 1
55 #define KEY_ID_IPV6 2
56 
57 #define ADAPTER_NO 0
58 
59 /**
60  * Check if application is still running.
61  * @return true until applicationStop() has been called.
62  */
63 bool applicationRunning(void);
64 
65 /**
66  * Sets flag that causes applicationRunning() to return false.
67  */
68 void applicationStop(void);
69 
70 /**
71  * Check if status is an error code, and if it is print the error description
72  * and then quit the application.
73  */
74 void handleErrorStatus(int status, const char* message);
75 
76 /**
77  * Configure a port to enable or disable host-loopback.
78  * This function is used to allow the example code to be independent
79  * of a specific test setup.
80  */
81 void setHostLoopback(uint8_t port, bool enable);
82 
83 #endif // EXAMPLES_FLOWMATCH_FLOWMATCH_EXAMPLE_HELPER_H