stream_net_compat.h Source File

1 /*

2  *

3  * Copyright (C) 2023 Napatech A/S.

4  * All rights reserved.

5  *

6  * Redistribution and use in source and binary forms, with or without

7  * modification, are permitted provided that the following conditions are met:

8  * * Redistributions of source code must retain the above copyright

9  * notice, this list of conditions and the following disclaimer.

10  * * Redistributions in binary form must reproduce the above copyright

11  * notice, this list of conditions and the following disclaimer in the

12  * documentation and/or other materials provided with the distribution.

13  * * Neither the name of the Napatech A/S nor the

14  * names of its contributors may be used to endorse or promote products

15  * derived from this software without specific prior written permission.

16  *

17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

20  * DISCLAIMED. IN NO EVENT SHALL NAPATECH A/S BE LIABLE FOR ANY

21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

27  *

28  *

29 

30  */

31 

32 /**

33  * @file

34  *

35  * This is the header file of the STREAMTYPE_NET interface containing

36  * included for backward compatibility structures.

37  *

38  */

39 #ifndef __STREAM_NET_COMPAT_H__

40 #define __STREAM_NET_COMPAT_H__

41 

42 #if !defined(_NT_NTAPI_NO_COMPAT)

43 

44 /***********************************************************************************************/

45 /* Net file read version 0 */

46 /***********************************************************************************************/

47 

48 #define NT_NETFILE_READ_INFO_CMD NT_NETFILE_READ_COMPAT_0

49 

50 /**

51  * NetFile stream Info return structure

52  */

53 

54 typedef struct NtNetFileReadInfo_s {

55  uint64_t lastTimestamp; //!< The time stamp in the last packet in last the segment read using the function @ref NT_NetFileGet

56  uint64_t numberOfOctets; //!< Number of octets read from Netfile so far

57  uint32_t numberOfPackets; //!< Number of packets read from Netfile so far

58 } NtNetFileInfo_t;

59 

60 #endif // _NT_NTAPI_NO_COMPAT

61 #endif // __STREAM_NET_COMPAT_H__