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 EPR remote commands. More...

    List of all members.

    Public Member Functions

    HRESULT Connect ([in] BSTR hostName,[in] ULONG tcpPort,[in] ULONG timeout,[out, retval] enum RemoteCmdReturnType *pStatus)
    HRESULT ConnectWithCred ([in] BSTR hostName,[in] ULONG tcpPort,[in] BSTR domain,[in] BSTR user,[in] BSTR passwd,[in] ULONG timeout,[out, retval] enum RemoteCmdReturnType *pStatus)
    HRESULT Disconnect ([out, retval] enum RemoteCmdReturnType *pStatus)
    HRESULT GetRemoteAdapterList ([out, retval] IPeekRemoteAdapterList **pVal)
    HRESULT CreateNewCapture ([in] BSTR strName,[in] VARIANT_BOOL bIsContinuous,[in] VARIANT_BOOL bSaveToDisk,[in] ULONG lFileSize,[in] VARIANT_BOOL bStopSaveMB,[in] ULONG lSaveMB,[in] VARIANT_BOOL bStopSaveCount,[in] ULONG lSaveCount,[in] VARIANT_BOOL bSliceOn,[in] ULONG lSliceLen,[in] ULONG lBufferSize,[in] BSTR strAdapterName,[out, retval] BSTR *strCaptureGuid)
    HRESULT DeleteCapture ([in] BSTR strCaptureGuid)
    HRESULT GetCaptureList ([out, retval] IPeekRemoteCaptureList **ppCaptureList)
    HRESULT StartCapture ([in] BSTR strCaptureGuid)
    HRESULT StopCapture ([in] BSTR strCaptureGuid)
    HRESULT GetNodeList ([in] BSTR strCapID,[in, out] VARIANT *pTimeStamp,[out, retval] IPeekRemoteNodeList **ppRemoteNodeList)
    HRESULT SaveAllPackets ([in] BSTR captureID,[in] BSTR localFilename)
    HRESULT GetConversationList ([in] BSTR strCapID,[in, out] VARIANT *pTimeStamp,[out, retval] IPeekConversationList **ppRemoteConvList)
    HRESULT GetFileList (BSTR fileMask,[out, retval] IWPFileList **FileList)
    HRESULT SaveCapture ([in] BSTR CaptureID,[in] BSTR Filename,[in] BOOL OverWriteFlag,[out, retval] BSTR *SavedFilePath)
    HRESULT CreateNewCaptureFromTemplate ([in] IXMLDOMDocument *pCaptureTemplate,[out, retval] BSTR *strCaptureGuid)
    HRESULT GetFilters ([out, retval] IFilterCollection **ppFilterCollection)
    HRESULT SetFilters ([in] IFilterCollection *pFilterCollection,[in] enum MutableItemOpsType OpType)
    HRESULT ApplyFilterToCapture ([in] BSTR strCaptureGUID,[in] BSTR strFilterGUID,[in] enum PeekFilterMode filterMode)
    HRESULT CreateNewCaptureFromFile ([in] BSTR Name,[in] USHORT ReplayCount,[in] BSTR RemotePacketFilePath,[out, retval] BSTR *strCaptureGuid)
    HRESULT GetGraphTemplates ([out, retval] IGraphCollection **GraphTemplateCollection)
    HRESULT IsConnected ([out, retval] VARIANT_BOOL *pVal)
    HRESULT GetEngineStatus ([out, retval] IEngineStatus **status)
    HRESULT GetNodeListAll ([in] BSTR strCapID,[out, retval] IPeekRemoteNodeList **ppRemoteNodeList)
    HRESULT GetConversationListAll ([in] BSTR strCapID,[out, retval] IPeekConversationList **ppRemoteConvList)
    HRESULT DeleteRemoteFile (BSTR RemoteFilename)
    HRESULT StartMonitoring ([in] BSTR adapterName,[out, retval] VARIANT_BOOL *bSuccess)
     Returns data corresponding to a given graph item.
    HRESULT StopMonitoring ([out, retval] VARIANT_BOOL *bSuccess)
    HRESULT GetLatestMonitorStats ([out, retval] IMonitorStats **pMonitorStats)

    Detailed Description

    COM Wrapper for EPR remote commands.

    This interface is implemented by CWPRemoteCmdMgr to allow testing of communication protocol between clients and engines.

    Member Function Documentation

    HRESULT IWPRemoteCmdMgr::ApplyFilterToCapture (  [in] BSTR  strCaptureGUID,
    [in] BSTR  strFilterGUID,
    [in] enum PeekFilterMode  filterMode
    ) 
     

    Apply a filter to a capture.

    Parameters:
    strCaptureGUID String of the capture GUID.
    strFilterGUID String of the filter GUID.
    filterMode PeekFilterMode of mode filter is to run in.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::Connect (  [in] BSTR  hostName,
    [in] ULONG  tcpPort,
    [in] ULONG  timeout,
    [out, retval] enum RemoteCmdReturnType *  pStatus
    ) 
     

    Setup a connection to a remote agent.

    Parameters:
    hostName String of the hostname
    tcpPort ULONG of the tcpPort to connect to.
    timeout Amount of time.
    pStatus Pointer to a RemoteCmdReturnType which contains connection status.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call.
    S_FAIL Can't connect.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::ConnectWithCred (  [in] BSTR  hostName,
    [in] ULONG  tcpPort,
    [in] BSTR  domain,
    [in] BSTR  user,
    [in] BSTR  passwd,
    [in] ULONG  timeout,
    [out, retval] enum RemoteCmdReturnType *  pStatus
    ) 
     

    Setup a connection with credentials to a remote agent.

    Parameters:
    hostName String of the hostname
    tcpPort ULONG of the tcpPort to connect to.
    domain String of Windows domain to connect to.
    user String containing username.
    passwd String containing password.
    timeout ULONG containing connection timeout.
    pStatus Pointer to a RemoteCmdReturnType which contains connection status.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call.
    S_FAIL Can't connect.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::CreateNewCapture (  [in] BSTR  strName,
    [in] VARIANT_BOOL  bIsContinuous,
    [in] VARIANT_BOOL  bSaveToDisk,
    [in] ULONG  lFileSize,
    [in] VARIANT_BOOL  bStopSaveMB,
    [in] ULONG  lSaveMB,
    [in] VARIANT_BOOL  bStopSaveCount,
    [in] ULONG  lSaveCount,
    [in] VARIANT_BOOL  bSliceOn,
    [in] ULONG  lSliceLen,
    [in] ULONG  lBufferSize,
    [in] BSTR  strAdapterName,
    [out, retval] BSTR *  strCaptureGuid
    ) 
     

    Create a new connection on a remote agent.

    Parameters:
    strName String of new capture name.
    bIsContinuous VARIANT_BOOL of whether capture is continuous.
    bSaveToDisk VARIANT_BOOL of whether capture is to save to disk.
    lFileSize ULONG.
    bStopSaveMB VARIANT_BOOL.
    lSaveMB ULONG.
    bStopSaveCount VARIANT_BOOL.
    lSaveCount ULONG.
    bSliceOn VARIANT_BOOL of whether capture slicing is on.
    lSliceLen ULONG of slice length.
    lBufferSize ULONG of capture buffer size.
    strAdapterName String of adapter name.
    strCaptureGuid Pointer to a String of capture GUID of newly created capture.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_POINTER Invalid data String passed into strCaptureGuid.
    E_FAIL Can't create new capture..
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::CreateNewCaptureFromFile (  [in] BSTR  Name,
    [in] USHORT  ReplayCount,
    [in] BSTR  RemotePacketFilePath,
    [out, retval] BSTR *  strCaptureGuid
    ) 
     

    Create a new capture using a remote file adapter

    Parameters:
    Name String of new capture name.
    ReplayCount USHORT of 0 for replay for ever, 1 for once etc.
    RemotePacketFilePath BSTR Name of the packet trace file to be used as adapter
    strCaptureGuid Pointer to a String of capture GUID of newly created capture.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_POINTER Invalid data String passed into strCaptureGuid.
    E_FAIL Can't create new capture..
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::CreateNewCaptureFromTemplate (  [in] IXMLDOMDocument *  pCaptureTemplate,
    [out, retval] BSTR *  strCaptureGuid
    ) 
     

    Creates a new capture from a capture template.

    Parameters:
    pCaptureTemplate Pointer to a IXMLDOMDocument of a capture template.
    strCaptureGuid Pointer to a String of created capture GUID.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::DeleteCapture (  [in] BSTR  strCaptureGuid  ) 
     

    Deletes a specific capture.

    Parameters:
    strCaptureGuid String of the capture GUID to delete.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::DeleteRemoteFile (  BSTR  RemoteFilename  ) 
     

    Delete a file from an agent's data folder

    Parameters:
    RemoteFilename String of the remote file path.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::Disconnect (  [out, retval] enum RemoteCmdReturnType *  pStatus  ) 
     

    Close a connetion to a remote agent.

    Parameters:
    pStatus Pointer to a RemoteCmdReturnType which contains connection status.
    Return values:
    S_OK Success.
    S_FAIL Can't connect.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetCaptureList (  [out, retval] IPeekRemoteCaptureList **  ppCaptureList  ) 
     

    Gets the current remote agent capture list.

    Parameters:
    ppCaptureList Pointer to a Pointer pointing to a IPeekRemoteCaptureList containing captures.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_POINTER Invalid pointer passed in.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetConversationList (  [in] BSTR  strCapID,
    [in, out] VARIANT *  pTimeStamp,
    [out, retval] IPeekConversationList **  ppRemoteConvList
    ) 
     

    Returns conversations for the given capture.

    Parameters:
    strCapID String of capture GUID.
    pTimeStamp Pointer to a VARIANT which contains a time stamp.
    ppRemoteConvList Pointer to a Pointer to a IPeeConversationList.
    Return values:
    S_OK Success.
    E_POINTER Invalid pointer passed in.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetConversationListAll (  [in] BSTR  strCapID,
    [out, retval] IPeekConversationList **  ppRemoteConvList
    ) 
     

    Get the engine's list of conversations

    Parameters:
    strCapID capture ID
    ppRemoteConvList list of conversations
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_FAIL Other failures
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetEngineStatus (  [out, retval] IEngineStatus **  status  ) 
     

    Get the engine's status

    Parameters:
    status EngineStatus object
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_FAIL Other failures
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetFileList (  BSTR  fileMask,
    [out, retval] IWPFileList **  FileList
    ) 
     

    Gets a current list of capture files.

    Parameters:
    fileMask String of file filter.
    FileList IWPFileList containing the files.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetFilters (  [out, retval] IFilterCollection **  ppFilterCollection  ) 
     

    Returns current list of filters on agent.

    Parameters:
    ppFilterCollection Pointer to a Pointer of IFilterCollection of current filters on agent.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetGraphTemplates (  [out, retval] IGraphCollection **  GraphTemplateCollection  ) 
     

    Returns list of graphs that are associated with a particular capture

    Parameters:
    GraphTemplateCollection IGraphCollection** Object returned with the graph collection info.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_FAIL Other failures
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetLatestMonitorStats (  [out, retval] IMonitorStats **  pMonitorStats  ) 
     

    Returns data corresponding to a given graph item

    Parameters:
    pMonitorStats MonitorStats object.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_FAIL Other failures
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetNodeList (  [in] BSTR  strCapID,
    [in, out] VARIANT *  pTimeStamp,
    [out, retval] IPeekRemoteNodeList **  ppRemoteNodeList
    ) 
     

    Returns a list of remote nodes for a specified capture.

    Parameters:
    strCapID String of the capture GUID.
    pTimeStamp Pointer to a VARIANT which contains a time stamp.
    ppRemoteNodeList Pointer to a Pointer to a IRemoteNodeList.
    Return values:
    S_OK Success.
    E_POINTER Invalid pointer passed in.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetNodeListAll (  [in] BSTR  strCapID,
    [out, retval] IPeekRemoteNodeList **  ppRemoteNodeList
    ) 
     

    Get the engine's list of nodes

    Parameters:
    strCapID capture ID
    ppRemoteNodeList list of nodes
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_FAIL Other failures
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::GetRemoteAdapterList (  [out, retval] IPeekRemoteAdapterList **  pVal  ) 
     

    Get a list of remote adapters on the agent.

    Parameters:
    pVal Pointer to a Pointer to a remote adapter list.
    Return values:
    S_OK Success.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::IsConnected (  [out, retval] VARIANT_BOOL *  pVal  ) 
     

    Returns true or false indicating whether the Engine is connected.

    Parameters:
    pVal boolean for connected
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_FAIL Other failures
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::SaveAllPackets (  [in] BSTR  captureID,
    [in] BSTR  localFilename
    ) 
     

    Saves all packets in teh buffer as a local trace file.

    Parameters:
    captureID String of capture GUID.
    localFilename String of file name to save pkts to.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_POINTER No data returned from engine.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::SaveCapture (  [in] BSTR  CaptureID,
    [in] BSTR  Filename,
    [in] BOOL  OverWriteFlag,
    [out, retval] BSTR *  SavedFilePath
    ) 
     

    Saves a capture file on an agent.

    Parameters:
    CaptureID String of capture GUID.
    Filename String of file name.
    OverWriteFlag BOOL of whether to overwrite a duplicate named file.
    SavedFilePath Pointer to a String of path to save file on agent.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::SetFilters (  [in] IFilterCollection *  pFilterCollection,
    [in] enum MutableItemOpsType  OpType
    ) 
     

    Adds new filters to agent.

    Parameters:
    pFilterCollection Pointer to a IFilterCollection of filters to add to agent.
    OpType Mutable type.
    Return values:
    S_OK Success.
    E_INVALIDARG Invalid pointer passed in.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::StartCapture (  [in] BSTR  strCaptureGuid  ) 
     

    Starts the specified capture.

    Parameters:
    strCaptureGuid String of the capture GUID to start.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::StartMonitoring (  [in] BSTR  adapterName,
    [out, retval] VARIANT_BOOL *  bSuccess
    ) 
     

    Returns data corresponding to a given graph item.

    Starts a monitoring capture.

    Parameters:
    adapterName adapter name
    bSuccess for success
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_FAIL Other failures
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::StopCapture (  [in] BSTR  strCaptureGuid  ) 
     

    Stops the specified capture.

    Parameters:
    strCaptureGuid String of the capture GUID to stop.
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    Remarks:
    None.
    HRESULT IWPRemoteCmdMgr::StopMonitoring (  [out, retval] VARIANT_BOOL *  bSuccess  ) 
     

    Stops a monitoring capture.

    Parameters:
    bSuccess for success
    Return values:
    S_OK Success.
    E_PENDING Waiting for another call to finish.
    E_FAIL Other failures
    Remarks:
    None.