ErrorListener.h

Go to the documentation of this file.

/*
 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
 *
 * This software owned by Onix Solutions Limited [OnixS] and is protected by
 * copyright law and international copyright treaties.
 *
 * Access to and use of the software is governed by the terms of the applicable
 * ONIXS Software Services Agreement (the Agreement) and Customer end user
 * license agreements granting a non-assignable, non-transferable and
 * non-exclusive license to use the software for it's own data processing
 * purposes under the terms defined in the Agreement.
 *
 * Except as otherwise granted within the terms of the Agreement, copying or
 * reproduction of any part of this source code or associated reference material
 * to any other location for further reproduction or redistribution, and any
 * amendments to this copyright notice, are expressly prohibited.
 *
 * Any reproduction or redistribution for sale or hiring of the Software not in
 * accordance with the terms of the Agreement is a violation of copyright law.
 */

#pragma once

#include <OnixS/Senaf/MarketData/Error.h>
#include <OnixS/Senaf/MarketData/Export.h>

namespace OnixS { namespace Senaf { namespace MarketData {

/// \brief Defines the interface through which the Handler notifies subscribers
/// about errors occurred while processing messages from multicast channels.
class ErrorListener
{
public:
    /// Implement this member to get notified about errors in subscriptions.
    ///
    /// \param error identifies error occurred while processing multicast
    /// messages.
    ///
    /// \note Usually, Handler is capable to recover from errors by itself.
    /// That means, there's no need to restart entire subscription manually.
    /// Instead, Handler will perform all necessary recovering by itself.
    virtual void onError(const Error& error) = 0;

protected:
    virtual ~ErrorListener() {}
};

}}}