Method SendClientMessage

Core/ClientSML/src/sml_ClientKernel.cpp:2247–2260

* @brief Send a message to another client (not the Soar kernel). * The other client must have registered for this message to receive it. * * This mechanism allows one client to send an arbitrary string to another client and * get a response (as a string). The contents of the string are up to the clients to agree upon. * Passing a string is sufficient to support either

* @returns The response (if any) from the receiving client.  The string "**NONE**" is reserved to indicate nobody was registered for this event.
*************************************************************/
std::string Kernel::SendClientMessage(Agent* pAgent, char const* pClientName, char const* pMessage)
{
    AnalyzeXML response ;
    
    bool ok = GetConnection()->SendAgentCommand(&response, sml_Names::kCommand_SendClientMessage, pAgent ? pAgent->GetAgentName() : NULL, sml_Names::kParamName, pClientName, sml_Names::kParamMessage, pMessage) ;
    
    if (ok)
    {
        const char* pResponse = response.GetResultString() ;
        return pResponse ? pResponse : "" ;
    }
    
    return GetLastErrorDescription() ;
}

/*************************************************************
* @brief Unregister for a particular event