Menu
Extensibility Solutions
  • Plug-Ins
  • Tools
  • Filters
  • Scripts
    • Developer Documentation
  • OmniEngine Plugin API
  • OmniPeek Plugin API
  • OmniScript Reference
  • Peek COM API Reference
  • Decoder Language Reference
  • ProtoSpecs XML Guidelines
  • Peek Reporting Framework
  • Automation Primer
  • Plug-in Primer
    • Filter and/or slice a packet. More...

    List of all members.

    Public Member Functions

    HRESULT FilterPacket ([in] IPacket *pPacket,[out] USHORT *pusBytesToAccept,[out] GUID *pFilterID)

    Detailed Description

    Optional interface implemented by Distributed Analysis Modules and used by the Omnipeek console and Omnił Engine. This interface is exposed by a Distributed Analysis Module that needs to filter and/or slice packets captured by the engine or to filter and/or slice packets that are selected for filtering by Analysis Module in the console packet list.

    Member Function Documentation

    HRESULT IFilterPacket::FilterPacket (  [in] IPacket *  pPacket,
    [out] USHORT *  pusBytesToAccept,
    [out] GUID *  pFilterID
    ) 
     

    Allow a Distributed Analysis Module to filter and/or slice packets.

    Parameters:
    pPacket Pointer to an IPacket interface that allows the Distributed Analysis Module to get information about the packet.
    pusBytesToAccept Pointer to a variable that receives the sliced length of the packet.
    pFilterID Pointer to the filter's globally unique identifier.
    Return values:
    S_OK Packet is accepted by the Distributed Analysis Module
    S_FALSE Packet is rejected by the Distributed Analysis Module
    E_FAIL Error
    E_POINTER One of the pointers is invalid
    Remarks:
    This interface should not be implemented if the Distributed Analysis Module does not need to filter or slice packets. The slice length of the packet should be zero if the Distributed Analysis Module is not slicing the packet. If the capture running on the engine is also slicing packets, the packet will be sliced at the lesser of the capture slice length and the Distributed Analysis Module slice length.