modules/platforms/cpp/network/os/linux/src/network/linux_async_client_pool.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_LINUX_ASYNC_CLIENT_POOL
#define _IGNITE_NETWORK_LINUX_ASYNC_CLIENT_POOL

#include <stdint.h>
#include <map>

#include <ignite/ignite_error.h>

#include <ignite/common/concurrent.h>
#include <ignite/impl/interop/interop_memory.h>

#include <ignite/network/async_client_pool.h>
#include <ignite/network/async_handler.h>
#include <ignite/network/tcp_range.h>

#include "network/linux_async_worker_thread.h"
#include "network/linux_async_client.h"

namespace ignite
{
    namespace network
    {
        /**
         * Linux-specific implementation of asynchronous client pool.
         */
        class LinuxAsyncClientPool : public AsyncClientPool
        {
        public:
            /**
             * Constructor
             *
             * @param handler Upper level event handler.
             */
            LinuxAsyncClientPool();

            /**
             * Destructor.
             */
            virtual ~LinuxAsyncClientPool();

            /**
             * Start internal thread that establishes connections to provided addresses and asynchronously sends and
             * receives messages from them. Function returns either when thread is started and first connection is
             * established or failure happened.
             *
             * @param addrs Addresses to connect to.
             * @param connLimit Connection upper limit. Zero means limit is disabled.
             *
             * @throw IgniteError on error.
             */
            virtual void Start(const std::vector<TcpRange>& addrs, uint32_t connLimit);

            /**
             * Close all established connections and stops handling thread.
             */
            virtual void Stop();

            /**
             * Set handler.
             *
             * @param handler Handler to set.
             */
            virtual void SetHandler(AsyncHandler *handler)
            {
                asyncHandler = handler;
            }

            /**
             * Send data to specific established connection.
             *
             * @param id Client ID.
             * @param data Data to be sent.
             * @return @c true if connection is present and @c false otherwise.
             *
             * @throw IgniteError on error.
             */
            virtual bool Send(uint64_t id, const DataBuffer& data);

            /**
             * Closes specified connection if it's established. Connection to the specified address is planned for
             * re-connect. Event is issued to the handler with specified error.
             *
             * @param id Client ID.
             */
            virtual void Close(uint64_t id, const IgniteError* err);

            /**
             * Closes and releases memory allocated for client with specified ID.
             * Error is reported to handler.
             *
             * @param id Client ID.
             * @param err Error to report. May be null.
             * @return @c true if connection with specified ID was found.
             */
            void CloseAndRelease(uint64_t id, const IgniteError* err);

            /**
             * Add client to connection map. Notify user.
             *
             * @param client Client.
             * @return Client ID.
             */
            bool AddClient(SP_LinuxAsyncClient& client);

            /**
             * Handle error during connection establishment.
             *
             * @param addr Connection address.
             * @param err Error.
             */
            void HandleConnectionError(const EndPoint& addr, const IgniteError& err);

            /**
             * Handle successful connection establishment.
             *
             * @param addr Address of the new connection.
             * @param id Connection ID.
             */
            void HandleConnectionSuccess(const EndPoint& addr, uint64_t id);

            /**
             * Handle error during connection establishment.
             *
             * @param id Async client ID.
             * @param err Error. Can be null if connection closed without error.
             */
            void HandleConnectionClosed(uint64_t id, const IgniteError* err);

            /**
             * Handle new message.
             *
             * @param id Async client ID.
             * @param msg Received message.
             */
            void HandleMessageReceived(uint64_t id, const DataBuffer& msg);

            /**
             * Handle sent message event.
             *
             * @param id Async client ID.
             */
            void HandleMessageSent(uint64_t id);

        private:
             /**
             * Close all established connections and stops handling threads.
             */
            void InternalStop();

            /**
             * Find client by ID.
             *
             * @param id Client ID.
             * @return Client. Null pointer if is not found.
             */
            SP_LinuxAsyncClient FindClient(uint64_t id) const;

            /**
             * Find client by ID.
             *
             * @warning Should only be called with clientsCs lock held.
             * @param id Client ID.
             * @return Client. Null pointer if is not found.
             */
            SP_LinuxAsyncClient FindClientLocked(uint64_t id) const;

            /** Flag indicating that pool is stopping. */
            volatile bool stopping;

            /** Event handler. */
            AsyncHandler* asyncHandler;

            /** Worker thread. */
            LinuxAsyncWorkerThread workerThread;

            /** ID counter. */
            uint64_t idGen;

            /** Clients critical section. */
            mutable common::concurrent::CriticalSection clientsCs;

            /** Client mapping ID -> client */
            std::map<uint64_t, SP_LinuxAsyncClient> clientIdMap;
        };
    }
}

#endif //_IGNITE_NETWORK_LINUX_ASYNC_CLIENT_POOL