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

    • Get addresses and protocol information from a packet. More...

    List of all members.

    Public Member Functions
    HRESULT GetProtocol ([out] TMediaSpec *pSpec)
    HRESULT GetRawProtocol ([out] TMediaSpec *pSpec)
    HRESULT GetSrcPhysical ([out] TMediaSpec *pSpec)
    HRESULT GetDestPhysical ([out] TMediaSpec *pSpec)
    HRESULT GetSrcLogical ([out] TMediaSpec *pSpec)
    HRESULT GetDestLogical ([out] TMediaSpec *pSpec)
    HRESULT GetSrcPort ([out] TMediaSpec *pSpec)
    HRESULT GetDestPort ([out] TMediaSpec *pSpec)
    HRESULT GetBSSID ([out] TMediaSpec *pSpec)
    HRESULT GetReceiver ([out] TMediaSpec *pSpec)
    HRESULT GetTransmitter ([out] TMediaSpec *pSpec)
    HRESULT GetAddress1 ([out] TMediaSpec *pSpec)
    HRESULT GetAddress2 ([out] TMediaSpec *pSpec)
    HRESULT GetAddress3 ([out] TMediaSpec *pSpec)
    HRESULT GetAddress4 ([out] TMediaSpec *pSpec)

    Detailed Description

    This interface is implemented by the Omnił Engine and provides access to address and protocol information in a packet.

    Member Function Documentation

    HRESULT IPacketSpecs::GetAddress1 (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet address 1.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with address 1.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    This method should only be used on wireless packets.
    HRESULT IPacketSpecs::GetAddress2 (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet address 2.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with address 2.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    This method should only be used on wireless packets.
    HRESULT IPacketSpecs::GetAddress3 (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet address 3.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with address 3.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    This method should only be used on wireless packets.
    HRESULT IPacketSpecs::GetAddress4 (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet address 4.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with address 4.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    This method should only be used on wireless packets.
    HRESULT IPacketSpecs::GetBSSID (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet BSSID.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the BSSID.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    This method should only be used on wireless packets.
    HRESULT IPacketSpecs::GetDestLogical (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet destination logical address.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the destination logical address.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IPacketSpecs::GetDestPhysical (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet destination physical address.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the destination physical address.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IPacketSpecs::GetDestPort (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet destination port.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the destination port.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IPacketSpecs::GetProtocol (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet protocol in ProtoSpec format.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with protocol information.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    Use GetRawProtocol to get the "raw" protocol.
    HRESULT IPacketSpecs::GetRawProtocol (  [out] TMediaSpec *  pSpec  ) 
     

    Get the "raw" packet protocol (e.g., SNAP instead of ProtoSpec).

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with "raw" protocol information.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    Use GetProtocol to get the ProtoSpec corresponding to the protocol.
    HRESULT IPacketSpecs::GetReceiver (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet receiver.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the packet receiver.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    This method should only be used on wireless packets.
    HRESULT IPacketSpecs::GetSrcLogical (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet source logical address.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the source logical address.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IPacketSpecs::GetSrcPhysical (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet source physical address.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the source physical address.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IPacketSpecs::GetSrcPort (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet source port.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the source port.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    None
    HRESULT IPacketSpecs::GetTransmitter (  [out] TMediaSpec *  pSpec  ) 
     

    Get the packet transmitter.

    Parameters:
    pSpec Pointer to a TMediaSpec that is filled with the packet transmitter.
    Return values:
    S_OK Success
    E_FAIL Error
    E_POINTER The pointer is invalid.
    Remarks:
    This method should only be used on wireless packets.