Method RegisterForClientMessageEvent

Core/ClientSML/src/sml_ClientKernel.cpp:2208–2215

* @brief Register a handler for receiving generic messages sent from another client. * The content of the messages are up to the client and really aren't related to Soar, but providing the * ability to send a message from any client to any other client is sometimes useful. * * When the original client sends a message, the RHS function handler is called to process and (optional

* @returns Unique ID for this callback.  Required when unregistering this callback.
*************************************************************/
int Kernel::RegisterForClientMessageEvent(char const* pClientName, ClientMessageHandler handler, void* pUserData, bool addToBack)
{
    smlRhsEventId id = smlEVENT_CLIENT_MESSAGE ;
    
    // We actually use the RHS function code internally to process this message (since it's almost exactly like calling a RHS function that's
    // processed on a client).
    return InternalAddRhsFunction(id, pClientName, static_cast<RhsEventHandler>(handler), pUserData, addToBack) ;
}

/*************************************************************
* @brief Unregister for a particular client message