client_properties.h

/*
 * Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed 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.
 */


#pragma once

#include <string>
#include <unordered_map>

#include "hazelcast/util/export.h"
#include "hazelcast/util/IOUtil.h"

#if  defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
#pragma warning(push)
#pragma warning(disable: 4251) //for dll export 
#endif

namespace hazelcast {
    namespace client {
        class client_config;

        class HAZELCAST_API client_property {
        public:
            client_property(const std::string &name, const std::string &default_value);

            const std::string &get_name() const;

            const std::string &get_default_value() const;

            const char *get_system_property() const;

        private:
            std::string name_;
            std::string default_value_;
        };


        class HAZELCAST_API client_properties {
        public:
            client_properties(const std::unordered_map<std::string, std::string> &properties);

            const client_property& get_heartbeat_timeout() const;

            const client_property& get_heartbeat_interval() const;

            const client_property& get_aws_member_port() const;

            const client_property &get_clean_resources_period_millis() const;

            const client_property &get_invocation_retry_pause_millis() const;

            const client_property &get_invocation_timeout_seconds() const;

            const client_property &get_event_thread_count() const;

            const client_property &get_internal_executor_pool_size() const;

            const client_property &get_shuffle_member_list() const;

            const client_property &get_max_concurrent_invocations() const;

            const client_property &get_backpressure_backoff_timeout_millis() const;

            const client_property &get_statistics_enabled() const;

            const client_property &get_statistics_period_seconds() const;

            const client_property &backup_timeout_millis() const;

            const client_property &fail_on_indeterminate_state() const;

            static const std::string PROP_HEARTBEAT_TIMEOUT;
            static const std::string PROP_HEARTBEAT_TIMEOUT_DEFAULT;

            static const std::string PROP_HEARTBEAT_INTERVAL;
            static const std::string PROP_HEARTBEAT_INTERVAL_DEFAULT;

            static const std::string PROP_REQUEST_RETRY_COUNT;
            static const std::string PROP_REQUEST_RETRY_COUNT_DEFAULT;

            static const std::string PROP_REQUEST_RETRY_WAIT_TIME;
            static const std::string PROP_REQUEST_RETRY_WAIT_TIME_DEFAULT;

            static const std::string PROP_AWS_MEMBER_PORT;
            static const std::string PROP_AWS_MEMBER_PORT_DEFAULT;

            static const std::string CLEAN_RESOURCES_PERIOD_MILLIS;
            static const std::string CLEAN_RESOURCES_PERIOD_MILLIS_DEFAULT;

            static const std::string INVOCATION_RETRY_PAUSE_MILLIS;
            static const std::string INVOCATION_RETRY_PAUSE_MILLIS_DEFAULT;

            static const std::string INVOCATION_TIMEOUT_SECONDS;
            static const std::string INVOCATION_TIMEOUT_SECONDS_DEFAULT;

            static const std::string EVENT_THREAD_COUNT;
            static const std::string EVENT_THREAD_COUNT_DEFAULT;


            static const std::string INTERNAL_EXECUTOR_POOL_SIZE;
            static const std::string INTERNAL_EXECUTOR_POOL_SIZE_DEFAULT;

            static const std::string SHUFFLE_MEMBER_LIST;
            static const std::string SHUFFLE_MEMBER_LIST_DEFAULT;

            static const std::string MAX_CONCURRENT_INVOCATIONS;
            static const std::string MAX_CONCURRENT_INVOCATIONS_DEFAULT;

            static const std::string BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS;
            static const std::string BACKPRESSURE_BACKOFF_TIMEOUT_MILLIS_DEFAULT;

            static const std::string STATISTICS_ENABLED;
            static const std::string STATISTICS_ENABLED_DEFAULT;

            static const std::string STATISTICS_PERIOD_SECONDS;
            static const std::string STATISTICS_PERIOD_SECONDS_DEFAULT;

            static constexpr const char * OPERATION_BACKUP_TIMEOUT_MILLIS = "hazelcast.client.operation.backup.timeout.millis";
            static constexpr const char * OPERATION_BACKUP_TIMEOUT_MILLIS_DEFAULT = "5000";

            static constexpr const char * FAIL_ON_INDETERMINATE_OPERATION_STATE = "hazelcast.client.operation.fail.on.indeterminate.state";
            static constexpr const char * FAIL_ON_INDETERMINATE_OPERATION_STATE_DEFAULT = "false";

            bool get_boolean(const client_property &property) const;

            int32_t get_integer(const client_property &property) const;

            int64_t get_long(const client_property &property) const;

            std::string get_string(const client_property &property) const;

        private:
            client_property heartbeat_timeout_;
            client_property heartbeat_interval_;
            client_property retry_count_;
            client_property retry_wait_time_;
            client_property aws_member_port_;
            client_property clean_resources_period_;
            client_property invocation_retry_pause_millis_;
            client_property invocation_timeout_seconds_;
            client_property event_thread_count_;
            client_property internal_executor_pool_size_;
            client_property shuffle_member_list_;
            client_property max_concurrent_invocations_;
            client_property backpressure_backoff_timeout_millis_;
            client_property statistics_enabled_;
            client_property statistics_period_seconds_;
            client_property backup_timeout_millis_;
            client_property fail_on_indeterminate_state_;

            std::unordered_map<std::string, std::string> properties_map_;
        };

    }
}

#if  defined(WIN32) || defined(_WIN32) || defined(WIN64) || defined(_WIN64)
#pragma warning(pop)
#endif