Profishark API  2.3.12.0
Filters

Manage filters. More...

Data Structures

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 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

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

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
handlea handle to the device
[out]filtera ProfisharkApiDpiFilter that will hold the dpi filter configuration
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist

◆ ProfisharkAPIGetPacketFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetPacketFilter ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiPacketFilter filter 
)

Get packet filter configuration.

Parameters
handlea handle to the device
[out]filtera ProfisharkApiPacketFilter that will hold the packet filter configuration
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist

◆ ProfisharkAPISaveDpiFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISaveDpiFilter ( ProfisharkApiDeviceHandle  handle)

Save DPI filter configuration.

Parameters
handlea handle to the device
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist

◆ ProfisharkAPISavePacketFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISavePacketFilter ( ProfisharkApiDeviceHandle  handle)

Save packet filter configuration.

Parameters
handlea handle to the device
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist

◆ ProfisharkAPISetDpiFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDpiFilter ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiDpiFilter  filter 
)

Set DPI filter configuration.

Parameters
handlea handle to the device
filtera ProfisharkApiDpiFilter holding dpi filter configuration
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist

◆ ProfisharkAPISetPacketFilter()

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetPacketFilter ( ProfisharkApiDeviceHandle  handle,
ProfisharkApiPacketFilter  filter 
)

Set packet filter configuration.

Parameters
handlea handle to the device
filtera ProfisharkApiPacketFilter holding packet filter configuration
Return values
ProfisharkAPIRet_Successon success
ProfisharkAPIRet_NoDevif the device does not exist