blob: f3de3690a3b0c0777c47ad67042c86afe1c329a5 [file] [log] [blame]
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include <cms/Config.h>
namespace cms {
class Message;
* A <code>MessageListener</code> object is used to receive asynchronously
* delivered messages.
* @since 1.0
class CMS_API MessageListener {
virtual ~MessageListener();
* Called asynchronously when a new message is received, the message
* reference can be to any of the Message types. a dynamic cast is used
* to find out what type of message this is. The lifetime of this
* object is only guaranteed to be for life of the onMessage function
* after this call-back returns the message may no longer exists. Users should
* copy the data or clone the message if they wish to retain information that
* was contained in this Message.
* It is considered a programming error for this method to throw an
* exception. The method has been tagged with the 'throw()' qualifier,
* this implies that you application will segfault if you throw an error
* from an implementation of this method.
* @param message
* Message object {const} pointer recipient does not own.
virtual void onMessage(const Message* message) = 0;