Method ReceiveMessages

Core/ConnectionSML/src/sml_EmbeddedConnectionAsynch.cpp:313–357

* @brief Retrieve any messages we've been sent and process them. * * Returns true if at least one message has been read. *************************************************************/

*           Returns true if at least one message has been read.
*************************************************************/
bool EmbeddedConnectionAsynch::ReceiveMessages(bool allMessages)
{
    // Make sure only one thread is sending messages at a time
    // (This allows us to run a separate thread in clients polling for events even
    //  when the client is sleeping, but we don't want them both to be sending/receiving at the same time).
    soar_thread::Lock lock(&m_ClientMutex) ;
    
    bool receivedMessage = false ;
    
    ElementXML* pIncomingMsg = PopIncomingMessageQueue() ;
    
    // While we have messages waiting to come in keep reading them
    while (pIncomingMsg)
    {
        // Record that we got at least one message
        receivedMessage = true ;
        
        // Pass this message back to the client and possibly get their response
        ElementXML* pResponse = this->InvokeCallbacks(pIncomingMsg) ;
        
        // If we got a response to the incoming message, send that response back.
        if (pResponse)
        {
            SendMsg(pResponse) ;
        }
        
        // We're done with the response
        delete pResponse ;
        
        // Record the last incoming message
        delete m_pLastResponse ;
        m_pLastResponse = pIncomingMsg ;
        
        // If we're only asked to read one message, we're done.
        if (!allMessages)
        {
            break ;
        }
        
        // Get the next message from the queue
        pIncomingMsg = PopIncomingMessageQueue() ;
    }
    
    return receivedMessage ;
}