SharpPcap : SharpPcap.AirPcap Namespace

AirPcapDevice Class

AirPcap device

Syntax

public class AirPcapDevice : SharpPcap.WinPcap.WinPcapDevice

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Members

See Also: Inherited members from SharpPcap.WinPcap.WinPcapDevice.

Protected Fields

captureThread System.Threading.Thread . Thread that is performing the background packet capture (Inherited from SharpPcap.LibPcap.PcapDevice.)
m_pcapAdapterHandle IntPtr . Handle to a pcap adapter, not equal to IntPtr.Zero if an adapter is open (Inherited from SharpPcap.LibPcap.PcapDevice.)
m_pcapIf SharpPcap.LibPcap.PcapInterface . Low level interface object that contains device specific information (Inherited from SharpPcap.LibPcap.PcapDevice.)
m_pcapPacketCount int . Number of packets that this adapter should capture (Inherited from SharpPcap.LibPcap.PcapDevice.)
shouldCaptureThreadStop bool . Flag that indicates that a capture thread should stop (Inherited from SharpPcap.LibPcap.PcapDevice.)

Public Properties

[read-only]
Addresses System.Collections.ObjectModel.ReadOnlyCollection<SharpPcap.LibPcap.PcapAddress> . Addresses that represent this device (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
AirPcapLinkType AirPcapLinkTypes . Link type
[read-only]
Capabilities AirPcapDeviceCapabilities . Device capabilities, whether the device can transmit, its id, model name etc
Channel uint . Adapter channel
ChannelInfo AirPcapChannelInfo . Channel information
DecryptionState AirPcapDecryptionState . Tells if decryption of the incoming frames with the device-specific keys.
[read-only]
override
Description string . Gets the pcap description of this device (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
[read-only]
abstract
Description string . Description (Inherited from SharpPcap.LibPcap.PcapDevice.)
DeviceKeys List<AirPcapKey> . Decryption keys that are currently associated with the specified device
DriverDecryptionState AirPcapDecryptionState . Tells if this open instance is configured to perform the decryption of the incoming frames with the global set of keys.
DriverKeys List<AirPcapKey> . Global list of decryption keys that AirPcap is using with all the devices.
FcsPresence bool . Configures the adapter on whether to include the MAC Frame Check Sequence in the captured packets.
FcsValidation AirPcapValidationType . The kinds of frames that the device will capture By default all frames are captured
Filter string . Kernel level filtering expression associated with this device. For more info on filter expression syntax, see: http://www.winpcap.org/docs/docs31/html/group__language.html (Inherited from SharpPcap.LibPcap.PcapDevice.)
[read-only]
Flags uint . Interface flags, see pcap_findalldevs() man page for more info (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
[read-only]
Interface SharpPcap.LibPcap.PcapInterface . Documentation for this section has not yet been entered. (Inherited from SharpPcap.LibPcap.PcapDevice.)
override
KernelBufferSize uint . Kernel packet buffer size for this adapter in bytes
KernelBufferSize uint . Documentation for this section has not yet been entered. (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
[read-only]
override
LastError string . The last pcap error associated with this pcap device
[read-only]
LastError string . The last pcap error associated with this pcap device (Inherited from SharpPcap.LibPcap.PcapDevice.)
[read-only]
LedCount int . Number of leds on this adapter
[read-only]
override
LinkType PacketDotNet.LinkLayers . Link type in terms of PacketDotNet.LinkLayers
[read-only]
LinkType PacketDotNet.LinkLayers . Link type in terms of PacketDotNet.LinkLayers (Inherited from SharpPcap.LibPcap.PcapDevice.)
[read-only]
Loopback bool . True if device is a loopback interface, false if not (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
override
MacAddress System.Net.NetworkInformation.PhysicalAddress . Mac address
MacAddress System.Net.NetworkInformation.PhysicalAddress . Mac address of the physical device (Inherited from SharpPcap.LibPcap.PcapDevice.)
MacFlags AirPcapMacFlags . Mac flags
[write-only]
MinToCopy int . Documentation for this section has not yet been entered. (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
Mode SharpPcap.WinPcap.CaptureMode . Documentation for this section has not yet been entered. (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
[read-only]
override
Name string . Gets the pcap name of this network device (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
[read-only]
abstract
Name string . Device name (Inherited from SharpPcap.LibPcap.PcapDevice.)
NonBlockingMode bool . Set/Get Non-Blocking Mode. returns allways false for savefiles. (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
[read-only]
Opened bool . Return a value indicating if this adapter is opened (Inherited from SharpPcap.LibPcap.PcapDevice.)
[read-only]
Started bool . Return a value indicating if the capturing process of this adapter is started (Inherited from SharpPcap.LibPcap.PcapDevice.)
[read-only]
override
Statistics SharpPcap.ICaptureStatistics . Adapter statistics
[read-only]
override
Statistics SharpPcap.ICaptureStatistics . Retrieves pcap statistics (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
[read-only]
abstract
Statistics SharpPcap.ICaptureStatistics . Retrieves pcap statistics (Inherited from SharpPcap.LibPcap.PcapDevice.)
StopCaptureTimeout TimeSpan . Maximum time within which the capture thread must join the main thread (on SharpPcap.LibPcap.PcapDevice.StopCapture) or else the thread is aborted and an exception thrown. (Inherited from SharpPcap.LibPcap.PcapDevice.)
[read-only]
SupportedChannels List<AirPcapChannelInfo> . List of supported channels
[read-only]
Timestamp AirPcapDeviceTimestamp . Device timestamp
TxPower uint . Transmit power

Public Methods

Capture ()
Synchronously capture packets on this device. Method blocks forever. (Inherited from SharpPcap.LibPcap.PcapDevice.)
Capture (int)
Synchronously captures packets on this network device. This method will block until capturing is finished. (Inherited from SharpPcap.LibPcap.PcapDevice.)
override
Close ()
Close a device
override
Close ()
Close the device (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
Close ()
Closes this adapter (Inherited from SharpPcap.LibPcap.PcapDevice.)
Finalize ()
PcapDevice finalizer. Ensure PcapDevices are stopped and closed before exit. (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
GetNextPacket () : SharpPcap.RawCapture
Gets the next packet captured on this device (Inherited from SharpPcap.LibPcap.PcapDevice.)
GetNextPacket (out SharpPcap.RawCapture) : int
Gets the next packet captured on this device (Inherited from SharpPcap.LibPcap.PcapDevice.)
GetNextPacketPointers (ref IntPtr, ref IntPtr) : int
Gets pointers to the next PCAP header and packet data. Data is only valid until next call to GetNextPacketNative. Advanced use only. Intended to allow unmanaged code to avoid the overhead of marshalling PcapHeader and packet contents to allocated memory. (Inherited from SharpPcap.LibPcap.PcapDevice.)
Led (int, AirPcapDevice.LedState)
Constructor
override
Open ()
Open a device
override
Open ()
Open the device (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
override
Open ()
Open the device with default values of: promiscuous_mode = false, read_timeout = 1000 To start capturing call the 'StartCapture' function (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
abstract
Open ()
Open the device with class specific options (Inherited from SharpPcap.LibPcap.PcapDevice.)
override
Open (SharpPcap.DeviceMode)
Open the device. To start capturing call the 'StartCapture' function
override
Open (SharpPcap.DeviceMode)
Open the device. To start capturing call the 'StartCapture' function (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
Open (SharpPcap.DeviceMode)
Open the device. To start capturing call the 'StartCapture' function (Inherited from SharpPcap.LibPcap.PcapDevice.)
override
Open (SharpPcap.DeviceMode, int)
Open the device. To start capturing call the 'StartCapture' function
override
Open (SharpPcap.DeviceMode, int)
Open the device. To start capturing call the 'StartCapture' function (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
Open (SharpPcap.DeviceMode, int)
Open the device. To start capturing call the 'StartCapture' function (Inherited from SharpPcap.LibPcap.PcapDevice.)
override
Open (SharpPcap.WinPcap.OpenFlags, int)
Opens an Airpcap device with optional WinPcap.OpenFlags
Open (SharpPcap.WinPcap.OpenFlags, int)
Open a device with specific flags WinPcap extension - Use of this method will exclude your application from working on Linux or Mac (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
Open (SharpPcap.WinPcap.OpenFlags, int, SharpPcap.WinPcap.RemoteAuthentication)
Open (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
SendPacket (PacketDotNet.Packet)
Sends a raw packet throgh this device (Inherited from SharpPcap.LibPcap.PcapDevice.)
SendPacket (byte[])
Sends a raw packet throgh this device (Inherited from SharpPcap.LibPcap.PcapDevice.)
SendPacket (PacketDotNet.Packet, int)
Sends a raw packet throgh this device (Inherited from SharpPcap.LibPcap.PcapDevice.)
override
SendPacket (byte[], int)
Sends a raw packet throgh this device (Inherited from SharpPcap.LibPcap.LibPcapLiveDevice.)
SendPacket (byte[], int)
Sends a raw packet throgh this device (Inherited from SharpPcap.LibPcap.PcapDevice.)
SendQueue (SharpPcap.WinPcap.SendQueue, SharpPcap.WinPcap.SendQueueTransmitModes) : int
Sends all packets in a 'PcapSendQueue' out this pcap device (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
override
StartCapture ()
Starts the capturing process via a background thread OnPacketArrival() will be called for each captured packet NOTE: Winpcap devices can capture packets or statistics updates so only if both a packet handler AND a statistics handler are defined will an exception be thrown (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
StartCapture ()
Starts the capturing process via a background thread OnPacketArrival() will be called for each captured packet (Inherited from SharpPcap.LibPcap.PcapDevice.)
StopCapture ()
Stops the capture process Throws an exception if the stop capture timeout is exceeded and the capture thread was aborted (Inherited from SharpPcap.LibPcap.PcapDevice.)
override
ToString () : string
Override the default ToString() implementation (Inherited from SharpPcap.LibPcap.PcapDevice.)

Protected Methods

override
CaptureThread ()
AirPcap specific capture thread
CaptureThread ()
The capture thread (Inherited from SharpPcap.LibPcap.PcapDevice.)
MarshalPackets (IntPtr, IntPtr, out List<SharpPcap.RawCapture>)
Marshal a chunk of captured packets into a packet list
MarshalRawPacket (IntPtr, IntPtr) : SharpPcap.RawCapture
Convert an unmanaged packet into a managed PacketDotNet.RawPacket (Inherited from SharpPcap.LibPcap.PcapDevice.)
PacketHandler (IntPtr, IntPtr, IntPtr)
Pcap_loop callback method. (Inherited from SharpPcap.LibPcap.PcapDevice.)
SendCaptureStoppedEvent (SharpPcap.CaptureStoppedEventStatus)
Notify the delegates that are subscribed to the capture stopped event (Inherited from SharpPcap.LibPcap.PcapDevice.)
override
SendPacketArrivalEvent (SharpPcap.RawCapture)
Notify the OnPacketArrival delegates about a newly captured packet (Inherited from SharpPcap.WinPcap.WinPcapDevice.)
SendPacketArrivalEvent (SharpPcap.RawCapture)
Notify the OnPacketArrival delegates about a newly captured packet (Inherited from SharpPcap.LibPcap.PcapDevice.)
SetFilter (string)
Assign a filter to this device given a filterExpression (Inherited from SharpPcap.LibPcap.PcapDevice.)
ThrowIfNotOpen ()
See ThrowIfNotOpen(string ExceptionString)
ThrowIfNotOpen (string)
Helper method for checking that the adapter is open, throws an exception with a string of ExceptionString if the device isn't open (Inherited from SharpPcap.LibPcap.PcapDevice.)

Public Events

OnCaptureStopped Fired when the capture process of this pcap device is stopped (Inherited from SharpPcap.LibPcap.PcapDevice.)
OnPacketArrival Fires whenever a new packet is processed, either when the packet arrives from the network device or when the packet is read from the on-disk file. For network captured packets this event is invoked only when working in "PcapMode.Capture" mode. (Inherited from SharpPcap.LibPcap.PcapDevice.)
OnPcapStatistics Fires whenever a new pcap statistics is available for this Pcap Device. For network captured packets this event is invoked only when working in "PcapMode.Statistics" mode. (Inherited from SharpPcap.WinPcap.WinPcapDevice.)

Member Details

AirPcapLinkType Property

Link type

Syntax

public AirPcapLinkTypes AirPcapLinkType { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Capabilities Property

Device capabilities, whether the device can transmit, its id, model name etc

Syntax

public AirPcapDeviceCapabilities Capabilities { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

CaptureThread Method

AirPcap specific capture thread

Syntax

protected override void CaptureThread ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Channel Property

Adapter channel

Syntax

public uint Channel { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

ChannelInfo Property

Channel information

Syntax

public AirPcapChannelInfo ChannelInfo { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Close Method

Close a device

Syntax

public override void Close ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

DecryptionState Property

Tells if decryption of the incoming frames with the device-specific keys.

Syntax

public AirPcapDecryptionState DecryptionState { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

DeviceKeys Property

Decryption keys that are currently associated with the specified device

Syntax

public List<AirPcapKey> DeviceKeys { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

DriverDecryptionState Property

Tells if this open instance is configured to perform the decryption of the incoming frames with the global set of keys.

Syntax

public AirPcapDecryptionState DriverDecryptionState { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

DriverKeys Property

Global list of decryption keys that AirPcap is using with all the devices.

Syntax

public List<AirPcapKey> DriverKeys { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

FcsPresence Property

Configures the adapter on whether to include the MAC Frame Check Sequence in the captured packets.

Syntax

public bool FcsPresence { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

FcsValidation Property

The kinds of frames that the device will capture By default all frames are captured

Syntax

public AirPcapValidationType FcsValidation { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

KernelBufferSize Property

Kernel packet buffer size for this adapter in bytes

Syntax

public override uint KernelBufferSize { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

LastError Property

The last pcap error associated with this pcap device

Syntax

public override string LastError { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Led Method

Constructor

Syntax

public void Led (int ledIndex, AirPcapDevice.LedState newLedState)

Parameters

ledIndex
A int
newLedState
A SharpPcap.AirPcap.AirPcapDevice.LedState

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

LedCount Property

Number of leds on this adapter

Syntax

public int LedCount { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

LinkType Property

Link type in terms of PacketDotNet.LinkLayers

Syntax

public override PacketDotNet.LinkLayers LinkType { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

MacAddress Property

Mac address

Syntax

public override System.Net.NetworkInformation.PhysicalAddress MacAddress { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

MacFlags Property

Mac flags

Syntax

public AirPcapMacFlags MacFlags { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

MarshalPackets Method

Marshal a chunk of captured packets into a packet list

Syntax

protected virtual void MarshalPackets (IntPtr packetsBuffer, IntPtr bufferEnd, out List<SharpPcap.RawCapture> packets)

Parameters

packetsBuffer
bufferEnd
packets

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Open Method

Open a device

Syntax

public override void Open ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Open Method

Open the device. To start capturing call the 'StartCapture' function

Syntax

public override void Open (SharpPcap.DeviceMode mode)

Parameters

mode
A SharpPcap.DeviceMode

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Open Method

Open the device. To start capturing call the 'StartCapture' function

Syntax

public override void Open (SharpPcap.DeviceMode mode, int read_timeout)

Parameters

mode
A SharpPcap.DeviceMode
read_timeout
A int

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Open Method

Opens an Airpcap device with optional WinPcap.OpenFlags

Syntax

public override void Open (SharpPcap.WinPcap.OpenFlags flags, int read_timeout)

Parameters

flags
A WinPcap.OpenFlags
read_timeout
A int

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Statistics Property

Adapter statistics

Syntax

public override SharpPcap.ICaptureStatistics Statistics { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

SupportedChannels Property

List of supported channels

Syntax

public List<AirPcapChannelInfo> SupportedChannels { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

ThrowIfNotOpen Method

See ThrowIfNotOpen(string ExceptionString)

Syntax

protected void ThrowIfNotOpen ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

Timestamp Property

Device timestamp

Syntax

public AirPcapDeviceTimestamp Timestamp { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0

TxPower Property

Transmit power

Syntax

public uint TxPower { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: SharpPcap.AirPcap
Assembly: SharpPcap (in SharpPcap.dll)
Assembly Versions: 4.0.1.0