udpsocket.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_NETWORK
#include <promeki/buffer.h>
#include <promeki/list.h>
#include <promeki/abstractsocket.h>
#include <promeki/uniqueptr.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class UdpSocket : public AbstractSocket {
                PROMEKI_OBJECT(UdpSocket, AbstractSocket)
        public:
                using UPtr = UniquePtr<UdpSocket>;
 
                struct Datagram {
                                const void   *data = nullptr; 
                                size_t        size = 0;       
                                SocketAddress dest;           
                                uint64_t      txTimeNs =
                                        0; 
                };
 
                using DatagramList = ::promeki::List<Datagram>;
 
                static constexpr uint64_t PacingRateUnlimited = ~static_cast<uint64_t>(0);
 
                UdpSocket(ObjectBase *parent = nullptr);
 
                ~UdpSocket() override;
 
                Error open(OpenMode mode) override;
 
                Error openIpv6(OpenMode mode);
 
                Error close() override;
 
                bool isOpen() const override { return _fd >= 0; }
 
                int64_t read(void *data, int64_t maxSize) override;
 
                int64_t write(const void *data, int64_t maxSize) override;
 
                int64_t bytesAvailable() const override;
 
                int64_t writeDatagram(const void *data, size_t size, const SocketAddress &dest);
 
                int64_t writeDatagram(const Buffer &data, const SocketAddress &dest);
 
                int writeDatagrams(const DatagramList &datagrams);
 
                Error setPacingRate(uint64_t bytesPerSec);
 
                Error clearPacingRate();
 
                Error setTxTime(bool enable, int clockId = 11 /* CLOCK_TAI */);
 
                int64_t readDatagram(void *data, size_t maxSize, SocketAddress *sender = nullptr);
 
                Error setReceivePktInfo(bool enable);
 
                int64_t readDatagramWithIfIndex(void *data, size_t maxSize,
                                                SocketAddress *sender = nullptr,
                                                unsigned int  *ifindex = nullptr);
 
                bool hasPendingDatagrams() const;
 
                int64_t pendingDatagramSize() const;
 
                Error joinMulticastGroup(const SocketAddress &group);
 
                Error joinMulticastGroup(const SocketAddress &group, const String &iface);
 
                Error leaveMulticastGroup(const SocketAddress &group);
 
                Error setMulticastTTL(int ttl);
 
                Error setMulticastLoopback(bool enable);
 
                Error setMulticastInterface(const String &iface);
 
                Error setBindInterface(const String &iface);
 
                Error setReuseAddress(bool enable);
 
                Error setDscp(uint8_t dscp);
 
                Error setDontFragment(bool enable);
 
                Error setReceiveBufferSize(int bytes);
 
                Error setSendBufferSize(int bytes);
 
        private:
                int _domain = 0; 
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_NETWORK