modules/platforms/cpp/network/src/network/error_handling_filter.h

/*
 * 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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _IGNITE_NETWORK_ERROR_HANDLING_FILTER
#define _IGNITE_NETWORK_ERROR_HANDLING_FILTER

#include <ignite/network/data_filter_adapter.h>

namespace ignite
{
    namespace network
    {
        /**
         * Filter that handles exceptions thrown by upper level handlers.
         */
        class IGNITE_IMPORT_EXPORT ErrorHandlingFilter : public DataFilterAdapter
        {
        public:
            /**
             * Destructor.
             */
            virtual ~ErrorHandlingFilter()
            {
                // No-op.
            }

            /**
             * Callback that called on successful connection establishment.
             *
             * @param addr Address of the new connection.
             * @param id Connection ID.
             */
            virtual void OnConnectionSuccess(const EndPoint& addr, uint64_t id);

            /**
             * Callback that called on error during connection establishment.
             *
             * @param addr Connection address.
             * @param err Error.
             */
            virtual void OnConnectionError(const EndPoint& addr, const IgniteError& err);

            /**
             * Callback that called on error during connection establishment.
             *
             * @param id Async client ID.
             * @param err Error. Can be null if connection closed without error.
             */
            virtual void OnConnectionClosed(uint64_t id, const IgniteError* err);

            /**
             * Callback that called when new message is received.
             *
             * @param id Async client ID.
             * @param msg Received message.
             */
            virtual void OnMessageReceived(uint64_t id, const DataBuffer &msg);

            /**
             * Callback that called when message is sent.
             *
             * @param id Async client ID.
             */
            virtual void OnMessageSent(uint64_t id);
        };
    }
}

#endif //_IGNITE_NETWORK_ERROR_HANDLING_FILTER