CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface IIpcMessageSender

    Sender for messages to IPC server

    Namespace: CAMIPC.IpcInteraction
    Assembly: CAMIPC.IpcInteraction.dll
    Syntax
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    [Guid("8B979F5B-E384-435F-B2D2-C54A2949DFB4")]
    public interface IIpcMessageSender

    Properties

    AsyncAnswersPort

    Port the answers of asynchronous commands are listened on, or 0 when StartAsyncAnswers was never called or was undone by StopAsyncAnswers

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

    ClientIdent

    Identifier this sender puts into the "sender" field of every request. The server keeps the answers port under exactly this name, so whoever registers the client has to register this very string

    Declaration
    string ClientIdent { get; }
    Property Value
    Type Description
    string

    Port

    Port, on which all messages will be sent

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

    Methods

    SendMessage(string, string, string, ref TExecuteContext)

    Declaration
    void SendMessage(string InstanceId, string commandName, string commandParams, ref TExecuteContext ExecuteContext)
    Parameters
    Type Name Description
    string InstanceId
    string commandName
    string commandParams
    TExecuteContext ExecuteContext

    StartAsyncAnswers(int, int, out TResultStatus)

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

    StopAsyncAnswers(out TResultStatus)

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

    WaitForLastAsyncCommand(int, out TResultStatus)

    Declaration
    void WaitForLastAsyncCommand(int timeout, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    int timeout
    TResultStatus ResultStatus
    In this article