Method RegisterForStringEvent

Core/ClientSML/src/sml_ClientKernel.cpp:1993–2024

* @brief Register for an "StringEvent". * Multiple handlers can be registered for the same event. * @param smlEventId The event we're interested in (see the list below for valid values) * @param handler A function that will be called when the event happens * @param pUserData Arbitrary data that will be passed back to the handler function when the event happens. * @param addT

* @returns A unique ID for this callback (used to unregister the callback later)
*************************************************************/
int Kernel::RegisterForStringEvent(smlStringEventId id, StringEventHandler handler, void* pUserData, bool addToBack)
{
    // Start by checking if this id, handler, pUserData combination has already been registered
    TestStringCallbackFull test(id, handler, pUserData) ;
    
    // See if this handler is already registered
    StringEventHandlerPlusData plus(0, 0, 0, 0) ;
    bool found = m_StringEventMap.findFirstValueByTest(&test, &plus) ;
    
    if (found && plus.m_Handler != 0)
    {
        return plus.getCallbackID() ;
    }
    
    // If we have no handlers registered with the kernel, then we need
    // to register for this event.  No need to do this multiple times.
    if (m_StringEventMap.getListSize(id) == 0)
    {
        RegisterForEventWithKernel(id, NULL) ;
    }
    
    // Record the handler
    // We use a struct rather than a pointer to a struct, so there's no need to new/delete
    // everything as the objects are added and deleted.
    m_CallbackIDCounter++ ;
    
    StringEventHandlerPlusData handlerPlus(id, handler, pUserData, m_CallbackIDCounter) ;
    m_StringEventMap.add(id, handlerPlus, addToBack) ;
    
    // Return the ID.  We use this later to unregister the callback
    return m_CallbackIDCounter ;
}

/*************************************************************
* @brief Register for an "AgentEvent".