/* * Copyright (c)2013-2020 ZeroTier, Inc. * * Use of this software is governed by the Business Source License included * in the LICENSE.TXT file in the project's root directory. * * Change Date: 2024-01-01 * * On the date above, in accordance with the Business Source License, use * of this software will be governed by version 2.0 of the Apache License. */ /****/ #ifndef ZT_INCOMINGPACKET_HPP #define ZT_INCOMINGPACKET_HPP #include "Packet.hpp" #include "Path.hpp" #include "Utils.hpp" #include "MulticastGroup.hpp" #include "Peer.hpp" /* * The big picture: * * tryDecode gets called for a given fully-assembled packet until it returns * true or the packet's time to live has been exceeded, in which case it is * discarded as failed decode. Any exception thrown by tryDecode also causes * the packet to be discarded. * * Thus a return of false from tryDecode() indicates that it should be called * again. Logic is very simple as to when, and it's in doAnythingWaitingForPeer * in Switch. This might be expanded to be more fine grained in the future. * * A return value of true indicates that the packet is done. tryDecode must * never be called again after that. */ namespace ZeroTier { class RuntimeEnvironment; class Network; class IncomingPacket : public Packet { public: ZT_ALWAYS_INLINE IncomingPacket() : Packet(),_receiveTime(0),_path() {} /** * Create a new packet-in-decode * * @param data Packet data * @param len Packet length * @param path Path over which packet arrived * @param now Current time * @throws std::out_of_range Range error processing packet */ ZT_ALWAYS_INLINE IncomingPacket(const void *data,unsigned int len,const SharedPtr &path,int64_t now) : Packet(data,len), _receiveTime(now), _path(path) { } /** * Init packet-in-decode in place * * @param data Packet data * @param len Packet length * @param path Path over which packet arrived * @param now Current time * @throws std::out_of_range Range error processing packet */ ZT_ALWAYS_INLINE void init(const void *data,unsigned int len,const SharedPtr &path,int64_t now) { copyFrom(data,len); _receiveTime = now; _path = path; } /** * Attempt to decode this packet * * Note that this returns 'true' if processing is complete. This says nothing * about whether the packet was valid. A rejection is 'complete.' * * Once true is returned, this must not be called again. The packet's state * may no longer be valid. * * @param RR Runtime environment * @param tPtr Thread pointer to be handed through to any callbacks called as a result of this call * @return True if decoding and processing is complete, false if caller should try again */ bool tryDecode(const RuntimeEnvironment *RR,void *tPtr); /** * @return Time of packet receipt / start of decode */ ZT_ALWAYS_INLINE uint64_t receiveTime() const { return _receiveTime; } private: uint64_t _receiveTime; SharedPtr _path; }; } // namespace ZeroTier #endif