UriScheme.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_ANYP_URISCHEME_H
#define SQUID_SRC_ANYP_URISCHEME_H
 
#include "anyp/ProtocolType.h"
#include "sbuf/SBuf.h"
 
#include <iosfwd>
#include <optional>
#include <vector>
 
namespace AnyP
{
 
using KnownPort = uint16_t;
 
using Port = std::optional<KnownPort>;
 
class UriScheme
{
public:
    typedef std::vector<SBuf> LowercaseSchemeNames;
 
    UriScheme() : theScheme_(AnyP::PROTO_NONE) {}
    UriScheme(AnyP::ProtocolType const aScheme, const char *img = nullptr);
    UriScheme(const AnyP::UriScheme &o) : theScheme_(o.theScheme_), image_(o.image_) {}
    UriScheme(AnyP::UriScheme &&) = default;
    ~UriScheme() {}
 
    AnyP::UriScheme& operator=(const AnyP::UriScheme &o) {
        theScheme_ = o.theScheme_;
        image_ = o.image_;
        return *this;
    }
    AnyP::UriScheme& operator=(AnyP::UriScheme &&) = default;
 
    operator AnyP::ProtocolType() const { return theScheme_; }
    // XXX: does not account for comparison of unknown schemes (by image)
    bool operator != (AnyP::ProtocolType const & aProtocol) const { return theScheme_ != aProtocol; }
 
    SBuf image() const {return image_;}
 
    Port defaultPort() const;
 
    static void Init();
 
    static AnyP::ProtocolType FindProtocolType(const SBuf &);
 
private:
    static LowercaseSchemeNames LowercaseSchemeNames_;
 
    AnyP::ProtocolType theScheme_;
 
    SBuf image_;
};
 
inline std::ostream &
operator <<(std::ostream &os, const UriScheme &scheme)
{
    os << scheme.image();
    return os;
}
 
} // namespace AnyP
 
#endif /* SQUID_SRC_ANYP_URISCHEME_H */