AttachDataFilterWithDestination Method of the IFWXConnection Interface

Article
08/13/2010

The AttachDataFilterWithDestination method attaches a data filter to the connection. The data filter is associated with a remote UDP destination.

Syntax

HRESULT AttachDataFilterWithDestination(
  [in]  IFWXDataFilter* piDataFilter,
  [in]  FwxDataFilterPriorityClass PriorityClass,
  [in]  IUnknown* punkFilterContext,
  [in]  LPSOCKADDR ExternalAddress,
  [in]  INT ExternalAddressLength
);

Parameters

piDataFilter
Pointer to the IFWXDataFilter interface on the data filter to use with this connection.
PriorityClass
Priority class for the data filter. This determines the position of the data filter in relation to other data filters that may be attached to the connection. This parameter is a value from the FwxDataFilterPriorityClass enumeration.
punkFilterContext
Pointer to the interface to use to pass context information to the data filter. This interface is passed to the IFWXDataFilter::SetSockets method. This parameter can be NULL.
ExternalAddress
Pointer to a sockaddr structure that contains the address of the peer of UDP datagrams for which the data filter is installed.

The data filter receives all datagrams sent through the connection but is removed if the service causes a destination to expire.
ExternalAddressLength
Length, in bytes, of the ExternalAddress parameter.

Return Value

S_OK
The method succeeded.
E_OUTOFMEMORY
Not enough memory or resources could be allocated to complete the operation.
FWX_E_TERMINATING
The object is shutting down.
E_INVALIDARG
An invalid value was passed to the method.

Remarks

This method must be called only in the context of the IFWXSessionFilter::FirewallEventHandler method while handling an event of type fwx_Udp_Destination. This method would be used when you want the filter to attach only to data from a specific destination, even if the connection is not destination specific, as is the case for UDP connections.

The data filter will receive all of the packets on the connection.

The data filter will be detached from the connection automatically if the UDP destination expires.

Requirements

Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
Header	Declared in Wspfwext.idl.
DLL	Requires Wspsrv.exe.

Share via