/** * @file * @internal * Data structures used for a lightweight service protocol. */ /****************************************************************************** * Copyright (c) 2010-2014, AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _NS_PROTOCOL_H #define _NS_PROTOCOL_H #ifndef __cplusplus #error Only include IpNsProtocol.h in C++ code. #endif #include #include #include #include #include #include #include #include namespace ajn { /** * @defgroup name_service_protocol Name Service Protocol * @{ * Introduction * * One goal of AllJoyn is to allow clients of the bus to make Remote Procedure Calls * (RPC) or receive Signals from physically remote obejcts connected to the * bus as if they were local. Collections of RCP and Signal signatures, * typically called interfaces. Bus attachments are collections of interface * implementations and are described by so-called well-known or bus names. * Groups of one or more bus attachments are coordinated by AllJoyn daemon * processes that run on each host. Physically or logically distributed AllJoyn * daemons may be merged into a single virtual bus. * * One of the fundamental issues in distributing processes across different * hosts is the discovering the address and port of a given service. In the * case of AllJoyn, the communication endpoints of the various daemon processes * must be located so communication paths may be established. This lightweight * name service protocol provides a definition of a protocol for such a * process. * * Transport * * Name service protocol messages are expected to be transported * over UDP, typically over a well-known multicast group and port. A * UDP datagram carrying a name service message would appear like, * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | Source Port | Destination Port | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | Length | Checksum | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | Name Service Packet | * ~ ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * Strings * * Since well-known names are strings, one of the fundamental objects in * the protocol is the StringData object. Strings are encoded an octet * giving the length of the string, followed by some number UTF-8 characters. * (no terminating zero is required) For example, the string "STRING" * would be encoded as follows. The single octet length means that the * longest string possible is 255 characters. This should not prove to * be a problem since it is the same maximum length as a domain name, on * which bus names are modeled. * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 6 | S | T | R | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | I | N | G | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * IS-AT Message * * The IS-AT message is an "answer" message used to advertise the existence * of a number of bus names on a given AllJoyn daemon. IS-AT messages can * be sent as part of a response to a question, or they can be sent * gratuitously when an AllJoyn daemon decides to export the fact that it * supports some number of bus names. * * Version 0 * * Version zero of the protocol includes the following fields: * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |F S U T C G| M | Count | Port | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | IPv4Address present if 'F' bit is set | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * | IPv6Address present if 'S' bit is set | * | | * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * ~ Daemon GUID StringData present if 'G' bit is set ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * ~ Variable Number of StringData Records ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c M The message type of the IS-AT message. Defined to be '01' (1). * @li @c G If '1' indicates that a variable length daemon GUID string is present. * @li @c C If '1' indicates that the list of StringData records is a complete * list of all well-known names exported by the responding daemon. * @li @c T If '1' indicates that the responding daemon is listening on TCP. * @li @c U If '1' indicates that the responding daemon is listening on UDP. * @li @c S If '1' indicates that the responding daemon is listening on an IPv6 * address and that an IPv6 address is present in the message. If '0' * indicates is no IPv6 address present. * @li @c F If '1' indicates that the responding daemon is listening on an IPv4 * address and that an IPv4 address is present in the message. If '0' * indicates is no IPv4 address present. * @li @c Count The number of StringData items that follow. Each StringData item * describes one well-known bus name supported by the responding daemon. * @li @c Port The port on which the responding daemon is listening. * @li @c IPv4Address The IPv4 address on which the responding daemon is listening. * Present if the 'F' bit is set to '1'. * @li @c IPv6Address The IPv6 address on which the responding daemon is listening. * Present if the 'S' bit is set to '1'. * * Version 1 * * Version one of the protocol extends version zero to include the type of the * transport that is doing the advertisement and admit the possibility of * reliable and unreliable transports over both IPv4 and IPv6. * * The most general form of an advertisement containing this information includes * Four address/port pairs: * * R4: IPv4 address, port of a TCP-based endpoint present; * U4: IPv4 address, port of a UDP-based endpoint present; * R6: IPv6 address, port of a TCP-based endpoint present; * U6: IPv6 address, port of a UDP-based endpoint present. * * One can contemplate various optimizations which would allow us to elide * addresses in some case, but the complexity of managing such optimizations is * such that we do the simple thing and send a complete endpoint description for * every endpoint. It is the most general case and if we were able to optimize * all four addresses out we are talking about forty bytes. The code complexity * just doesn't seem worth it; and so the four cases above replace the F, S, U, * T bits of the version zero protocol. * * Since the port is now associated to the provided addresses, the port field in the version * zero is-at message becomes a TransportMask which indicates the AllJoyn transport that is making the * advertisement. * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |U R U R C G| M | Count | TransportMask | * |6 6 4 4 | | | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | R4 IPv4Address present if 'R4' bit is set | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | R4 Port if 'R4' bit is set | U4 Ipv4Address present if | * |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 'U4' bit is set | U4 Port if 'U4' bit is set | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * | R6 IPv6Address present if 'R6' bit is set | * | | * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | R6 Port if 'R6' bit is set | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | | * | U6 IPv6Address present if 'U6' bit is set | * | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | U6 Port if 'U6' bit is set | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * ~ Daemon GUID StringData present if 'G' bit is set ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * ~ Variable Number of StringData Records ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c M The message type of the IS-AT message. Defined to be '01' (1). * @li @c G If '1' indicates that a variable length daemon GUID string is present. * @li @c C If '1' indicates that the list of StringData records is a complete * list of all well-known names exported by the responding daemon. * @li @c R4 If '1' indicates that the IPv4 endpoint of a reliable method (TCP) * transport (IP address and port) is present * @li @c U4 If '1' indicates that the IPv4 endpoint of an unreliable method (UDP) * transport (IP address and port) is present * @li @c R6 If '1' indicates that the IPv6 endpoint of a reliable method (TCP) * transport (IP address and port) is present * @li @c U6 If '1' indicates that the IPv6 endpoint of an unreliable method (UDP) * transport (IP address and port) is present * @li @c Count The number of StringData items that follow. Each StringData item * describes one well-known bus name supported by the responding daemon. * @li @c TransportMask The bit mask of transport identifiers that indicates which * AllJoyn transport is making the advertisement. * * WHO-HAS Message * * The WHO-HAS message is a "question" message used to ask AllJoyn daemons if * they support one or more bus names. * * Version 0 * * Version zero of the protocol includes the following fields: * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |F S U T R R| M | Count | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | | * ~ Variable Number of StringData Records ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c M The message type of the WHO-HAS message. Defined to be '10' (2) * @li @c R Reserved bit. * @li @c T If '1' indicates that the requesting daemon wants to connect using * TCP. * @li @c U If '1' indicates that the requesting daemon wants to connect using * UDP. * @li @c S If '1' indicates that the responding daemon is interested in receiving * information about services accessible via IPv6 addressing. * @li @c F If '1' indicates that the responding daemon is interested in receiving * information about services accessible via IPv4 addressing. * @li @c Count The number of StringData items that follow. Each StringData item * describes one well-known bus name that the querying daemon is interested in. * * Version 1 * * Version one of the protocol removes the T, U, S and F bits; converting them to * reserved bits. The rationale is that passive observers of name service packets * could be interested in all available configurations and artificially limiting * responses could mislead those observers. * * Version one of the protocol includes the following fields: * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |R R R R R R| M | Count | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | | * ~ Variable Number of StringData Records ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c M The message type of the WHO-HAS message. Defined to be '10' (2) * @li @c R Reserved bit. * @li @c Count The number of StringData items that follow. Each StringData item * describes one well-known bus name that the querying daemon is interested in. * * Messages * * A name service message consists of a header, followed by a variable * number of question (Q) messages (for example, WHO-HAS) followed by a variable * number of answer(A) messages (for example, IS-AT). All messages are packed * to octet boundaries. * * Name Service Header * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | SVer | MVer | QCount | ACount | Timer | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c SVer The version (0...15) of the sender's latest implemented protocol. * @li @c MVer The version (0...15) of the actual message. * @li @c QCount The number of question messages that follow the header. * @li @c ACount The number of question messages that follow the question * messages. * @li @c Timer A count of seconds for which any answers should be considered * valid. A zero in this field means that the sending daemon is * withdrawing the advertisements. A value of 255 in this field means * "forever," or at least until withdrawn * * Example * * It is expected that when an AllJoyn daemon comes up, it will want to advertise * the fact that it is up and supports some number of bus names. It may also * be the case that the AllJoyn daemon already knows that it will need to find * some remote bus names when it comes up. In this case, it can send an initial * message that both announces its bus names, and asks for any other AllJoyn * daemons that support what it wants. * * Consider a daemon that is capable of dealing with IPv4 addresses, and is * listening on Port 9955 of IPv4 address "192.168.10.10" for incoming * connections. If the daemon is interested in locating another daemons that * supports the bus name "org.yadda.foo" and wants to export the fact that it * supports the bus name, "org.yadda.bar", and will support than name forever, * it might send a packet that combines WHO-HAS and IS-AT messages and that * looks something like * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |SVer= 1|MVer= 1| Q Count = 1 | A Count = 1 | Timer = 255 | (A) * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | WHO-HAS | Count = 1 | Count = 13 | 'o' | (B) (C) * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | 'r' 'g' '.' 'y' | * | | * | 'a' 'd' 'd' 'a' | * | | * | '.' 'f' 'o' 'o' | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | IS-AT | Count = 1 | 192 | 168 | (D) * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 10 10 | 9955 | Count = 13 | (E) * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 'o' 'r' 'g' '.' | * | | * | 'y' 'a' 'd' 'd' | * | | * | 'a' '.' 'b' 'a' | * | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 'r' | * +-+-+-+-+-+-+-+-+ * @endverbatim * * The notation (A) indicates the name service header. This header tells * us the Sender and message versions are one, there is one question and * one answer message following, and that the timeout value of any answer * messages present in this message is set to be 255 (infinite). * * The (B) section shows one question, which is a WHO-HAS message. The * flags present in the WHO-HAS message are not shown here. What follows * is the count of bus names present in this message (1). The bus name * shown here is "org.yadda.foo" (C). This name is contained in a * serialized SDATA (string data) message. The length of the string is * thirteen bytes, and the characters of the string follow. This ends * the question section of the messge since there was only one question * present as indicated by the header. * * Next, the (D) notation shows the single answer message described in * the header. Answer messages are called IS-AT messages. There is a * count of one bus name in the IS-AT messsage which, the message is * telling us, can be found at IPv4 address 192.168.10.10 port 9955. * The single SDATA record (E) with a count of 13 indicates that the * sending daemon supports the bus name "org.yadda.bar" at that address * and port. * @} End of "defgroup name_service_protocol" */ /** * @internal * @brief An abstract data type defining the operations that each element * of a name service protocol must implement. * * Every instance of a piece of the name service protocol must * have the capability of being serialized into a datagram and deserialized * from a datagram. It is also useful to be able to query an existing * object for how much buffer space it and its children will need in order * to be successfully serialized. * * This ADT class "enforces" the signatures of these functions. * * @ingroup name_service_protocol */ class ProtocolElement { public: /** * Virtual destructor for derivable class. */ virtual ~ProtocolElement() { } /** * @internal * @brief Get the size of a buffer that will allow the object and all of * its children to be successfully serialized * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(void) const = 0; /** * @internal * @brief Serialize this object and all of its children to the provided * buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer) const = 0; /** * @internal * @brief Deserialize this object and all of its children from the provided * buffer. * * An object implementing this method will attempt to read its wire * representation and construct an object representation. If there are * insuffucient bits in the buffer to do so, it will return a count of * zero bytes read. There is very little redundancy in a wire representation * to provide information for error checking, so if the UDP checksum of * the containing datagram indicates a successfully received message, a * protocol error will typically be reported through a zero return count * here. * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize) = 0; }; /** * @internal * @brief A class representing a name service StringData object. * * Since well-known names are strings, one of the fundamental objects in * the protocol is the StringData object. Strings are encoded an octet * giving the length of the string, followed by some number UTF-8 characters. * (no terminating zero is required) For example, the string "STRING" * would be encoded as follows. The single octet length means that the * longest string possible is 255 characters. This should not prove to * be a problem since it is the same maximum length as a domain name, on * which bus names are modeled. * * @ingroup name_service_protocol */ class StringData : public ProtocolElement { public: /** * @internal * @brief Construct a StringData object. The size of the string represented * by the object is initialized to 0 -- the null string. */ StringData(); /** * @internal * @brief Destroy a StringData object. */ ~StringData(); /** * @internal * @brief Set the string represented by this StringData object to the * provided string. * * @param string The well-known or bus name to be represented by this object. */ void Set(qcc::String string); /** * @internal * @brief Get the string represented by this StringData object. * * @return The well-known or bus name to represented by this object. */ qcc::String Get(void) const; /** * @internal * @brief Get the size of a buffer that will allow the object to be * successfully serialized * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this string to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize this string from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: /** * @internal * @brief The in-memory representation of the StringData object. */ qcc::String m_string; /** * @internal * @brief The size of the represented StringData object. */ size_t m_size; }; /** * @internal * @brief A class representing an authoritative answer in the name service * protocol. * * The IS-AT message is an answer message used to advertise the existence * of a number of bus names on a given AllJoyn daemon. IS-AT messages can * be sent as part of a response to a direct question, or they can be sent * gratuitously when an AllJoyn daemon decides to export the fact that it * supports some number of bus names. * * @ingroup name_service_protocol */ class IsAt : public ProtocolElement { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * name service protocol answer. */ IsAt(); /** * @internal * @brief Destroy a name service protocol answer object. */ ~IsAt(); /** * @internal * @brief Set the wire protocol version that the object will use. * * The name service protocol is versioned. For backward compatibility, we * need to be able to get down-version messages to "old" daemons and current * version messages to "new" daemons. The first thing to observe is that, * like most protocols, the wire protocol is versioned, not extensible. * This means that in order to support multiple versions, we will need to * send multiple messages. This introduces ambiguitiy in the receiver of * the messages since it cannot know whether or not "new" messages will * appear after 'old" ones. To resolve this ambiguity, the wire protocol * version is constructed of two versions: a message version and a sender * protocol version. * * If a new version of the protocol is defined, new senders will be modified * to generate the new version, and new receivers will be able to receive * new messages. The message version tells a receiver what the absolute * format of the current message is; and the sender protocol version * provides a context shared between the sender and the receiver that can * indicate more, or better, information may be forthcoming. * * The message version tells "this" object which version of the wire * protocol to use when serializing the bits and which version to expect * when deserializing the bits. The sender protocol version is meta-data * for higher level code. * * The version is found in the Header, so we will know for sure what version * the overall packet will take. Objects of class IsAt support all versions * known at the time of compilation. If the version of the wire protocol * read does not provide a value for a given field, a default value will be * provided. Objects of class IsAt can support writing down-version packets * for compatibility. * * It is up to higher levels to understand the contextual implications, if any, * of writing or reading down-version packets. * * @param nsVersion The version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion The version (0 .. 15) of the actual message. */ void SetVersion(uint32_t nsVersion, uint32_t msgVersion) { m_version = nsVersion << 4 | msgVersion; } /** * @internal * @brief Get the wire protocol version that the object will use. * * @param nsVersion Gets the version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion Gets the version (0 .. 15) of the actual message. * * @see SetVersion() */ void GetVersion(uint32_t& nsVersion, uint32_t& msgVersion) { nsVersion = m_version >> 4; msgVersion = m_version & 0xf; } /** * @internal * @brief Set the transport mask of the transport sending the advertisement * * The IP name service protocol can be used by a number of different AllJoyn * transports. These transports may need to build a wall around their own * advertisements so we provide the name service with a way to plumb the * advertisements from end-to-end according to transport. * * It is up to higher levels to understand the contextual implications, if any, * of peeking at other transports' advertisements or discovery requests. * * @param mask The transport mask of the object. */ void SetTransportMask(TransportMask mask) { m_transportMask = mask; } /** * @internal * @brief Get the transport mask of the transport that is sending the message. * * @return The transport mask of the transport that is sending the message. * * @see SetVersion() */ TransportMask GetTransportMask(void) { return m_transportMask; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this answer is providing its entire well-known name list. * * @param flag True if the daemon is providing the entire well-known name * list. */ void SetCompleteFlag(bool flag) { m_flagC = flag; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this answer is providing its entire well-known name list. * * @return True if the daemon is providing the entire well-known name * list. */ bool GetCompleteFlag(void) const { return m_flagC; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this answer is listening on a TCP socket. * * @param flag True if the daemon is listening on TCP. * * @warning Useful for version zero objects only. */ void SetTcpFlag(bool flag) { m_flagT = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on a TCP socket. * * @return True if the daemon is listening on TCP. * * @warning Useful for version zero objects only. */ bool GetTcpFlag(void) const { return m_flagT; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this answer is listening on a UDP socket. * * @param flag True if the daemon is listening on UDP. * * @warning Useful for version zero objects only. */ void SetUdpFlag(bool flag) { m_flagU = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on a UDP socket. * * @return True if the daemon is listening on UDP. * * @warning Useful for version zero objects only. */ bool GetUdpFlag(void) const { return m_flagU; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on a reliable IPv4 endpoint and has provided * a reliable IPv4 IP address and port. * * @return True if the daemon is listening on a reliable IPv4 endpoint. * * @warning Useful for version one objects only. */ bool GetReliableIPv4Flag(void) const { return m_flagR4; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on an unreliable IPv4 endpoint and has provided * an unreliable IPv4 IP address and port. * * @return True if the daemon is listening on an unreliable IPv4 endpoint. * * @warning Useful for version one objects only. */ bool GetUnreliableIPv4Flag(void) const { return m_flagU4; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on a reliable IPv6 endpoint and has provided * a reliable IPv6 IP address and port. * * @return True if the daemon is listening on a reliable IPv6 endpoint. * * @warning Useful for version one objects only. */ bool GetReliableIPv6Flag(void) const { return m_flagR6; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on an unreliable IPv6 endpoint and has provided * an unreliable IPv6 IP address and port. * * @return True if the daemon is listening on an unreliable IPv6 endpoint. * * @warning Useful for version one objects only. */ bool GetUnreliableIPv6Flag(void) const { return m_flagU6; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer has provided a GUID string. * * This flag is set to true by the SetGuid() call (or deserializing * a message for which the flag was set) and indicates that a daemon * GUID is provided in the message. * * @return True if the daemon has provided a GUID. */ bool GetGuidFlag(void) const { return m_flagG; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on an IPv6 address. * * This flag is set to true by the SetIPv6() call (or deserializing * a message for which the flag was set) and indicates that an IPv6 * address is provided in the message. * * @return True if the daemon is listening on IPv6. * * @warning Useful for version zero objects only. */ bool GetIPv6Flag(void) const { return m_flagS; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on an IPv4 address. * * This flag is set to true by the SetIPv4() call (or deserializing * a message for which the flag was set) and indicates that an IPv4 * address is provided in the message. * * @return True if the daemon is listening on IPv4. * * @warning Useful for version zero objects only. */ bool GetIPv4Flag(void) const { return m_flagF; } /** * @internal * @brief Set the GUID string for the responding name service. * * This method takes a string with the name service guid in "presentation" format * and arranges for it to be written out in the protocol message. Although * this is typically a string representation of a GUID, the string is not * interpreted by the protocol and can be used to carry any global (not * related to an individual well-known name) information related to the * generating daemon. * * @param guid The name service GUID string of the responding name service. */ void SetGuid(const qcc::String& guid); /** * @internal * @brief Get the name service GUID string for the responding daemon. * * This method returns a string with the guid in "presentation" format. * Although this is typically a string representation of a GUID, the string * is not interpreted by the protocol and can be used to carry any global * (not related to an infividual well-known name) information related to the * generating daemon. * * @return The GUID string of the responding name service. */ qcc::String GetGuid(void) const; /** * @internal * @brief Set the port on which the daemon generating this answer is * listening. * * @param port The port on which the daemon is listening. * * @warning Useful for version zero objects only. */ void SetPort(uint16_t port); /** * @internal * @brief Get the port on which the daemon generating this answer is * listening. * * @return The port on which the daemon is listening. * * @warning Useful for version zero objects only. */ uint16_t GetPort(void) const; /** * @internal * @brief Clear the IPv4 address. * * @warning Useful for version zero objects only. */ void ClearIPv4(void); /** * @internal * @brief Set the IPv4 address on which the daemon generating this answer * is listening. * * This method takes an IPv4 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (32-bits, big endian). It also has the side-effect of setting * the IPv4 flag. * * @param ipv4Addr The IPv4 address on which the daemon is listening. * * @warning Useful for version zero objects only. */ void SetIPv4(qcc::String ipv4Addr); /** * @internal * @brief Get the IPv4 address on which the daemon generating this answer * is listening. * * This method returns an IPv4 address string in presentation format. * If the IPv4 flag is not set, the results are undefined. * * @return The IPv4 address on which the daemon is listening. * * @warning Useful for version zero objects only. */ qcc::String GetIPv4(void) const; /** * @internal * @brief Clear the IPv6 address. * @warning Useful for version zero objects only. */ void ClearIPv6(void); /** * @internal * @brief Set the IPv6 address on which the daemon generating this answer * is listening. * * This method takes an IPv6 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (128-bits, big endian). It also has the side-effect of setting * the IPv6 flag. * * @param ipv6Addr The IPv6 address on which the daemon is listening. * * @warning Useful for version zero objects only. */ void SetIPv6(qcc::String ipv6Addr); /** * @internal * @brief Get the IPv6 address on which the daemon generating this answer * is listening. * * This method returns an IPv6 address string in presentation format. * If the IPv6 flag is not set, the results are undefined. * * @return The IPv6 address on which the daemon is listening. * * @warning Useful for version zero objects only. */ qcc::String GetIPv6(void) const; /** * @internal * @brief Clear the ReliableIPv4 address and port * * @warning Useful for version one objects only. */ void ClearReliableIPv4(void); /** * @internal * @brief Set the reliable IPv4 address and port * * This method takes an IPv4 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (32-bits, big endian). It also takes a port number and arranges * for it to be written out in network format (16-bits, big endian). This * method has the side-effect of setting the reliableIPv4 flag. * * @param addr The reliable method IPv4 address on which the daemon can be * contacted. * @param port The port on which the daemon is listening for connections. * * @warning Useful for version one objects only. */ void SetReliableIPv4(qcc::String addr, uint16_t port); /** * @internal * @brief Get the reliable IPv4 address * * This method returns an IPv4 address string in presentation format. * If the reliableIPv4 flag is not set, the results are undefined. * * @return The reliable IPv4 address on which the daemon is listening. * * @warning Useful for version one objects only. */ qcc::String GetReliableIPv4Address(void) const; /** * @internal * @brief Get the reliable IPv4 port * * This method returns an IPv4 port. If the reliableIPv4 flag is not set, * the results are undefined. * * @return The reliable IPv4 port on which the daemon is listening. * * @warning Useful for version one objects only. */ uint16_t GetReliableIPv4Port(void) const; /** * @internal * @brief Clear the UnreliableIPv4 address and port * * @warning Useful for version one objects only. */ void ClearUnreliableIPv4(void); /** * @internal * @brief Set the unreliable IPv4 address and port * * This method takes an IPv4 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (32-bits, big endian). It also takes a port number and arranges * for it to be written out in network format (16-bits, big endian). This * method has the side-effect of setting the unreliableIPv4 flag. * * @param addr The unreliable method IPv4 address on which the daemon can be * contacted. * @param port The port on which the daemon is listening for connections. * * @warning Useful for version one objects only. */ void SetUnreliableIPv4(qcc::String addr, uint16_t port); /** * @internal * @brief Get the unreliable IPv4 address * * This method returns an IPv4 address string in presentation format. * If the unreliableIPv4 flag is not set, the results are undefined. * * @return The unreliable IPv4 address on which the daemon is listening. * * @warning Useful for version one objects only. */ qcc::String GetUnreliableIPv4Address(void) const; /** * @internal * @brief Get the unreliable IPv4 port * * This method returns an IPv4 port. If the unreliableIPv4 flag is not set, * the results are undefined. * * @return The unreliable IPv4 port on which the daemon is listening. * * @warning Useful for version one objects only. */ uint16_t GetUnreliableIPv4Port(void) const; /** * @internal * @brief Clear the ReliableIPv6 address and port * * @warning Useful for version one objects only. */ void ClearReliableIPv6(void); /** * @internal * @brief Set the reliable IPv6 address and port * * This method takes an IPv6 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (128-bits, big endian). It also takes a port number and arranges * for it to be written out in network format (16-bits, big endian). This * method has the side-effect of setting the reliableIPv6 flag. * * @param addr The reliable method IPv6 address on which the daemon can be * contacted. * @param port The port on which the daemon is listening for connections. * * @warning Useful for version one objects only. */ void SetReliableIPv6(qcc::String addr, uint16_t port); /** * @internal * @brief Get the reliable IPv6 address * * This method returns an IPv6 address string in presentation format. * If the reliableIPv6 flag is not set, the results are undefined. * * @return The reliable IPv6 address on which the daemon is listening. * * @warning Useful for version one objects only. */ qcc::String GetReliableIPv6Address(void) const; /** * @internal * @brief Get the reliable IPv6 port * * This method returns an IPv6 port. If the reliableIPv6 flag is not set, * the results are undefined. * * @return The reliable IPv6 port on which the daemon is listening. * * @warning Useful for version one objects only. */ uint16_t GetReliableIPv6Port(void) const; /** * @internal * @brief Clear the UnreliableIPv6 address and port * * @warning Useful for version one objects only. */ void ClearUnreliableIPv6(void); /** * @internal * @brief Set the unreliable IPv6 address and port * * This method takes an IPv6 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (128-bits, big endian). It also takes a port number and arranges * for it to be written out in network format (16-bits, big endian). This * method has the side-effect of setting the unreliableIPv6 flag. * * @param addr The unreliable method IPv6 address on which the daemon can be * contacted. * @param port The port on which the daemon is listening for connections. * * @warning Useful for version one objects only. */ void SetUnreliableIPv6(qcc::String addr, uint16_t port); /** * @internal * @brief Get the unreliable IPv6 address * * This method returns an IPv6 address string in presentation format. * If the unreliableIPv6 flag is not set, the results are undefined. * * @return The unreliable IPv6 address on which the daemon is listening. * * @warning Useful for version one objects only. */ qcc::String GetUnreliableIPv6Address(void) const; /** * @internal * @brief Get the unreliable IPv6 port * * This method returns an IPv6 port. If the unreliableIPv6 flag is not set, * the results are undefined. * * @return The unreliable IPv6 port on which the daemon is listening. * * @warning Useful for version one objects only. */ uint16_t GetUnreliableIPv6Port(void) const; /** * @internal @brief Clear any objects from the list names, effectively * resetting the object. */ void Reset(void); /** * @internal * @brief Add a string representing a well-known or bus name to the answer. * * This method adds a well-known or bus name and adds it to an internal * list of authoritative answers regarding the names supported by the * calling daemon. These names will be serialized to an answer message * as StringData objects. * * @param name A well-known or bus name which the daemon supports. */ void AddName(qcc::String name); /** * @internal * Remove the well-known or bus name from the answer. * * This method removed a well-known name or bus name from the list of answers * regarding the names supported by the calling daemon. * * @note complexity constant time plus the number of element after the last * element deleted * * @param index the index value for the name to be removed */ void RemoveName(uint32_t index); /** * @internal * @brief Get the number of well-known or bus names represented by this * object. * * This method returns the number of well-known bus names from the internal * list of authoritative answers regarding the names supported by the * responding daemon. These names are typically deserialized from an * answer received over the network. * * @see GetName() * * @return The number of well-known names represented by this answer * object. */ uint32_t GetNumberNames(void) const; /** * @internal * @brief Get a string representing a well-known or bus name. * * This method returns one of the well-known or bus names from the internal * list of authoritative answers regarding the names supported by the * responding daemon. These names are typically deserialized from an answer * received over the network. * * The number of entries in the list (used to determine legal values for the * index) is found by calling GetNumberNames() * * @see GetNumberNames() * * @param name The index of the name to retrieve. * * @return The well-known or bus name at the provided index. */ qcc::String GetName(uint32_t index) const; /** * @internal * @brief Get the size of a buffer that will allow the answer object and * all of its children StringData objects to be successfully serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this answer and all of its children StringData objects * to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize this answer from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: uint8_t m_version; TransportMask m_transportMask; /**< Version one only */ bool m_flagG; bool m_flagC; bool m_flagT; /**< Version zero only */ bool m_flagU; /**< Version zero only */ bool m_flagS; /**< Version zero only */ bool m_flagF; /**< Version zero only */ bool m_flagR4; /**< Version one only */ bool m_flagU4; /**< Version one only */ bool m_flagR6; /**< Version one only */ bool m_flagU6; /**< Version one only */ uint16_t m_port; /**< Version zero only */ qcc::String m_ipv4; /**< Version zero only */ qcc::String m_ipv6; /**< Version zero only */ qcc::String m_reliableIPv4Address; /**< Version one only */ uint16_t m_reliableIPv4Port; /**< Version one only */ qcc::String m_unreliableIPv4Address; /**< Version one only */ uint16_t m_unreliableIPv4Port; /**< Version one only */ qcc::String m_reliableIPv6Address; /**< Version one only */ uint16_t m_reliableIPv6Port; /**< Version one only */ qcc::String m_unreliableIPv6Address; /**< Version one only */ uint16_t m_unreliableIPv6Port; /**< Version one only */ qcc::String m_guid; std::vector m_names; }; /** * @internal * @brief A class representing a question in the name service protocol. * * The WHO-HAS message is a question message used to ask AllJoyn daemons if they * support one or more bus names. * * @ingroup name_service_protocol */ class WhoHas : public ProtocolElement { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * name service protocol question. */ WhoHas(); /** * @internal * @brief Destroy a name service protocol answer object. */ ~WhoHas(); /** * @internal * @brief Set the wire protocol version that the object will use. * * The name service protocol is versioned. For backward compatibility, we * need to be able to get down-version messages to "old" daemons and current * version messages to "new" daemons. The first thing to observe is that, * like most protocols, the wire protocol is versioned, not extensible. * This means that in order to support multiple versions, we will need to * send multiple messages. This introduces ambiguitiy in the receiver of * the messages since it cannot know whether or not "new" messages will * appear after 'old" ones. To resolve this ambiguity, the wire protocol * version is constructed of two versions: a message version and a sender * protocol version. * * If a new version of the protocol is defined, new senders will be modified * to generate the new version, and new receivers will be able to receive * new messages. The message version tells a receiver what the absolute * format of the current message is; and the sender protocol version * provides a context shared between the sender and the receiver that can * indicate more, or better, information may be forthcoming. * * The message version tells "this" object which version of the wire * protocol to use when serializing the bits and which version to expect * when deserializing the bits. The sender protocol version is meta-data * for higher level code. * * The version is found in the Header, so we will know for sure what version * the overall packet will take. Objects of class IsAt support all versions * known at the time of compilation. If the version of the wire protocol * read does not provide a value for a given field, a default value will be * provided. Objects of class IsAt can support writing down-version packets * for compatibility. * * It is up to higher levels to understand the contextual implications, if any, * of writing or reading down-version packets. * * @param nsVersion The version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion The version (0 .. 15) of the actual message. */ void SetVersion(uint32_t nsVersion, uint32_t msgVersion) { m_version = nsVersion << 4 | msgVersion; } /** * @internal * @brief Get the wire protocol version that the object will use. * * @param nsVersion Gets the version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion Gets the version (0 .. 15) of the actual message. * * @see SetVersion() */ void GetVersion(uint32_t& nsVersion, uint32_t& msgVersion) { nsVersion = m_version >> 4; msgVersion = m_version & 0xf; } /** * @internal * @brief Set the transport mask of the transport sending the advertisement * * The IP name service protocol can be used by a number of different AllJoyn * transports. These transports may need to build a wall around their own * advertisements so we provide the name service with a way to plumb the * advertisements from end-to-end according to transport. * * It is up to higher levels to understand the contextual implications, if any, * of peeking at other transports' advertisements or discovery requests. * * @param mask The transport mask of the object. * * @warning Due to an oversight, the transport mask is not actually sent in * a version one who-has message. The transport mask is carried around internally * in outgoing messages, but is set to zero for incoming messages. */ void SetTransportMask(TransportMask mask) { m_transportMask = mask; } /** * @internal * @brief Get the transport mask of the transport that is sending the message. * * @return The transport mask of the transport that is sending the message. * * @see SetTransportMask() * * @warning Due to an oversight, the transport mask is not actually sent in * a version one who-has message. The transport mask is carried around internally * in outgoing messages, but is set to zero for incoming messages. */ TransportMask GetTransportMask(void) { return m_transportMask; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this question is interested in hearing about daemons listening on a TCP * socket. * * @param flag True if the daemon is interested in TCP. */ void SetTcpFlag(bool flag) { m_flagT = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this question is interested in hearing about daemons listening on a TCP * socket. * * @return True if the daemon ways it is interested in TCP. */ bool GetTcpFlag(void) const { return m_flagT; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this question is interested in hearing about daemons listening on a UDP * socket. * * @param flag True if the daemon is interested in UDP. */ void SetUdpFlag(bool flag) { m_flagU = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this question is interested in hearing about daemons listening on a UDP * socket. * * @return True if the daemon ways it is interested in UDP. */ bool GetUdpFlag(void) const { return m_flagU; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this question is interested in IPv6 addresses. * * @param flag True if the daemon is interested on IPv6. */ void SetIPv6Flag(bool flag) { m_flagS = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this question is interested in IPv6 addresses. * * @return True if the daemon is interested on IPv6. */ bool GetIPv6Flag(void) const { return m_flagS; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this question is interested in IPv4 addresses. * * @param flag True if the daemon is interested on IPv4. */ void SetIPv4Flag(bool flag) { m_flagF = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this question is interested in IPv4 addresses. * * @return True if the daemon is interested on IPv4. */ bool GetIPv4Flag(void) const { return m_flagF; } /** * @internal @brief Clear any objects from the list names, effectively * resetting the object. */ void Reset(void); /** * @internal * @brief Add a string representing a well-known or bus name to the * question. * * This method adds a well-known or bus name to an internal list of names * in which the calling daemon is interested. These names will be * serialized to a question message as StringData objects. * * @param name The well-known or bus name which the daemon is interested. */ void AddName(qcc::String name); /** * @internal * @brief Get the number of well-known or bus names represented by this * object. * * This method returns the number of well-known or bus names from the * internal list names that the questioning daemon is interested in. * These names are typically deserialized from a question received over the * network. * * @see GetName() * * @return The number of well-known interfaces represented by this question * object. */ uint32_t GetNumberNames(void) const; /** * @internal * @brief Get a string representing a well-known or bus name. * * This method returns one of the well-known or bus names from the internal * list of names in which questioning daemon is interested. These names * are typically deserialized from a question received over the network. * * The number of entries in the list (used to determine legal values for the * index) is found by calling GetNumberNames() * * @see GetNumberNames() * * @param name The index of the name to retrieve. * * @return The well-known or bus name at the provided index. */ qcc::String GetName(uint32_t index) const; /** * @internal * @brief Get the size of a buffer that will allow the question object and * all of its children StringData objects to be successfully serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this question and all of its children StringData objects * to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize a question wire-representation from the provided * buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: uint8_t m_version; TransportMask m_transportMask; bool m_flagT; bool m_flagU; bool m_flagS; bool m_flagF; std::vector m_names; }; /** * @internal * @brief A class representing name service packets. * * This is an abstract class, derived by NSPacket(version 0 and 1) and MDNSPacket(version 2) * */ class _Packet : public ProtocolElement { public: _Packet(); virtual ~_Packet(); /** * @internal * @brief Set the optional destination address for the message corresponding * to this header. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. * * @param destination The destination IP address of the corresponding message. */ void SetDestination(qcc::IPEndpoint destination) { m_destination = destination; m_destinationSet = true; } void SetInterfaceIndex(uint32_t interfaceIndex) { m_interfaceIndex = interfaceIndex; m_interfaceIndexSet = true; } void SetAddressFamily(qcc::AddressFamily addressFamily) { m_addressFamily = addressFamily; m_addressFamilySet = true; } /** * @internal * @brief Get the optional destination address for the message corresponding * to this header. If the destination has not been set, the result is not * defined. This is not a perfect place for this information, but it is a * very convenient place. This information is not part of the wire * protocol. * * @return The destination IP address of the corresponding message. */ qcc::IPEndpoint GetDestination(void) { return m_destination; } uint32_t GetInterfaceIndex(void) { return m_interfaceIndex; } int32_t GetAddressFamily(void) { return m_addressFamily; } /** * @internal * @brief Set the optional destination address for the message corresponding * to this header. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. * * @return The destination IP address of the corresponding message. */ bool DestinationSet(void) { return m_destinationSet; } bool InterfaceIndexSet(void) { return m_interfaceIndexSet; } bool AddressFamilySet(void) { return m_addressFamilySet; } /** * @internal * @brief Set the optional destination address for the message corresponding * to this header. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. */ void ClearDestination() { m_destinationSet = false; } void ClearInterfaceIndex() { m_interfaceIndexSet = false; } void ClearAddressFamily() { m_addressFamily = qcc::QCC_AF_UNSPEC; m_addressFamilySet = false; } /** * @internal * @brief Set the number of times this header has been sent on the wire. * This is not a perfect place for this information, but it is a very * convenient place. This information is not part of the wire protocol. * * @param retries The number of times the header has been sent on the wire. */ void SetRetries(uint32_t retries) { m_retries = retries; } /** * @internal * @brief Set the number of times this header has been sent on the wire. * This is not a perfect place for this information, but it is a very * convenient place. This information is not part of the wire protocol. * * @return The number of times the header has been sent on the wire. */ uint32_t GetRetries(void) { return m_retries; } /** * @internal * @brief Get the tick value representing the last time this header was sent * on the wire. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. * * @param tick The last time the header was sent on the wire. */ void SetRetryTick(uint32_t tick) { m_tick = tick; } /** * @internal * @brief Set the tick value representing the last time this header was sent * on the wire. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. * * @return The last time the header was been sent on the wire. */ uint32_t GetRetryTick(void) { return m_tick; } /** * @internal * @brief Set the timer value for all answers present in the protocol * message. * * The timer value is typcally used to encode whether or not included * answer (IS-AT) messages indicate the establishment or withdrawal * of service advertisements. A timer value of zero indicates that * the included answers are valid for zero seconds. This implies * that the advertisements are no longer valid and should be withdrawn. * * A timer value of 255 indicates that the advertisements included in * the following IS-AT messages should be considered valid until they * are explicitly withdrawn. * * Other timer values indicate that the advertisements included are * are ephemeral and should not be considered valid for longer than * the number of seconds after which the message datagram containing * the header is received. * * @param timer The timer value (0 .. 255) for included answers. */ void SetTimer(uint8_t timer); /** * @internal * @brief Get the timer value for all answers present in the protocol * message. * * @see SetTimer() * * @return The timer value (0 .. 255) for included answers. */ uint8_t GetTimer(void) const; /** * @internal * @brief Set the wire protocol version that the object will use. * * The name service protocol is versioned. For backward compatibility, we * need to be able to get down-version messages to "old" daemons and current * version messages to "new" daemons. The first thing to observe is that, * like most protocols, the wire protocol is versioned, not extensible. * This means that in order to support multiple versions, we will need to * send multiple messages. This introduces ambiguitiy in the receiver of * the messages since it cannot know whether or not "new" messages will * appear after 'old" ones. To resolve this ambiguity, the wire protocol * version is constructed of two versions: a message version and a sender * protocol version. * * If a new version of the protocol is defined, new senders will be modified * to generate the new version, and new receivers will be able to receive * new messages. The message version tells a receiver what the absolute * format of the current message is; and the sender protocol version * provides a context shared between the sender and the receiver that can * indicate more, or better, information may be forthcoming. * * The message version tells "this" object which version of the wire * protocol to use when serializing the bits and which version to expect * when deserializing the bits. The sender protocol version is meta-data * for higher level code. * * The version is found in the Header, so we will know for sure what version * the overall packet will take. Objects of class IsAt support all versions * known at the time of compilation. If the version of the wire protocol * read does not provide a value for a given field, a default value will be * provided. Objects of class IsAt can support writing down-version packets * for compatibility. * * It is up to higher levels to understand the contextual implications, if any, * of writing or reading down-version packets. * * @param nsVersion The version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion The version (0 .. 15) of the actual message. */ void SetVersion(uint32_t nsVersion, uint32_t msgVersion) { m_version = nsVersion << 4 | msgVersion; } /** * @internal * @brief Get the wire protocol version that the object will use. * * @param nsVersion Gets the version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion Gets the version (0 .. 15) of the actual message. * * @see SetVersion() */ void GetVersion(uint32_t& nsVersion, uint32_t& msgVersion) { nsVersion = m_version >> 4; msgVersion = m_version & 0xf; } /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(void) const = 0; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer) const = 0; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize) = 0; private: uint8_t m_timer; qcc::IPEndpoint m_destination; bool m_destinationSet; uint32_t m_interfaceIndex; bool m_interfaceIndexSet; qcc::AddressFamily m_addressFamily; bool m_addressFamilySet; uint32_t m_retries; uint32_t m_tick; protected: uint8_t m_version; }; /** * @internal * @brief A class representing a message in the name service protocol. * * A name service message consists of a header, followed by a variable * number of question (Q) messages (for example, WHO-HAS) followed by a variable * number of answer(A) messages (for example, IS-AT). All messages are packed * to octet boundaries. * * @ingroup name_service_protocol */ class _NSPacket : public _Packet { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * name service protocol header. */ _NSPacket(); /** * @internal * @brief Destroy a name service protocol header object. */ ~_NSPacket(); /** * @internal * @brief Clear any objects from the lists of questions and answers, * effectively resetting the header. */ void Reset(void); /** * @internal * @brief Add a question object to the list of questions represented by * this header. * * This method adds a question (WhoHas) object to an internal list of * questions the calling daemon is asking. These questions will be * serialized to on-the-wire question objects when the header is * serialized. * * @see class WhoHas * * @param whoHas The question object to add to the protocol message. */ void AddQuestion(WhoHas whoHas); /** * @internal * @brief Get the number of question objects represented by this object. * * @see GetQuestion() * * @return The number of question objects represented by this header object. */ uint32_t GetNumberQuestions(void) const; /** * @internal * @brief Get a Question object represented by this header object. * * This method returns one of the question objects from the internal list * of questions asked by a questioning daemon. These questions are * typically automatically deserialized from a header received over the * network. * * The number of entries in the list (used to determine legal values for the * index) is found by calling GetNumberQuestions() * * @see GetNumberQuestions() * * @param name The index of the question to retrieve. * * @return The question object at the provided index. */ WhoHas GetQuestion(uint32_t index) const; /** * @internal * @brief Get a pointer to an answer object represented by this header object. * * This method returns a pointer. This is typically used if one needs to * rewrite the contents of a question object. We can't just return the pointer * since C++ doesn't consider return types in overload resolution, so we have * to return it indirectly. * * @see GetQuestion() * * @param name The index of the question to retrieve. * @param answer A pointer to the returned pointer to the question object at * the provided index. */ void GetQuestion(uint32_t index, WhoHas** question); /** * @internal * @brief Add an answer object to the list of answers represented by * this header. * * This method adds an answer (IsAt) object to an internal list of * answers the calling daemon is providing. These answers will be * serialized to on-the-wire answer objects when the header is * serialized. * * @see class IsAt * * @param isAt The answer object to add to the protocol message. */ void AddAnswer(IsAt isAt); /** * @internal * Remove an answer object from the list of answers represented by this header. * * This method removed an answer (IsAt) object from an internal list of answers * the calling daemon is providing. * * @note complexity is constant time plus the number of elements after the * deleted element. * * @param index the index value of the answer to be removed */ void RemoveAnswer(uint32_t index); /** * @internal * @brief Get the number of answer objects represented by this object. * * @see GetAnswer() * * @return The number of answer objects represented by this header object. */ uint32_t GetNumberAnswers(void) const; /** * @internal * @brief Get an answer object represented by this header object. * * This method returns one of the answer objects from the internal list * of answers provided by a responding daemon. These answers are typically * automatically deserialized from a header received over the network. * * The number of entries in the list (used to determine legal values for the * index) is found by calling GetNumberAnswers() * * @see GetNumberAnswers() * * @param name The index of the answer to retrieve. * * @return The answer object at the provided index. */ IsAt GetAnswer(uint32_t index) const; /** * @internal * @brief Get a pointer to an answer object represented by this header object. * * This method returns a pointer. This is typically used if one needs to * rewrite the contents of an answer object. We can't just return the pointer * since C++ doesn't consider return types in overload resolution, so we have * to return it indirectly. * * @see GetAnswer() * * @param name The index of the answer to retrieve. * @param answer A pointer to the returned pointer to the answer object at * the provided index. */ void GetAnswer(uint32_t index, IsAt** answer); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: std::vector m_questions; std::vector m_answers; }; /** * @internal * @brief A class representing an MDNSRData. * This is an abstract class. */ class MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS RData. */ MDNSRData() { } /** * @internal * @brief Destructor for MDNSRData. */ virtual ~MDNSRData(); /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const = 0; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const = 0; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) = 0; /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of the MDNSRData */ virtual MDNSRData* GetDeepCopy() = 0; }; /** * @internal * @brief A class representing an unknown RData type to this version of NS. * It just calculates the RDLength and skips the specified number of bytes during deserialization. * Serialization of this RData does not add any bytes. */ class MDNSDefaultRData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Default RData. */ MDNSDefaultRData() { } /** * @internal * @brief Destructor for MDNSDefaultRData. */ virtual ~MDNSDefaultRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSDefaultRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSDefaultRData(*this); } /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); }; /** * @internal * @brief A class representing an MDNSTextRData. * An MDNSTextRData a set of key value pairs. * For e.g. guid=guid1,upcv4=9000 will be in the following format: * 0 1 2 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 * +--+--+-+-+-+-+-+-+-+-+-+-+--+-+-+-+-+-+-+-+-+-+-+ * |22|10|g u i d = g u i d 1|10|u p c v 4 = 9 0 0 0| * +--+--+-+-+-+-+-+-+-+-+-+-+--+-+-+-+-+-+-+-+-+-+-+ */ class MDNSTextRData : public MDNSRData { public: struct Compare { inline bool operator()(const qcc::String& s1, const qcc::String& s2) const { size_t u1Pos = s1.find_last_of('_'); size_t u2Pos = s2.find_last_of('_'); if (u1Pos == qcc::String::npos || u2Pos == qcc::String::npos) { return s1 < s2; } else { uint32_t n1 = (u1Pos == qcc::String::npos) ? 0 : qcc::StringToU32(s1.substr(u1Pos + 1)); uint32_t n2 = (u2Pos == qcc::String::npos) ? 0 : qcc::StringToU32(s2.substr(u2Pos + 1)); return n1 < n2; } } }; typedef std::map Fields; /** * @brief The TXT record version supported by the MDNS name service. */ static const uint16_t TXTVERS; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Text RData. */ MDNSTextRData(uint16_t version = TXTVERS, bool uniquifyKeys = false); /** * @internal * @brief Destructor for MDNSTextRData. */ virtual ~MDNSTextRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSTextRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSTextRData(*this); } /** * @internal * @brief returns the uniquifier value. */ uint16_t GetUniqueCount(); /** * @internal * @brief sets the uniquifier value. */ void SetUniqueCount(uint16_t count); /** * @internal * @brief reset the m_fields map */ void Reset(); /** * @internal * @brief Add/Set a key value pair. * @param key The key to set. * @param value The value to set. * @param shared Is this a shared key for the entire record. */ void SetValue(qcc::String key, qcc::String value, bool shared = false); /** * @internal * @brief Add/Set a key pair. * @param key The key to set. * @param shared Is this a shared key for the entire record. */ void SetValue(qcc::String key, bool shared = false); /** * @internal * @brief Get the value corresponding to a particular key in the map. * @param key The key to get the value for. * @return The value in the map corresponding to the key. */ qcc::String GetValue(qcc::String key); /** * @internal * @brief Is this key present in the map. * @param key The key to search. * @return true if key is present in the map. */ bool HasKey(qcc::String key); /** * @internal * @brief Get the value corresponding to a particular key in the map. * @param key The key to get the value for. * @return The value in the map corresponding to the key. */ uint16_t GetU16Value(qcc::String key); /** * @internal * @brief Remove a key value pair from the map. * @param key The key to remove */ void RemoveEntry(qcc::String key); /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief This will overestimate the size of the buffer required * since name compression is applied during serialization. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize() const { std::map offsets; return GetSerializedSize(offsets); } /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: uint16_t version; uint16_t uniquifier; protected: Fields m_fields; /** * @internal * @brief Get the number of fields beginning with key in this Text RData. * This is only useful when uniquifyKeys is true. * * @param key The key to get the count for. * @return The number of fields in this Text RData. */ uint16_t GetNumFields(qcc::String key); /** * @internal * @brief Get the value of the field beginning with the key at the particular index. * This is only useful when uniquifyKeys is true. * * @param key The key to get the value for. * @param index The index to get the field at * @return The value at the desired index in this Text RData. */ qcc::String GetFieldAt(qcc::String key, int index); /** * @internal * @brief Remove a field from this Text RData. * This is only useful when uniquifyKeys is true. * * @param key The key to get the value for. * @param index The index to remove the field at */ void RemoveFieldAt(qcc::String key, int index); }; /** * @internal * @brief A class representing an MDNSARData. * * An MDNSARData in wire format contains the length(value 4) in 2 bytes * followed by a 4 byte IPv4 address. */ class MDNSARData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS A RData representing an IPV4 address. */ MDNSARData() { } /** * @internal * @brief Destructor for MDNSARData. */ virtual ~MDNSARData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSARData */ virtual MDNSRData* GetDeepCopy() { return new MDNSARData(*this); } /** * @internal * @brief Set the IPV4 address. * @param ipAddr the IPV4 address to set. */ void SetAddr(qcc::String ipAddr); /** * @internal * @brief Get the IPV4 address. * @return The IPV4 address contained in this A RData. */ qcc::String GetAddr(); /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: qcc::String m_ipv4Addr; }; /** * @internal * @brief A class representing an MDNSAAAARData. * * An MDNSAAAARData in wire format contains the length(value 16) in 2 bytes * followed by a 16 byte IPv6 address. */ class MDNSAAAARData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS AAAA RData representing an IPV6 address. */ MDNSAAAARData() { } /** * @internal * @brief Destructor for MDNSAAAARData. */ virtual ~MDNSAAAARData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSAAAARData */ virtual MDNSRData* GetDeepCopy() { return new MDNSAAAARData(*this); } /** * @internal * @brief Set the IPV6 address. * @param ipAddr the IPV6 address to set. */ void SetAddr(qcc::String ipAddr); /** * @internal * @brief Get the IPV6 address. * @return The IPV6 address contained in this AAAA RData. */ qcc::String GetAddr() const; /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: qcc::String m_ipv6Addr; }; /** * @internal * @brief A class representing an MDNSPtrRData. * * An MDNSPtrRData in wire format contains the length in 2 bytes * followed by the 'length' number of bytes containing the Ptr domain name. */ class MDNSPtrRData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS PTR RData. */ MDNSPtrRData() { } /** * @internal * @brief Destructor for MDNSPtrRData. */ virtual ~MDNSPtrRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSPtrRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSPtrRData(*this); } /** * @internal * @brief Set the Ptr DName for this PTR RData. * @param dName The name to set. */ void SetPtrDName(qcc::String dName); /** * @internal * @brief Get the PTR DName. * @return The PTR DName contained in this PTR RData. */ qcc::String GetPtrDName() const; /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: qcc::String m_rdataStr; }; /** * @internal * @brief A class representing an MDNSDomainName. * for e.g. _alljoyn._tcp.local will be represented as follows in the MDNSDomainName format: * 0 1 2 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |8 _ a l l j o y n 4 _ t c p 5 l o c a l 0| * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */ class MDNSDomainName { public: /** * @internal * @brief Set the name for this DomainName element. * * @param name The name to set. */ void SetName(qcc::String name); /** * @internal * @brief Get the String name this object is representing. * * @return name in qcc::String format. */ qcc::String GetName() const; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS domain name. */ MDNSDomainName(); /** * @internal * @brief Destructor for MDNSDomainName */ ~MDNSDomainName(); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: qcc::String m_name; }; /** * @internal * @brief A class representing an MDNSSrvRData. * * An MDNSSrvRData in wire format contains the total length in 2 bytes * followed by a 2 byte priority, 2 byte weight, 2 byte port * and a variable length target field. */ class MDNSSrvRData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS SRV RData. */ MDNSSrvRData() { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS SRV RData. * @param priority the priority of the target host. * @param weight Weight for records with the same priority. * @param port TCP or UDP port that the service is listening on. * @param target The host name in MDNS domain name format. */ MDNSSrvRData(uint16_t priority, uint16_t weight, uint16_t port, qcc::String target); /** * @internal * @brief Destructor for MDNSSrvRData. */ virtual ~MDNSSrvRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSSrvRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSSrvRData(*this); } /** * @internal * @brief Set the priority for this SRV RData. * @param priority The priority to set. */ void SetPriority(uint16_t priority); /** * @internal * @brief Get the priority for this SRV RData. * @return The priority contained in this SRV RData. */ uint16_t GetPriority() const; /** * @internal * @brief Set the weight for this SRV RData. * @param weight The weight to set. */ void SetWeight(uint16_t weight); /** * @internal * @brief Get the weight for this SRV RData. * @return The weight contained in this SRV RData. */ uint16_t GetWeight() const; /** * @internal * @brief Set the port for this SRV RData. * @param port The port to set. */ void SetPort(uint16_t port); /** * @internal * @brief Get the port for this SRV RData. * @return The port contained in this SRV RData. */ uint16_t GetPort() const; /** * @internal * @brief Set the target for this SRV RData. * @param target The target to set. */ void SetTarget(qcc::String target); /** * @internal * @brief Get the target for this SRV RData. * @return The target contained in this SRV RData. */ qcc::String GetTarget() const; /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: uint16_t m_priority; uint16_t m_weight; uint16_t m_port; MDNSDomainName m_target; }; /** * @internal * @brief A class representing an MDNSSearchRData. * * MDNSSearchRData is a specialization of MDNSTextData and contains a well-known name. */ class MDNSSearchRData : public MDNSTextRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Search RData. */ MDNSSearchRData(uint16_t version = MDNSTextRData::TXTVERS) : MDNSTextRData(version, true) { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Search RData. * @param name The name to search for. */ MDNSSearchRData(qcc::String name, uint16_t version = MDNSTextRData::TXTVERS); /** * @internal * @brief Destructor for MDNSSearchRData. */ virtual ~MDNSSearchRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSSearchRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSSearchRData(*this); } /** * @internal * @brief Get the number of names in this Search RData. * @return The number of names in this Search RData. */ uint16_t GetNumNames() { return MDNSTextRData::GetNumFields("n"); } /** * @internal * @brief Get the name at the particular index. * @param index The index to get the name at * @return The name at the desired index in this Search RData. */ qcc::String GetNameAt(int index) { return MDNSTextRData::GetFieldAt("n", index); } /** * @internal * @brief Get the send_match_only option specified in the Search RData. * * @return true if only matching names need to be sent. * false if all names need to be sent. */ bool SendMatchOnly(); /** * @internal * @brief Add/Set a key value pair. * @param key The key to set. * @param value The value to set. */ void SetValue(qcc::String key, qcc::String value); /** * @internal * @brief Add/Set a key pair. * @param key The key to set. */ void SetValue(qcc::String key); /** * @internal * @brief Get the number of fields in this Search RData. * @return The number of fields in this Search RData. */ uint16_t GetNumFields(); /** * @internal * @brief Get the field at a certain index in this Search RData. * @param index The index at which the field is to be returned * @return Field at the specified index */ std::pair GetFieldAt(int index); /** * @internal * @brief Get the number of search criteria in this Search RData. * @return The number of search criteria in this Search RData. */ uint16_t GetNumSearchCriteria(); /** * @internal * @brief Get the search criterion at a certain index in this Search RData. * @param index The index at which the search criterion is to be returned * @return Search Criterion at the specified index */ qcc::String GetSearchCriterion(int index); /** * @internal * @brief Remove the search criterion at a certain index in this Search RData. * @param index The index at which the search criterion is to be removed */ void RemoveSearchCriterion(int index); }; /** * @internal * @brief A class representing an MDNSPingRData. * * MDNSPingRData is a specialization of MDNSTextData and contains a well-known name. */ class MDNSPingRData : public MDNSTextRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Ping RData. */ MDNSPingRData(uint16_t version = MDNSTextRData::TXTVERS) : MDNSTextRData(version) { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Ping RData. * @param name The name to search for. */ MDNSPingRData(qcc::String name, uint16_t version = MDNSTextRData::TXTVERS); /** * @internal * @brief Destructor for MDNSPingRData. */ virtual ~MDNSPingRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSPingRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSPingRData(*this); } /** * @internal * @brief Set the well known name for this Search RData. * @param name The well known name to set. */ void SetWellKnownName(qcc::String name); /** * @internal * @brief Get the wellknown name for this Ping RData. * @return The well known name contained in this Ping RData. */ qcc::String GetWellKnownName(); }; /** * @internal * @brief A class representing an MDNSPingRData. * * MDNSPingRData is a specialization of MDNSTextData and contains a well-known name. */ class MDNSPingReplyRData : public MDNSTextRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Ping RData. */ MDNSPingReplyRData(uint16_t version = MDNSTextRData::TXTVERS) : MDNSTextRData(version) { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Ping RData. * @param name The name to search for. */ MDNSPingReplyRData(qcc::String name, uint16_t version = MDNSTextRData::TXTVERS); /** * @internal * @brief Destructor for MDNSPingRData. */ virtual ~MDNSPingReplyRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSPingRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSPingReplyRData(*this); } /** * @internal * @brief Set the well known name for this Search RData. * @param name The well known name to set. */ void SetWellKnownName(qcc::String name); /** * @internal * @brief Get the wellknown name for this Ping RData. * @return The well known name contained in this Ping RData. */ qcc::String GetWellKnownName(); qcc::String GetReplyCode(); void SetReplyCode(qcc::String replyCode); }; /** * @internal * @brief A class representing an MDNSAdvertiseRData. * * MDNSAdvertiseRData is a specialization of MDNSTextData and contains a list of * names being advertised by the service. */ class MDNSAdvertiseRData : public MDNSTextRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Advertise RData. */ MDNSAdvertiseRData(uint16_t version = MDNSTextRData::TXTVERS) : MDNSTextRData(version, true) { } /** * @internal * @brief Destructor for MDNSAdvertiseRData. */ virtual ~MDNSAdvertiseRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSAdvertiseRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSAdvertiseRData(*this); } /** * @internal * @brief Remove all the accumulated names */ void Reset(); /** * @internal * @brief Get the number of names in this Advertise RData. * @return The number of names in this Advertise RData. */ uint16_t GetNumTransports() { return MDNSTextRData::GetNumFields("t"); } /** * @internal * @brief Get the name at the particular index. * @param index The index to get the name at * @return The name at the desired index in this Advertise RData. */ qcc::String GetNameAt(TransportMask transportMask, int index); void SetTransport(TransportMask tm); void RemoveNameAt(TransportMask transportMask, int index); /** * @internal * @brief Get the name at the particular index. * @param index The index to get the name at * @return The name at the desired index in this Advertise RData. */ qcc::String GetNameAt(int index) { return MDNSTextRData::GetFieldAt("n", index); } /** * @internal * @brief Add a name for this Advertise RData. * @param name The name to add. */ void AddName(qcc::String name); /** * @internal * @brief Remove a name from this Advertise RData. * @param name The name to remove. */ void RemoveNameAt(int index) { return MDNSTextRData::RemoveFieldAt("n", index); } /** * @internal * @brief Get the number of names in this Advertise RData. * @return The number of names in this Advertise RData. */ uint16_t GetNumNames(TransportMask transportMask); /** * @internal * @brief Get the number of names in this Advertise RData. * @return The number of names in this Advertise RData. */ uint16_t GetNumNames() { return MDNSTextRData::GetNumFields("n"); } /** * @internal * @brief Add/Set a key value pair. * @param key The key to set. * @param value The value to set. */ void SetValue(qcc::String key, qcc::String value); /** * @internal * @brief Add/Set a key pair. * @param key The key to set. */ void SetValue(qcc::String key); /** * @internal * @brief Get the number of fields in this Advertise RData. * @return The number of fields in this Advertise RData. */ uint16_t GetNumFields(); /** * @internal * @brief Get the number of fields in this Advertise RData. * @return The number of fields in this Advertise RData. */ std::pair GetFieldAt(int index); }; /** * @internal * @brief A class representing an MDNSSenderRData. * * MDNSSenderRData is a specialization of MDNSTextData and contains the search ID, * protocol version, ipv4 unicast port that the NS is listening on, * ipv6 NS unicast port that the NS is listening on, transport mask for the query/response, * guid of the NS router and ipv4 and ipv6 addresses in case of a query. * Note: In case of a response the ipv4 and ipv6 addresses are included as * A and AAAA additionalrecords. */ class MDNSSenderRData : public MDNSTextRData { public: /* * The current version of the MDNS nameservice */ static const uint32_t NS_VERSION = 2; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Sender RData. */ MDNSSenderRData(uint16_t version = MDNSTextRData::TXTVERS); /** * @internal * @brief Destructor for MDNSSenderRData. */ virtual ~MDNSSenderRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSSenderRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSSenderRData(*this); } /** * @internal * @brief Set the search ID for this Sender RData. * @param searchId The search ID to set. */ void SetSearchID(uint16_t searchId); /** * @internal * @brief Get the search ID for this Sender RData. * @return The search ID contained in this Sender RData. */ uint16_t GetSearchID(); /** * @internal * @brief Set the ipv4Port for this Sender RData. * @param ipv4Port The ipv4Port to set. */ void SetIPV4ResponsePort(uint16_t ipv4Port); /** * @internal * @brief Get the ipv4Port for this Sender RData. * @return The ipv4Port contained in this Sender RData. */ uint16_t GetIPV4ResponsePort(); /** * @internal * @brief Set the ipv4Addr for this Sender RData. * @param ipv4Addr The ipv4Addr to set. */ void SetIPV4ResponseAddr(qcc::String ipv4Addr); /** * @internal * @brief Get the ipv4Addr for this Sender RData. * @return The ipv4Addr contained in this Sender RData. */ qcc::String GetIPV4ResponseAddr(); }; /** * @internal * @brief A class representing an MDNSResourceRecord. * * An MDNSResourceRecord in wire format contains a name(MDNSDomainName format), * followed by an MDNSResourceRecord::RRType(2 byte), * followed by an MDNSResourceRecord::RRClass(2 byte), * followed by a 4 byte unsigned integer - ttl * followed by a 2 byte RDLength * followed by RDLength number of bytes in a format defined by the RRType and RRClass. */ class MDNSResourceRecord { public: enum RRType { A = 1, //Host IPv4 Address NS = 2, //Authoritative name server MD = 3, //Mail destination MF = 4, //Mail forwarder CNAME = 5, //Canonical name for an alias SOA = 6, //Marks the start zone of an authority MB = 7, //Mailbox domain name MG = 8, //Mail group member MR = 9, //Mail rename domain RNULL = 10, //Null RR WKS = 11, //Well known service description PTR = 12, //Domain name pointer HINFO = 13, //Host information MINFO = 14, //Mailbox info MX = 15, //Mail Exchange TXT = 16, //Text strings AAAA = 28, //Host IPv6 Address SRV = 33, //SRV record OPT = 41, //OPT record NSEC = 47 //NSEC record }; enum RRClass { INTERNET = 1, //Internet CS = 2, //CSNET class CH = 3, //CHAOS class HS = 4 //Hesoid }; /** * @internal * @brief Construct an in-memory object representatin of an on-the-wire * mDNS resource record */ MDNSResourceRecord(); /** * @internal * @brief Construct an in-memory object representatin of an on-the-wire * mDNS resource record * @param domainName Name for this Resource record. * @param rrtype Type of Resource record. * @param rrclass Class of Resource record. * @param ttl Time to live for this resource record. * @param rdata Pointer to an MDNSRData. */ MDNSResourceRecord(qcc::String domainName, RRType rrtype, RRClass rrclass, uint16_t ttl, MDNSRData* rdata); /** * @internal * @brief Copy constructor for the MDNSResourceRecord * @param mdnsResourceRecord The MDNSResourceRecord to copy from. */ MDNSResourceRecord(const MDNSResourceRecord& mdnsResourceRecord); /** * @internal * @brief Assignment operator * @param other The MDNSResourceRecord to copy from. */ MDNSResourceRecord& operator=(const MDNSResourceRecord& other); /** * @internal * @brief Destroy a mDNS resource record */ ~MDNSResourceRecord(); /** * @internal * @brief Set the domain name for the resource record. * @param domainName The domain name to set. */ void SetDomainName(qcc::String domainName); /** * @internal * @brief Get the domain name for the resource record. * @return The domain name of this resource record. */ qcc::String GetDomainName() const; /** * @internal * @brief Set the type for the resource record. * @param rrtype The type to set. */ void SetRRType(RRType rrtype); /** * @internal * @brief Get the type for the resource record. * @return The type of this resource record. */ RRType GetRRType() const; /** * @internal * @brief Set the class for the resource record. * @param rrclass The class to set. */ void SetRRClass(RRClass rrclass); /** * @internal * @brief Get the class for the resource record. * @return The class of this resource record. */ RRClass GetRRClass() const; /** * @internal * @brief Set the ttl for the resource record. * @param ttl The TTL to set. */ void SetRRttl(uint16_t ttl); /** * @internal * @brief Get the ttl for the resource record. * @return The TTL of this resource record. */ uint16_t GetRRttl() const; /** * @internal * @brief Set the rdata for the resource record. * @param rdata The RData to set. */ void SetRData(MDNSRData* rdata); /** * @internal * @brief Get the rdata for the resource record. * @return A pointer to the RData of this resource record. */ MDNSRData* GetRData(); /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief This will overestimate the size of the buffer required * since name compression is applied during serialization. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize() const { std::map offsets; return GetSerializedSize(offsets); } /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: MDNSDomainName m_rrDomainName; RRType m_rrType; RRClass m_rrClass; uint32_t m_rrTTL; MDNSRData*m_rdata; }; /** * @internal * @brief A class representing an MDNSQuestion. * * MDNSQuestion wire format contains a QName in MDNSDomainName format, * followed by a 2 byte QType(MDNSResourceRecord::RRType), * followed by a 2 byte QClass(MDNSResourceRecord::RRClass). */ class MDNSQuestion { public: static const uint16_t QU_BIT = 0x8000; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS question. */ MDNSQuestion() { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS question. * @param qName The QName to set. * @param qType The QType to set. * @param qClass The QClass to set. */ MDNSQuestion(qcc::String qName, uint16_t qtype, uint16_t qClass); /** * @internal * @brief Destructor for MDNSQuestion */ ~MDNSQuestion() { } /** * @internal * @brief Set the value for the QName field in the question. * * @param name The QName to set. */ void SetQName(qcc::String qName); /** * @internal * @brief Get the QName field value in the question. * * @return The QName field value. */ qcc::String GetQName(); /** * @internal * @brief Set the value for the QType field in the question. * * @param name The QType to set. */ void SetQType(uint16_t qType); /** * @internal * @brief Get the QType field value in the question. * * @return The QType field value. */ uint16_t GetQType(); /** * @internal * @brief Set the value for the QClass field in the question. * * @param name The QClass to set. */ void SetQClass(uint16_t qClass); /** * @internal * @brief Get the QClass field value in the question. * * @return The QClass field value. */ uint16_t GetQClass(); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: MDNSDomainName m_qName; uint16_t m_qType; uint16_t m_qClass; }; /** * @internal * @brief A class representing an MDNSHeader. * * MDNSHeader contains the Id, QRType(Query/Response), QDCount(number of questions to follow), * ANCount(number of answers to follow), NSCount(number of authoritative records to follow) and * ARCount(number of additional records to follow). */ class MDNSHeader { public: static const uint16_t MDNS_QUERY = 0; static const uint16_t MDNS_RESPONSE = 1; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS protocol header. */ MDNSHeader(); /** * @internal * @brief Destroy a MDNS protocol header object. */ ~MDNSHeader(); MDNSHeader(uint16_t id, bool qrType, uint16_t qdCount, uint16_t anCount, uint16_t nsCount, uint16_t arCount); MDNSHeader(uint16_t id, bool qrType); /** * @internal * @brief Set the value for the Id field in the header. * * @param name The Id to set. */ void SetId(uint16_t id); /** * @internal * @brief Get the Id field value in the header. * * @return The Id field value. */ uint16_t GetId(); /** * @internal * @brief Set the value for the QRType field in the header. * * @param name The QRType to set. */ void SetQRType(bool qrType); /** * @internal * @brief Get the Type field value in the header. * * @return The Type field value. */ bool GetQRType(); /** * @internal * @brief Set the value for the QDCount field in the header. * * @param name The QDCount to set. */ void SetQDCount(uint16_t qdCount); /** * @internal * @brief Get the QDCount field value in the header. * * @return The QDCount field value. */ uint16_t GetQDCount(); /** * @internal * @brief Set the value for the ANCount field in the header. * * @param name The ANCount to set. */ void SetANCount(uint16_t anCount); /** * @internal * @brief Get the ANCount field value in the header. * * @return The ANCount field value. */ uint16_t GetANCount(); /** * @internal * @brief Set the value for the NSCount field in the header. * * @param name The NSCount to set. */ void SetNSCount(uint16_t nsCount); /** * @internal * @brief Get the NSCount field value in the header. * * @return The NSCount field value. */ uint16_t GetNSCount(); /** * @internal * @brief Set the value for the ARCount field in the header. * * @param name The ARCount to set. */ void SetARCount(uint16_t arCount); /** * @internal * @brief Get the ARCount field value in the header. * * @return The ARCount field value. */ uint16_t GetARCount(); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: uint16_t m_queryId; bool m_qrType; bool m_authAnswer; enum RCodeType { NOT_ERROR = 0, FORMAT_ERROR = 1, SERVER_FAILURE = 2, NAME_ERROR = 3, NOT_IMPLEMENTED = 4, REFUSED = 5 }; RCodeType m_rCode; uint16_t m_qdCount; uint16_t m_anCount; uint16_t m_nsCount; uint16_t m_arCount; }; /** * @internal * @brief A class representing an MDNSPacket. * * MDNSPacket contains an MDNSHeader, * followed by a variable number of questions(as indicated in the header) * followed by a variable number of answers(as indicated in the header) * followed by a variable number of authoritative records(as indicated in the header). * followed by a variable number of additional records(as indicated in the header). */ class _MDNSPacket : public _Packet { public: _MDNSPacket(); ~_MDNSPacket(); /** * @internal * @brief Clear the internal state of this MDNSPacket. */ void Clear(); /** * @internal * @brief Set the Header for this packet. * * @param header The header to set for this packet. */ void SetHeader(MDNSHeader header); MDNSHeader GetHeader(); /** * @internal * @brief Add a question to this packet. * * @param question The question to add to this packet. */ void AddQuestion(MDNSQuestion question); /** * @internal * @brief Get the number of questions contained in this packet. * * @return Number of questions in this packet. */ uint16_t GetNumQuestions(); /** * @internal * @brief Get the question at the particular index. * @param index The index to get the question at. * @return The MDNSQuestion at the desired index in this MDNS packet. */ bool GetQuestionAt(uint32_t i, MDNSQuestion** question); bool GetQuestion(qcc::String str, MDNSQuestion** question); /** * @internal * @brief Add an answer record to this packet * * @param record The answer record to add to this packet. */ void AddAnswer(MDNSResourceRecord record); /** * @internal * @brief Get the number of answer records contained in this packet. * * @return Number of answer records in this packet. */ uint16_t GetNumAnswers(); /** * @internal * @brief Get the answer at the particular index. * @param index The index to get the answer at. * @param answer[out] The MDNSResourceRecord into which the answer record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAnswerAt(uint32_t i, MDNSResourceRecord** answer); /** * @internal * @brief Get the answer with a particular name and type. * * @param str The desired name. * @param type The desired RRtype. * @param answer[out] The MDNSResourceRecord into which the answer record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAnswer(qcc::String str, MDNSResourceRecord::RRType type, MDNSResourceRecord** answer); /** * @internal * @brief Get the answer with a particular name, type, and rdata version. * * @param str The desired name. * @param type The desired RRtype. * @param version The desired version. * @param answer[out] The MDNSResourceRecord into which the answer record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAnswer(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, MDNSResourceRecord** answer); /** * @internal * @brief Add an additional record to this packet * * @param record The additional record to add to this packet. */ void AddAdditionalRecord(MDNSResourceRecord record); /** * @internal * @brief Get the number of additional records contained in this packet. * * @return Number of additional records in this packet. */ uint16_t GetNumAdditionalRecords(); /** * @internal * @brief Get the additional record at the particular index. * @param index The index to get the additional record at. * @param additional[out] The MDNSResourceRecord into which the additional record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAdditionalRecordAt(uint32_t i, MDNSResourceRecord** additional); /** * @internal * @brief Get the additional record with a particular name and type. * * @param str The desired name. This may be appended with a '*' to get the first * additional record with the matching prefix. * @param type The desired RRtype. * @param additional[out] The MDNSResourceRecord into which the additional record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type, MDNSResourceRecord** additional); /** * @internal * @brief Get the additional record with a particular name, type, and rdata version. * * @param str The desired name. * @param type The desired RRtype. * @param version The desired version * @param additional[out] The MDNSResourceRecord into which the additional record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, MDNSResourceRecord** additional); /** * @internal * @brief Get the additional record with a particular name, type, rdata version and particular index. * * @param str The desired name. * @param type The desired RRtype. * @param version The desired version * @param index The index to obtain in case of multiple matches * @param additional[out] The MDNSResourceRecord into which the additional record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAdditionalRecordAt(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, uint32_t index, MDNSResourceRecord** additional); /** * @internal * @brief Get number additional records matching a particular name, type, and rdata version. * * @param str The desired name. * @param type The desired RRtype. * @param version The desired version * * @return number of matches. */ uint32_t GetNumMatches(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version); TransportMask GetTransportMask(); /** * @internal * @brief Remove an additional record from this MDNS packet. * * @param str The name of the additional record to remove. * @param type The type of the additional record to remove. */ void RemoveAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type); void RemoveAnswer(qcc::String str, MDNSResourceRecord::RRType type); void RemoveQuestion(qcc::String str); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); /** * @internal * The minimum initial capacity reserved for each of the MDNS fields. */ static const uint32_t MIN_RESERVE = 8; private: MDNSHeader m_header; std::vector m_questions; std::vector m_answers; std::vector m_authority; std::vector m_additional; }; /** * Managed object type that wrap packets */ typedef qcc::ManagedObj<_Packet> Packet; typedef qcc::ManagedObj<_NSPacket> NSPacket; typedef qcc::ManagedObj<_MDNSPacket> MDNSPacket; } // namespace ajn #endif // _NS_PROTOCOL_H