pulsar-client-cpp/lib/Hash.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 HASH_HPP_
#define HASH_HPP_

#include <cstdint>
#include <string>

namespace pulsar {
class Hash {
   public:
    virtual ~Hash() {}

    /**
     * Generate the hash of a given String
     *
     * @return The hash of {@param key}, which is non-negative integer.
     */
    virtual int32_t makeHash(const std::string& key) = 0;
};
}  // namespace pulsar

#endif /* HASH_HPP_ */