Method ProcessIncomingSML

Core/ClientSML/src/sml_ClientKernel.cpp:396–469

* @brief This function is called (indirectly) when we receive a "call" SML * message from the kernel. *************************************************************/

*        message from the kernel.
*************************************************************/
ElementXML* Kernel::ProcessIncomingSML(Connection* pConnection, ElementXML* pIncomingMsg)
{
    // Create a reply
    ElementXML* pResponse = pConnection->CreateSMLResponse(pIncomingMsg) ;
    
    // Make sure the connection hasn't been closed along the way
    if (pConnection->IsClosed())
    {
        return pResponse ;
    }
    
    // Special case.  We want to intercept XML trace messages and pass them directly to the handler
    // without analyzing them.  This is just to boost performance for these messages as speed is critical here
    // as they're used for trace output.
    Agent* pAgent = IsXMLTraceEvent(pIncomingMsg) ;
    if (pAgent)
    {
        pAgent->ReceivedXMLTraceEvent(smlEVENT_XML_TRACE_OUTPUT, pIncomingMsg, pResponse) ;
        return pResponse ;
    }
    
    // Analyze the message and find important tags
    AnalyzeXML msg ;
    msg.Analyze(pIncomingMsg) ;
    
    // Get the "name" attribute from the <command> tag
    char const* pCommandName = msg.GetCommandName() ;
    
    // Look up the agent name parameter (most commands have this)
    char const* pAgentName = msg.GetArgString(sml_Names::kParamAgent) ;
    
    // Find the client agent structure that matches this agent
    if (pAgentName && pCommandName)
    {
        Agent* pAgent = GetAgent(pAgentName) ;
        
        // If this is a command for a known agent and it's an "output" command
        // then we're interested in it.
        if (pAgent && strcmp(sml_Names::kCommand_Output, pCommandName) == 0)
        {
            // Pass the incoming message over to the agent
            pAgent->ReceivedOutput(&msg, pResponse) ;
        }
        
        // If this is a command for a known agent and it's an "output_init" command
        // then we're interested in it. Note that this is a special case and
        // is not the spot for general init-soar event handling.
        if (pAgent && strcmp(sml_Names::kCommand_OutputInit, pCommandName) == 0)
        {
            // Remove the output link
            pAgent->GetWM()->InvalidateOutputLink();
        }
        
        if (pAgent && strcmp(sml_Names::kCommand_Event, pCommandName) == 0)
        {
            // This is an event specific to an agent, so handle it there.
            pAgent->ReceivedEvent(&msg, pResponse) ;
        }