WinDivert (jdivert 1.1 API)

java.lang.Object
- com.github.ffalcinelli.jdivert.WinDivert

```
public class WinDivert
extends java.lang.Object
```
A WinDivert handle that can be used to capture packets.
The main methods are open(), recv(), send(Packet) and close().
Created by fabio on 20/10/2016.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_PACKET_BUFFER_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PACKET_BUFFER_SIZE`

Constructor Summary

Constructors
Constructor and Description
`WinDivert(java.lang.String filter)` Create a new WinDivert instance based upon the given filter for `NETWORK` layer with priority set to 0 and in `DEFAULT` mode (Drop and divert packet).
`WinDivert(java.lang.String filter, Enums.Layer layer, int priority, Enums.Flag... flags)` Create a new WinDivert instance based upon the given parameters

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the handle opened by `open`.
`java.lang.String`	`getMode()` Returns the operational mode as a String
`long`	`getParam(Enums.Param param)` Get a WinDivert parameter.
`boolean`	`is(Enums.Flag flag)` Checks if the given flag is set
`boolean`	`isOpen()` Indicates if there is currently an open handle.
`WinDivert`	`open()` Opens a WinDivert handle for the given filter.
`Packet`	`recv()` Receives a diverted packet that matched the filter.
`Packet`	`recv(int bufsize)` Receives a diverted packet that matched the filter.
`int`	`send(Packet packet)` Injects a packet into the headers stack.
`int`	`send(Packet packet, boolean recalculateChecksum, Enums.CalcChecksumsOption... options)` Injects a packet into the headers stack.
`void`	`setParam(Enums.Param param, long value)` Set a WinDivert parameter.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_PACKET_BUFFER_SIZE
```
public static int DEFAULT_PACKET_BUFFER_SIZE
```
- Constructor Detail
  - WinDivert
```
public WinDivert(java.lang.String filter)
```
    Create a new WinDivert instance based upon the given filter for NETWORK layer with priority set to 0 and in DEFAULT mode (Drop and divert packet).
    
    Parameters:
    
    filter - The filter string expressed using WinDivert filter language.
  - WinDivert
```
public WinDivert(java.lang.String filter,
                 Enums.Layer layer,
                 int priority,
                 Enums.Flag... flags)
```
    Create a new WinDivert instance based upon the given parameters
    
    Parameters:
    
    filter - The filter string expressed using WinDivert filter language.
    
    layer - The layer
    
    priority - The priority of the handle
    
    flags - Additional flags
- Method Detail
  - open
```
public WinDivert open()
               throws WinDivertException
```
    Opens a WinDivert handle for the given filter.
    Unless otherwise specified by flags, any packet that matches the filter will be diverted to the handle.
    Diverted packets can be read by the application with recv.
    The remapped function is WinDivertOpen:
```
 HANDLE WinDivertOpen(
      __in const char *filter,
      __in WINDIVERT_LAYER layer,
      __in INT16 priority,
      __in UINT64 flags
 );
 
```
    For more info on the C call visit: http://reqrypt.org/windivert-doc.html#divert_open
    Returns:
    
    this instance to allow call chaining (e.g. Windivert w = new WinDivert("true").open())
    
    Throws:
    
    WinDivertException - Whenever the DLL call sets a LastError different by 0 (Success) or 997 (Overlapped I/O is in progress)
  - isOpen
```
public boolean isOpen()
```
    Indicates if there is currently an open handle.
    
    Returns:
    
    True if the handle is open, false otherwise
  - close
```
public void close()
```
    Closes the handle opened by open.
    The remapped function is WinDivertClose:
```
 BOOL WinDivertClose(
      __in HANDLE handle
 );
 
```
    For more info on the C call visit: http://reqrypt.org/windivert-doc.html#divert_close """
  - recv
```
public Packet recv()
            throws WinDivertException
```
    Receives a diverted packet that matched the filter.
    The return value is a packet.
    The remapped function is WinDivertRecv:
```
 BOOL WinDivertRecv(
      __in HANDLE handle,
      __out PVOID pPacket,
      __in UINT packetLen,
      __out_opt PWINDIVERT_ADDRESS pAddr,
      __out_opt UINT *recvLen
 );
 
```
    For more info on the C call visit: http://reqrypt.org/windivert-doc.html#divert_recv
    Returns:
    
    A Packet instance
    
    Throws:
    
    WinDivertException - Whenever the DLL call sets a LastError different by 0 (Success) or 997 (Overlapped I/O is in progress)
  - recv
```
public Packet recv(int bufsize)
            throws WinDivertException
```
    Receives a diverted packet that matched the filter.
    The return value is a packet.
    The remapped function is WinDivertRecv:
```
 BOOL WinDivertRecv(
      __in HANDLE handle,
      __out PVOID pPacket,
      __in UINT packetLen,
      __out_opt PWINDIVERT_ADDRESS pAddr,
      __out_opt UINT *recvLen
 );
 
```
    For more info on the C call visit: http://reqrypt.org/windivert-doc.html#divert_recv
    Parameters:
    
    bufsize - The size for the buffer to allocate
    
    Returns:
    
    A Packet instance
    
    Throws:
    
    WinDivertException - Whenever the DLL call sets a LastError different by 0 (Success) or 997 (Overlapped I/O is in progress)
  - send
```
public int send(Packet packet)
         throws WinDivertException
```
    Injects a packet into the headers stack.
    Recalculates the checksum before sending.
    The return value is the number of bytes actually sent.
    
    The injected packet may be one received from recv, or a modified version, or a completely new packet. Injected packets can be captured and diverted again by other WinDivert handles with lower priorities.
    The remapped function is WinDivertSend:
```
 BOOL WinDivertSend(
      __in HANDLE handle,
      __in PVOID pPacket,
      __in UINT packetLen,
      __in PWINDIVERT_ADDRESS pAddr,
      __out_opt UINT *sendLen
 );
 
```
    For more info on the C call visit: http://reqrypt.org/windivert-doc.html#divert_send
    Parameters:
    
    packet - The Packet to send
    
    Returns:
    
    The number of bytes actually sent
    
    Throws:
    
    WinDivertException - Whenever the DLL call sets a LastError different by 0 (Success) or 997 (Overlapped I/O is in progress)
  - send
```
public int send(Packet packet,
                boolean recalculateChecksum,
                Enums.CalcChecksumsOption... options)
         throws WinDivertException
```
    Injects a packet into the headers stack.
    Recalculates the checksum before sending unless recalculateChecksum=false is passed:
    - If recalculateChecksum=true then checksums are calculated using the given options.
    - If recalculateChecksum=false then options are ignored.
    The return value is the number of bytes actually sent.
    The injected packet may be one received from recv, or a modified version, or a completely new packet. Injected packets can be captured and diverted again by other WinDivert handles with lower priorities.
    The remapped function is WinDivertSend:
```
 BOOL WinDivertSend(
      __in HANDLE handle,
      __in PVOID pPacket,
      __in UINT packetLen,
      __in PWINDIVERT_ADDRESS pAddr,
      __out_opt UINT *sendLen
 );
 
```
    For more info on the C call visit: http://reqrypt.org/windivert-doc.html#divert_send
    Parameters:
    
    packet - The Packet to send
    
    recalculateChecksum - Whether to recalculate the checksums or pass the packet as is.
    
    options - A set of options to use when recalculating checksums.
    
    Returns:
    
    The number of bytes actually sent
    
    Throws:
    
    WinDivertException - Whenever the DLL call sets a LastError different by 0 (Success) or 997 (Overlapped I/O is in progress)
  - getParam
```
public long getParam(Enums.Param param)
```
    Get a WinDivert parameter. See Param for the list of parameters.
    The remapped function is WinDivertGetParam:
```
 BOOL WinDivertGetParam(
      __in HANDLE handle,
      __in WINDIVERT_PARAM param,
      __out UINT64 *pValue
 );
 
```
    For more info on the C call visit: http://reqrypt.org/windivert-doc.html#divert_get_param
    Parameters:
    
    param - The param to set
    
    Returns:
    
    The value for the parameter
  - setParam
```
public void setParam(Enums.Param param,
                     long value)
```
    Set a WinDivert parameter. See Param for the list of parameters.
    The remapped function is DivertSetParam:
```
 BOOL WinDivertSetParam(
      __in HANDLE handle,
      __in WINDIVERT_PARAM param,
      __in UINT64 value
 );
 
```
    For more info on the C call visit: http://reqrypt.org/windivert-doc.html#divert_set_param
    Parameters:
    
    param - The param to set
    
    value - The value for the parameter
  - is
```
public boolean is(Enums.Flag flag)
```
    Checks if the given flag is set
    
    Parameters:
    
    flag - The mode flag to set
    
    Returns:
    
    True if the flag is set, false otherwise.
  - getMode
```
public java.lang.String getMode()
```
    Returns the operational mode as a String
    
    Returns:
    
    String representation of the operational mode
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class WinDivert

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PACKET_BUFFER_SIZE

Constructor Detail

WinDivert

WinDivert

Method Detail

open

isOpen

close

recv

recv

send

send

getParam

setParam

is

getMode

toString