Table of Contents

Sending a call

Sending a call without expected return

    public static void SendMessages(SLProtocol protocol, int dmaId, int elementId)
    {
        // Prepare necessary mappings
        List<Type> knownTypes = new List<Type> { typeof(MyMessage) };

        // Create new IInterAppCall
        IInterAppCall myCommands = InterAppCallFactory.CreateNew();

        // Create the message
        MyMessage message = new MyMessage { MyProperty = "myValue" };

        // Add the message to the InterApp call
        myCommands.Messages.Add(message);

        // Send the InterApp call to the destinationElement
        // Parameter 9000000 (9 million) is the default parameter for InterApp call messages
        myCommands.Send(protocol.SLNet.RawConnection, dmaId, elementId, 9000000, knownTypes);
    }

Sending a call with expected return

    public static void SendMessages(SLProtocol protocol, int dmaId, int elementId)
    {
        // Prepare necessary mappings
        List<Type> knownTypes = new List<Type> { typeof(MyMessage), typeof(MyResponse) };
        Dictionary<Type, Type> msgToExecutor = new Dictionary<Type, Type>
        {
            { typeof(MyMessage), typeof(MySimpleMessageExecutor) }
        };

        // Create new IInterAppCall
        IInterAppCall myCommands = InterAppCallFactory.CreateNew();

        // Specify the return address
        myCommands.ReturnAddress = new ReturnAddress(dmaId, elementId, 9000001);

        // Create the message
        MyMessage message = new MyMessage { MyProperty = "myValue" };

        // Add the message to the InterApp call
        myCommands.Messages.Add(message);

        // Send the InterApp call to the destinationElement
        // Parameter 9000000 (9 million) is the default parameter for InterApp call messages
        IEnumerable<Message> responses = myCommands.Send(protocol.SLNet.RawConnection, dmaId, elementId, 9000000, TimeSpan.FromMinutes(1), knownTypes);

        // Handle the responses
        foreach (Message returnedMsg in responses)
        {
            returnedMsg.TryExecute(protocol, protocol, msgToExecutor, out Message optionalReturn);
        }
    }
Important

The parameter selected with the ReturnAddress must not be on the source element (the parameter 9000001 on the destination element is recommended). If you use a parameter on the element you are sending from, you will cause deadlocks. This happens because the sending QAction waits on a response, but the response cannot be set to the parameter because there is a QAction running (i.e. the one waiting on the response).

Note

When DataMiner version 10.3.12 or higher is used, the ReturnAddress is optional, as it is not used unless SLNet subscriptions are forcefully used. See Disabling message broker.

Propose changes