CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface IIpcServer

    Listener for socket to get commands through IPC

    Namespace: CAMIPC.IpcInteraction
    Assembly: CAMIPC.IpcInteraction.dll
    Syntax
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    [Guid("D7363E4E-8767-4DDE-971F-66D3B831F7C7")]
    public interface IIpcServer

    Properties

    Active

    Server is active and listening for some port

    Declaration
    bool Active { get; }
    Property Value
    Type Description
    bool

    Port

    Listening port by IPC server

    Declaration
    int Port { get; }
    Property Value
    Type Description
    int

    RequestsHandler

    Object to proceed requests on side of IPC server

    Declaration
    IRequestsHandler RequestsHandler { get; }
    Property Value
    Type Description
    IRequestsHandler

    Methods

    GetWrapper(string, out TResultStatus)

    Declaration
    IWrapperBase GetWrapper(string WrapperId, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    string WrapperId
    TResultStatus ResultStatus
    Returns
    Type Description
    IWrapperBase

    RegisterProjectWrapper(IWrapperBase, out TResultStatus)

    Declaration
    void RegisterProjectWrapper(IWrapperBase wrapper, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    IWrapperBase wrapper
    TResultStatus ResultStatus

    RegisterWrapper(IWrapperBase, out TResultStatus)

    Declaration
    void RegisterWrapper(IWrapperBase wrapper, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    IWrapperBase wrapper
    TResultStatus ResultStatus

    ReleaseProjectWrappers()

    Drop every wrapper registered by RegisterProjectWrapper. Call it while the project objects are still alive: a wrapped object is not kept alive by its wrapper, so releasing the wrapper afterwards walks freed memory

    Declaration
    void ReleaseProjectWrappers()

    Start(int, int, out TResultStatus)

    Declaration
    int Start(int MinPort, int MaxPort, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    int MinPort
    int MaxPort
    TResultStatus ResultStatus
    Returns
    Type Description
    int

    Stop(out TResultStatus)

    Declaration
    void Stop(out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    TResultStatus ResultStatus

    UnregisterWrapper(string)

    Unregister wrapper

    Declaration
    void UnregisterWrapper(string WrapperId)
    Parameters
    Type Name Description
    string WrapperId
    In this article