packetscheduler.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_NETWORK
#include <cstdint>
#include <promeki/duration.h>
#include <promeki/enums_rtp.h>
#include <promeki/error.h>
#include <promeki/namespace.h>
#include <promeki/packettransport.h>
#include <promeki/uniqueptr.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class PacketScheduler {
        public:
                using UPtr = UniquePtr<PacketScheduler>;
 
                struct Spec {
                                Duration frameInterval;
 
                                uint64_t bytesPerSec = 0;
 
                                int packetsPerFrame = 0;
 
                                int trOffsetUs = 0;
 
                                int maxUdp = 0;
                };
 
                enum class CadenceMode {
                        PerBatch,
                        Streamwide,
                };
 
                PacketScheduler() = default;
                virtual ~PacketScheduler() = default;
 
                PacketScheduler(const PacketScheduler &) = delete;
                PacketScheduler &operator=(const PacketScheduler &) = delete;
 
                void setTransport(PacketTransport *t) { _transport = t; }
 
                PacketTransport *transport() const { return _transport; }
 
                virtual Error configure(const Spec &spec);
 
                Error setRate(uint64_t bytesPerSec);
 
                void setCadenceMode(CadenceMode mode) { _cadenceMode = mode; }
 
                CadenceMode cadenceMode() const { return _cadenceMode; }
 
                virtual int enqueue(const PacketTransport::DatagramList &datagrams) = 0;
 
                virtual int predictedTxDelayUs() const { return 0; }
 
                virtual Error flushPending() { return Error::Ok; }
 
                virtual Error abort() { return Error::Ok; }
 
                const Spec &spec() const { return _spec; }
 
                static UPtr create(const Enum &mode, PacketTransport *transport);
 
        protected:
                PacketTransport *_transport = nullptr;
                Spec             _spec;
                CadenceMode      _cadenceMode = CadenceMode::PerBatch;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_NETWORK