mdnstxtrecord.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_MDNS
#include <cstdint>
#include <promeki/namespace.h>
#include <promeki/datatype.h>
#include <promeki/string.h>
#include <promeki/stringlist.h>
#include <promeki/list.h>
#include <promeki/buffer.h>
#include <promeki/result.h>
#include <promeki/error.h>
#include <promeki/function.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class DataStream;
class TextStream;
 
class MdnsTxtRecord {
        public:
                PROMEKI_DATATYPE(MdnsTxtRecord, DataTypeMdnsTxtRecord, 1)
 
                
                Error writeToStream(DataStream &s) const;
                template <uint32_t V> static Result<MdnsTxtRecord> readFromStream(DataStream &s);
 
                enum class Presence : uint8_t {
                        Absent  = 0,
                        KeyOnly = 1,
                        Empty   = 2,
                        Present = 3,
                };
 
                static constexpr int MaxEntryBytes = 255;
 
                MdnsTxtRecord() = default;
 
                void set(const String &key, const String &value);
 
                void setKey(const String &key);
 
                void setEmpty(const String &key);
 
                void remove(const String &key);
 
                void clear() { _entries.clear(); }
 
                Presence presence(const String &key) const;
 
                bool contains(const String &key) const { return presence(key) != Presence::Absent; }
 
                String value(const String &key, const String &defaultValue = String()) const;
 
                bool isEmpty() const { return _entries.isEmpty(); }
 
                int count() const { return static_cast<int>(_entries.size()); }
 
                StringList keys() const;
 
                void forEach(Function<void(const String &key, Presence p, const String &value)> func) const;
 
                Buffer encode() const;
 
                static Result<MdnsTxtRecord> decode(const Buffer &b);
 
                static Result<MdnsTxtRecord> decode(const uint8_t *bytes, size_t len);
 
                bool operator==(const MdnsTxtRecord &other) const;
                bool operator!=(const MdnsTxtRecord &other) const { return !(*this == other); }
 
        private:
                struct Entry {
                        using List = ::promeki::List<Entry>;
                        String   key;
                        Presence presence = Presence::Absent;
                        String   value;
                };
 
                // Returns the index of the entry whose key matches @p key
                // case-insensitively, or -1 if no entry exists.
                int findEntry(const String &key) const;
 
                // Returns the on-the-wire byte string for a single
                // entry, truncated at @ref MaxEntryBytes.  Defined as
                // a private static method so it can reach the private
                // @ref Entry layout without an anonymous-namespace
                // friend.
                static String entryToWire(const Entry &e);
 
                Entry::List _entries;
};
 
TextStream &operator<<(TextStream &stream, const MdnsTxtRecord &txt);
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_MDNS