Skip to content

Commit

Permalink
Refactor MQTT::onReceive to reduce if/else nesting (#5592)
Browse files Browse the repository at this point in the history
* Refactor MQTT::onReceive to reduce if/else nesting

* Fix missing #include <functional>

* const DecodedServiceEnvelope e

* Combine validDecode if statement.

* Only call pb_release when validDecode.

* s/ptr/channelName/

* Use reference type for deleter

* Use lambda instead of bind

* Document deleter

* Reorder 'if's to avoid object creation

* Remove unnecessary comment

* Remove 'else'; simpifies #5516

---------

Co-authored-by: Ben Meadors <[email protected]>
  • Loading branch information
esev and thebentern authored Dec 19, 2024
1 parent 6841348 commit 8c6eec5
Show file tree
Hide file tree
Showing 4 changed files with 209 additions and 175 deletions.
23 changes: 23 additions & 0 deletions src/mesh/MemoryPool.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@

#include <Arduino.h>
#include <assert.h>
#include <functional>
#include <memory>

#include "PointerQueue.h"

template <class T> class Allocator
{

public:
Allocator() : deleter([this](T *p) { this->release(p); }) {}
virtual ~Allocator() {}

/// Return a queable object which has been prefilled with zeros. Panic if no buffer is available
Expand Down Expand Up @@ -43,12 +46,32 @@ template <class T> class Allocator
return p;
}

/// Variations of the above methods that return std::unique_ptr instead of raw pointers.
using UniqueAllocation = std::unique_ptr<T, const std::function<void(T *)> &>;
/// Return a queable object which has been prefilled with zeros.
/// std::unique_ptr wrapped variant of allocZeroed().
UniqueAllocation allocUniqueZeroed() { return UniqueAllocation(allocZeroed(), deleter); }
/// Return a queable object which has been prefilled with zeros - allow timeout to wait for available buffers (you probably
/// don't want this version).
/// std::unique_ptr wrapped variant of allocZeroed(TickType_t maxWait).
UniqueAllocation allocUniqueZeroed(TickType_t maxWait) { return UniqueAllocation(allocZeroed(maxWait), deleter); }
/// Return a queable object which is a copy of some other object
/// std::unique_ptr wrapped variant of allocCopy(const T &src, TickType_t maxWait).
UniqueAllocation allocUniqueCopy(const T &src, TickType_t maxWait = portMAX_DELAY)
{
return UniqueAllocation(allocCopy(src, maxWait), deleter);
}

/// Return a buffer for use by others
virtual void release(T *p) = 0;

protected:
// Alloc some storage
virtual T *alloc(TickType_t maxWait) = 0;

private:
// std::unique_ptr Deleter function; calls release().
const std::function<void(T *)> deleter;
};

/**
Expand Down
1 change: 1 addition & 0 deletions src/mesh/MeshTypes.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ typedef int ErrorCode;

/// Alloc and free packets to our global, ISR safe pool
extern Allocator<meshtastic_MeshPacket> &packetPool;
using UniquePacketPoolPacket = Allocator<meshtastic_MeshPacket>::UniqueAllocation;

/**
* Most (but not always) of the time we want to treat packets 'from' the local phone (where from == 0), as if they originated on
Expand Down
Loading

0 comments on commit 8c6eec5

Please sign in to comment.