CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface IRequestJsonParser

    Request to IPC server

    Namespace: CAMIPC.IpcInteraction
    Assembly: CAMIPC.IpcInteraction.dll
    Syntax
    [Guid("9880F1CC-27FA-4BFF-818A-44F88198CAB4")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface IRequestJsonParser

    Properties

    Id

    Value provided in node ID. -1 equals null value

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

    InstanceId

    Value provided in node instance_id. Method will be called for this instance

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

    Method

    Value provided in node method

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

    Params

    Value provided in node params

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

    SenderIdent

    Identifier of client, who send this message

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

    TargetPid

    PID of the process this request is addressed to, 0 when the client did not name one. A peer is addressed by a port read from a file, and a port outlives the process that owned it — naming the process is what keeps a request from silently executing in a different one

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

    ThreadHandle

    Identifier of thread, which should run command if it is async

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

    ValueMethod

    Name of executing method

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

    ValueMethodIsAsync

    Method should be called in async mode

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

    Methods

    Clear()

    Clear all saved values

    Declaration
    void Clear()

    GetString(out TResultStatus)

    Declaration
    string GetString(out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    TResultStatus ResultStatus
    Returns
    Type Description
    string

    ReadString(string)

    Parse input string and fill self values

    Declaration
    TResultStatus ReadString(string inputString)
    Parameters
    Type Name Description
    string inputString
    Returns
    Type Description
    TResultStatus

    SetId(int)

    Declaration
    void SetId(int Id)
    Parameters
    Type Name Description
    int Id

    SetInstanceId(string)

    Set value provided in node instance_id. Method will be called for this instance

    Declaration
    void SetInstanceId(string InstanceId)
    Parameters
    Type Name Description
    string InstanceId

    SetMethod(string)

    Set value provided in node method

    Declaration
    void SetMethod(string Method)
    Parameters
    Type Name Description
    string Method

    SetParams(string)

    Set value provided in node params

    Declaration
    void SetParams(string Params)
    Parameters
    Type Name Description
    string Params

    SetSenderIdent(string)

    Set identifier of client, who send this message

    Declaration
    void SetSenderIdent(string SenderIdent)
    Parameters
    Type Name Description
    string SenderIdent

    SetTargetPid(int)

    Declaration
    void SetTargetPid(int TargetPid)
    Parameters
    Type Name Description
    int TargetPid

    SetThreadHandle(int)

    Declaration
    void SetThreadHandle(int ThreadHandle)
    Parameters
    Type Name Description
    int ThreadHandle
    In this article