modules/platforms/cpp/odbc/include/ignite/odbc/protocol_version.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_ODBC_PROTOCOL_VERSION
#define _IGNITE_ODBC_PROTOCOL_VERSION

#include <stdint.h>

#include <string>
#include <set>

namespace ignite
{
    namespace odbc
    {
        /** Protocol version. */
        class ProtocolVersion
        {
        public:
            /** Version 2.1.0. */
            static const ProtocolVersion VERSION_2_1_0;

            /** Version 2.1.5: added "lazy" flag. */
            static const ProtocolVersion VERSION_2_1_5;

            /** Version 2.3.0: added "skipReducerOnUpdate" flag. */
            static const ProtocolVersion VERSION_2_3_0;

            /** Version 2.3.2: added multiple statements support. */
            static const ProtocolVersion VERSION_2_3_2;

            /** Version 2.5.0: added authentication and transactions support. */
            static const ProtocolVersion VERSION_2_5_0;

            /** Version 2.7.0: added fields precision and scale. */
            static const ProtocolVersion VERSION_2_7_0;

            /** Version 2.8.0: added column nullability info. */
            static const ProtocolVersion VERSION_2_8_0;

            typedef std::set<ProtocolVersion> VersionSet;

            /**
             * Get string to version map.
             *
             * @return String to version map.
             */
            static const VersionSet& GetSupported();

            /**
             * Get current version.
             *
             * @return Current version.
             */
            static const ProtocolVersion& GetCurrent();

            /**
             * Parse string and extract protocol version.
             *
             * @throw IgniteException if version can not be parsed.
             * @param version Version string to parse.
             * @return Protocol version.
             */
            static ProtocolVersion FromString(const std::string& version);

            /**
             * Convert to string value.
             *
             * @return Protocol version.
             */
            std::string ToString() const;

            /**
             * Default constructor.
             */
            ProtocolVersion();

            /**
             * Constructor.
             *
             * @param vmajor Major version part.
             * @param vminor Minor version part.
             * @param vmaintenance Maintenance version part.
             */
            ProtocolVersion(int16_t vmajor, int16_t vminor, int16_t vmaintenance);

            /**
             * Get major part.
             *
             * @return Major part.
             */
            int16_t GetMajor() const;

            /**
             * Get minor part.
             *
             * @return Minor part.
             */
            int16_t GetMinor() const;

            /**
             * Get maintenance part.
             *
             * @return Maintenance part.
             */
            int16_t GetMaintenance() const;

            /**
             * Check if the version is supported.
             *
             * @return True if the version is supported.
             */
            bool IsSupported() const;

            /**
             * Compare to another value.
             *
             * @param other Instance to compare to.
             * @return Zero if equeals, negative number if less and positive if more.
             */
            int32_t Compare(const ProtocolVersion& other) const;

            /**
             * Comparison operator.
             *
             * @param val1 First value.
             * @param val2 Second value.
             * @return True if equal.
             */
            friend bool operator==(const ProtocolVersion& val1, const ProtocolVersion& val2);

            /**
             * Comparison operator.
             *
             * @param val1 First value.
             * @param val2 Second value.
             * @return True if not equal.
             */
            friend bool operator!=(const ProtocolVersion& val1, const ProtocolVersion& val2);

            /**
             * Comparison operator.
             *
             * @param val1 First value.
             * @param val2 Second value.
             * @return True if less.
             */
            friend bool operator<(const ProtocolVersion& val1, const ProtocolVersion& val2);

            /**
             * Comparison operator.
             *
             * @param val1 First value.
             * @param val2 Second value.
             * @return True if less or equal.
             */
            friend bool operator<=(const ProtocolVersion& val1, const ProtocolVersion& val2);

            /**
             * Comparison operator.
             *
             * @param val1 First value.
             * @param val2 Second value.
             * @return True if gretter.
             */
            friend bool operator>(const ProtocolVersion& val1, const ProtocolVersion& val2);

            /**
             * Comparison operator.
             *
             * @param val1 First value.
             * @param val2 Second value.
             * @return True if gretter or equal.
             */
            friend bool operator>=(const ProtocolVersion& val1, const ProtocolVersion& val2);

        private:
            /** Set of supported versions. */
            const static VersionSet supported;

            /** Major part. */
            int16_t vmajor;

            /** Minor part. */
            int16_t vminor;

            /** Maintenance part. */
            int16_t vmaintenance;
        };
    }
}

#endif //_IGNITE_ODBC_PROTOCOL_VERSION