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
    • COM Wrapper for IPeekSimpleNodeStat. More...

    List of all members.

    Public Member Functions

    HRESULT IPAddr ([out, retval] BSTR *strIP)
    HRESULT BytesSent ([out, retval] DOUBLE *nBytesSent)
    HRESULT BytesReceived ([out, retval] DOUBLE *nBytesReceived)
    HRESULT PacketsSent ([out, retval] ULONG *nPacketsSent)
    HRESULT PacketsReceived ([out, retval] ULONG *nPacketsReceived)
    HRESULT LastTimeReceived ([out, retval] DATE *dLastTimeReceived)
    HRESULT LastTimeSent ([out, retval] DATE *dLastTimeSent)
    HRESULT Create ([in] ULONGLONG nBytesReceived,[in] ULONGLONG nBytesSent,[in] ULONGLONG nPacketsReceived,[in] ULONGLONG nPacketsSent,[in] DATE dLastTimeReceived,[in] DATE dLastTimeSent,[in] DATE dFirstTimeReceived,[in] DATE dFirstTimeSent,[in] BSTR strIPAddress)
    HRESULT FirstTimeSent ([out, retval] DATE *dFirstTimeSent)
    HRESULT FirstTimeReceived ([out, retval] DATE *dFirstTimeReceived)

    Detailed Description

    COM Wrapper for IPeekSimpleNodeStat.

    This interface is implemented by PeekSimpleNodeStat to wrap IPeekSimpleNodeStat for Scripting clients to a node's statistics.

    Member Function Documentation

    HRESULT IPeekSimpleNodeStat::BytesReceived (  [out, retval] DOUBLE *  nBytesReceived  ) 
     

    Get the node's number of received bytes.

    Parameters:
    nBytesReceived Received bytes.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::BytesSent (  [out, retval] DOUBLE *  nBytesSent  ) 
     

    Get the node's number of sent bytes.

    Parameters:
    nBytesSent Sent bytes.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::Create (  [in] ULONGLONG  nBytesReceived,
    [in] ULONGLONG  nBytesSent,
    [in] ULONGLONG  nPacketsReceived,
    [in] ULONGLONG  nPacketsSent,
    [in] DATE  dLastTimeReceived,
    [in] DATE  dLastTimeSent,
    [in] DATE  dFirstTimeReceived,
    [in] DATE  dFirstTimeSent,
    [in] BSTR  strIPAddress
    ) 
     

    Create a node with statistics.

    Parameters:
    nBytesReceived Number of received bytes.
    nBytesSent Number of sent bytes.
    nPacketsReceived Number of received packets.
    nPacketsSent Number of sent packets.
    dLastTimeReceived DATE of last time received.
    dLastTimeSent DATE of last time sent.
    dFirstTimeReceived DATE of first time received.
    dFirstTimeSent DATE of first time sent.
    strIPAddress IP address string.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::FirstTimeReceived (  [out, retval] DATE *  dFirstTimeReceived  ) 
     

    Get the node's first time received.

    Parameters:
    dFirstTimeReceived First time received.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::FirstTimeSent (  [out, retval] DATE *  dFirstTimeSent  ) 
     

    Get the node's first time sent.

    Parameters:
    dFirstTimeSent First time sent.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::IPAddr (  [out, retval] BSTR *  strIP  ) 
     

    Get the node's IP address.

    Parameters:
    strIP IP address.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::LastTimeReceived (  [out, retval] DATE *  dLastTimeReceived  ) 
     

    Get the node's last time received.

    Parameters:
    dLastTimeReceived Last time received.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::LastTimeSent (  [out, retval] DATE *  dLastTimeSent  ) 
     

    Get the node's last time sent.

    Parameters:
    dLastTimeSent Last time sent.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::PacketsReceived (  [out, retval] ULONG *  nPacketsReceived  ) 
     

    Get the node's number of received packets.

    Parameters:
    nPacketsReceived Received packets.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.
    HRESULT IPeekSimpleNodeStat::PacketsSent (  [out, retval] ULONG *  nPacketsSent  ) 
     

    Get the node's number of sent packets.

    Parameters:
    nPacketsSent Sent packets.
    Return values:
    S_OK Success.
    E_POINTER Invalid argument.
    Remarks:
    None.