Manage filters. More...

Data Structures
struct	ProfisharkApiPacketsTypeFilter
	Packets type filter configuration. More...

struct	ProfisharkApiDpiFilter
	DPI filter configuration. More...

struct	ProfisharkApiPacketFilter
	Packet filter configuration. More...

Enumerations
enum	ProfisharkApiPacketFilterFlags { ProfisharkApiPacketFilterFlags_isIPV6 = 0x1, ProfisharkApiPacketFilterFlags_dstMacEnabled = 0x2, ProfisharkApiPacketFilterFlags_srcMacEnabled = 0x4, ProfisharkApiPacketFilterFlags_dstIpEnabled = 0x8, ProfisharkApiPacketFilterFlags_srcIpEnabled = 0x10, ProfisharkApiPacketFilterFlags_dstPortEnabled = 0x20, ProfisharkApiPacketFilterFlags_srcPortEnabled = 0x40 }
	Flags that enable of disable filters fields. More...

enum	ProfisharkApiPacketFilterMode { ProfisharkApiPacketFilterMode_macIsOr = 0x1, ProfisharkApiPacketFilterMode_ipIsOr = 0x2, ProfisharkApiPacketFilterMode_portIsOr = 0x4 }
	Modes defining the comportement of packet filter fields. More...

Functions
PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISetPacketsTypeFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiPacketsTypeFilter filter)
	Set packets type filter configuration. More...

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetPacketsTypeFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiPacketsTypeFilter &filter)
	Get packets type filter configuration. More...

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISavePacketsTypeFilter (ProfisharkApiDeviceHandle handle)
	Save packets type filter configuration. More...

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISetDpiFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiDpiFilter filter)
	Set DPI filter configuration. More...

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetDpiFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiDpiFilter &filter)
	Get DPI filter configuration. More...

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISaveDpiFilter (ProfisharkApiDeviceHandle handle)
	Save DPI filter configuration. More...

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISetPacketFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiPacketFilter filter)
	Set packet filter configuration. More...

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetPacketFilter (ProfisharkApiDeviceHandle handle, ProfisharkApiPacketFilter &filter)
	Get packet filter configuration. More...

PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISavePacketFilter (ProfisharkApiDeviceHandle handle)
	Save packet filter configuration. More...

Detailed Description

Manage filters.

Enumeration Type Documentation

◆ ProfisharkApiPacketFilterFlags

enum ProfisharkApiPacketFilterFlags

Flags that enable of disable filters fields.

Enumerator
ProfisharkApiPacketFilterFlags_isIPV6	Source and destination IP addresses are in IPv6 format
ProfisharkApiPacketFilterFlags_dstMacEnabled	Destination mac filter is enabled
ProfisharkApiPacketFilterFlags_srcMacEnabled	Source mac filter is enabled
ProfisharkApiPacketFilterFlags_dstIpEnabled	Destination IP filter is enabled
ProfisharkApiPacketFilterFlags_srcIpEnabled	Source IP filter is enabled
ProfisharkApiPacketFilterFlags_dstPortEnabled	Destination port filter is enabled
ProfisharkApiPacketFilterFlags_srcPortEnabled	Source port filter is enabled

◆ ProfisharkApiPacketFilterMode

enum ProfisharkApiPacketFilterMode

Modes defining the comportement of packet filter fields.

Enumerator
ProfisharkApiPacketFilterMode_macIsOr	Only DestinationMAC is used and is compared to both the packet source and destination MAC address
ProfisharkApiPacketFilterMode_ipIsOr	Only DestinationIP is used and is compared to both the packet source and destination IP address
ProfisharkApiPacketFilterMode_portIsOr	Only DestinationPort is used and is compared to both the packet source and destination port

Function Documentation

◆ ProfisharkAPIGetDpiFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDpiFilter	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkApiDpiFilter &	filter
	)

Get DPI filter configuration.

Parameters

	handle	a handle to the device
[out]	filter	a ProfisharkApiDpiFilter that will hold the dpi filter configuration

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPIGetPacketFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetPacketFilter	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkApiPacketFilter &	filter
	)

Get packet filter configuration.

Parameters

	handle	a handle to the device
[out]	filter	a ProfisharkApiPacketFilter that will hold the packet filter configuration

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPIGetPacketsTypeFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetPacketsTypeFilter	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkApiPacketsTypeFilter &	filter
	)

Get packets type filter configuration.

Parameters

	handle	a handle to the device
[out]	filter	a ProfisharkApiPacketsTypeFilter that will hold the packets type filter configuration

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPISaveDpiFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISaveDpiFilter ( ProfisharkApiDeviceHandle handle )

Save DPI filter configuration.

Parameters

handle a handle to the device

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPISavePacketFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISavePacketFilter ( ProfisharkApiDeviceHandle handle )

Save packet filter configuration.

Parameters

handle a handle to the device

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPISavePacketsTypeFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISavePacketsTypeFilter ( ProfisharkApiDeviceHandle handle )

Save packets type filter configuration.

Parameters

handle a handle to the device

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPISetDpiFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDpiFilter	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkApiDpiFilter	filter
	)

Set DPI filter configuration.

Parameters

handle	a handle to the device
filter	a ProfisharkApiDpiFilter holding dpi filter configuration

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPISetPacketFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetPacketFilter	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkApiPacketFilter	filter
	)

Set packet filter configuration.

Parameters

handle	a handle to the device
filter	a ProfisharkApiPacketFilter holding packet filter configuration

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

◆ ProfisharkAPISetPacketsTypeFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetPacketsTypeFilter	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkApiPacketsTypeFilter	filter
	)

Set packets type filter configuration.

Parameters

handle	a handle to the device
filter	a ProfisharkApiPacketsTypeFilter holding packets type filter configuration

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ProfisharkApiPacketFilterFlags

◆ ProfisharkApiPacketFilterMode

Function Documentation

◆ ProfisharkAPIGetDpiFilter()

◆ ProfisharkAPIGetPacketFilter()

◆ ProfisharkAPIGetPacketsTypeFilter()

◆ ProfisharkAPISaveDpiFilter()

◆ ProfisharkAPISavePacketFilter()

◆ ProfisharkAPISavePacketsTypeFilter()

◆ ProfisharkAPISetDpiFilter()

◆ ProfisharkAPISetPacketFilter()

◆ ProfisharkAPISetPacketsTypeFilter()