WardenPayloadMgr Class Reference

The WardenPayloadMgr is responsible for maintaining custom payloads used by modules. More...

#include "WardenPayloadMgr.h"

Public Member Functions
	WardenPayloadMgr ()
uint16	GetFreePayloadId ()
	Finds a free payload id in WardenPayloadMgr::CachedChecks. More...
uint16	RegisterPayload (const std::string &payload)
	Register a payload into cache and returns its payload id. More...
bool	RegisterPayload (std::string const &payload, uint16 payloadId, bool replace=false)
	Register a payload into cache with a custom id and returns the result. More...
bool	UnregisterPayload (uint16 payloadId)
	Unregister a payload from cache and return if successful. More...
WardenCheck *	GetPayloadById (uint16 payloadId)
	Get a payload by id from the WardenPayloadMgr::CachedChecks. More...
void	QueuePayload (uint16 payloadId, bool pushToFront=false)
	Queue the payload into the normal warden checks. More...
bool	DequeuePayload (uint16 payloadId)
	Dequeue the payload from the WardenPayloadMgr::QueuedPayloads queue. More...
void	ClearQueuedPayloads ()
	Clear the payloads from the WardenPayloadMgr::QueuedPayloads queue. More...
uint32	GetPayloadCountInQueue ()
	Get the amount of payloads waiting in WardenPayloadMgr::QueuedPayloads. More...
std::list< uint16 > *	GetPayloadsInQueue ()
	Get payloads waiting in WardenPayloadMgr::QueuedPayloads. More...

Public Attributes
std::list< uint16 >	QueuedPayloads
	The list of currently queued payload ids to be sent through Warden. More...
std::map< uint16, WardenCheck >	CachedChecks
	The cached payloads that are accessed by payload id. More...

Static Public Attributes
static uint16 constexpr	WardenPayloadOffsetMin = 5000
	The minimum id available for custom payloads. More...
static uint16 constexpr	WardenPayloadOffsetMax = 9999
	The maximum id available for custom payloads. More...
static uint32 constexpr	WardenPayloadCheckType = 139
	The checktype used for warden payloads. More...

Detailed Description

The WardenPayloadMgr is responsible for maintaining custom payloads used by modules.

This allows users to send custom lua payloads up to a size of 512 bytes to the game client. Some of the things you can achieve with this is:

• Interaction with the client interface (add custom frames)
• Access to client CVars
• Access to protected lua functions.

Opening up many possiblilties for a patch-less custom server.

Constructor & Destructor Documentation

WardenPayloadMgr()

WardenPayloadMgr::WardenPayloadMgr

(

)

{ }

Member Function Documentation

ClearQueuedPayloads()

void WardenPayloadMgr::ClearQueuedPayloads

(

)

Clear the payloads from the WardenPayloadMgr::QueuedPayloads queue.

{
    QueuedPayloads.clear();
}

References QueuedPayloads.

DequeuePayload()

bool WardenPayloadMgr::DequeuePayload

(

uint16

payloadId

)

Dequeue the payload from the WardenPayloadMgr::QueuedPayloads queue.

Parameters

payloadId

The payloadId to be dequeued.

Returns

bool If the payload was removed.

{
    std::size_t const queueSize = QueuedPayloads.size();
    QueuedPayloads.remove(payloadId);
 
    return queueSize != QueuedPayloads.size();
}

References QueuedPayloads.

GetFreePayloadId()

uint16 WardenPayloadMgr::GetFreePayloadId

(

)

Finds a free payload id in WardenPayloadMgr::CachedChecks.

Returns

uint16 The free payload id. Returns 0 if there is no free id.

{
    uint16 payloadId = WardenPayloadOffsetMin;
 
    while (CachedChecks.find(payloadId) != CachedChecks.end())
    {
        payloadId++;
 
        if (payloadId > WardenPayloadMgr::WardenPayloadOffsetMax)
        {
            LOG_ERROR("warden", "Max warden payload id of '{}' passed!", WardenPayloadMgr::WardenPayloadOffsetMax);
            return 0;
        }
    }
 
    return payloadId;
}

References CachedChecks, LOG_ERROR, WardenPayloadOffsetMax, and WardenPayloadOffsetMin.

Referenced by RegisterPayload().

GetPayloadById()

WardenCheck * WardenPayloadMgr::GetPayloadById

(

uint16

payloadId

)

Get a payload by id from the WardenPayloadMgr::CachedChecks.

Parameters

payloadId

The payload to fetched from WardenPayloadMgr::CachedChecks.

Returns

WardenCheck* A pointer to the WardenCheck payload.

{
    auto it = CachedChecks.find(payloadId);
 
    if (it != CachedChecks.end())
    {
        return &it->second;
    }
 
    return nullptr;
}

References CachedChecks.

GetPayloadCountInQueue()

uint32 WardenPayloadMgr::GetPayloadCountInQueue

(

)

Get the amount of payloads waiting in WardenPayloadMgr::QueuedPayloads.

Returns

The amount of payloads in queue.

{
    return QueuedPayloads.size();
}

References QueuedPayloads.

GetPayloadsInQueue()

std::list< uint16 > * WardenPayloadMgr::GetPayloadsInQueue

(

)

Get payloads waiting in WardenPayloadMgr::QueuedPayloads.

Returns

The payloads in queue.

{
    return &QueuedPayloads;
}

References QueuedPayloads.

QueuePayload()

void WardenPayloadMgr::QueuePayload	(	uint16	payloadId,
		bool	pushToFront = false
	)

Queue the payload into the normal warden checks.

Parameters

payloadId	The payloadId to be queued.
pushToFront	If payload should be pushed to the front queue.

{
    auto it = CachedChecks.find(payloadId);
 
    //Do not queue a payload if there is no payload matching the payloadId.
    if (it == CachedChecks.end())
    {
        LOG_ERROR("warden", "Failed to queue payload id '{}' as it does not exist in CachedChecks.", payloadId);
        return;
    }
 
    if (pushToFront)
    {
        QueuedPayloads.push_front(payloadId);
    }
    else
    {
        QueuedPayloads.push_back(payloadId);
    }
}

References CachedChecks, LOG_ERROR, and QueuedPayloads.

RegisterPayload() [1/2]

uint16 WardenPayloadMgr::RegisterPayload

(

const std::string &

payload

)

Register a payload into cache and returns its payload id.

Parameters

payload

The payload to be stored in WardenPayloadMgr::CachedChecks.

Returns

uint16 The payload id for use with WardenPayloadMgr::QueuePayload. Returns 0 if it failed to register.

Note

• Payloads are truncated to 512 bytes on the client, you may have to register your payloads in chunks if they are larger than this.

{
    uint16 payloadId = GetFreePayloadId();
 
    if (!payloadId || !RegisterPayload(payload, payloadId, false))
    {
        LOG_ERROR("warden", "Failed to register payload.");
        return 0;
    }
 
    return payloadId;
}

References GetFreePayloadId(), LOG_ERROR, and RegisterPayload().

Referenced by RegisterPayload().

RegisterPayload() [2/2]

bool WardenPayloadMgr::RegisterPayload	(	std::string const &	payload,
		uint16	payloadId,
		bool	replace = false
	)

Register a payload into cache with a custom id and returns the result.

Parameters

payload	The payload to be stored in WardenPayloadMgr::CachedChecks.
payloadId	The payload id to be stored as the key in WardenPayloadMgr::CachedChecks.
replace	Whether the key should replace an existing entry value.

Returns

bool The payload insertion result. If exists it will return false, otherwise true.

Note

• Payloads are truncated to 512 bytes on the client, you may have to register your payloads in chunks if they are larger than this.
• It's a good idea to keep the value for payloadId between 9000-9999 for self defined payloads as they're the least likely occupied ids.

{
    //Payload id should be over or equal to the offset to prevent conflicts.
    if (payloadId < WardenPayloadMgr::WardenPayloadOffsetMin)
    {
        LOG_ERROR("warden", "Tried to register payloadId lower than '{}'.", WardenPayloadMgr::WardenPayloadOffsetMin);
        return false;
    }
 
    auto it = CachedChecks.find(payloadId);
    if (it != CachedChecks.end() && !replace)
    {
        LOG_ERROR("warden", "Payload Id '{}' already exists in CachedChecks.", payloadId);
        return false;
    }
 
    WardenCheck wCheck;
    wCheck.Type = WardenPayloadMgr::WardenPayloadCheckType;
    wCheck.Str = payload;
    wCheck.CheckId = payloadId;
 
    std::string idStr = Acore::StringFormat("{:04}", payloadId);
    ASSERT(idStr.size() == 4);
    std::copy(idStr.begin(), idStr.end(), wCheck.IdStr.begin());
 
    if (replace)
    {
        CachedChecks.erase(payloadId);
    }
 
    CachedChecks.emplace(payloadId, wCheck);
 
    return true;
}

References ASSERT, CachedChecks, WardenCheck::CheckId, WardenCheck::IdStr, LOG_ERROR, WardenCheck::Str, Acore::StringFormat(), WardenCheck::Type, WardenPayloadCheckType, and WardenPayloadOffsetMin.

UnregisterPayload()

bool WardenPayloadMgr::UnregisterPayload

(

uint16

payloadId

)

Unregister a payload from cache and return if successful.

Parameters

payloadId

The payload to removed from WardenPayloadMgr::CachedChecks.

Returns

bool If the payloadId was present.

{
    return CachedChecks.erase(payloadId);
}

References CachedChecks.

Member Data Documentation

CachedChecks

std::map<uint16, WardenCheck> WardenPayloadMgr::CachedChecks

The cached payloads that are accessed by payload id.

Referenced by GetFreePayloadId(), GetPayloadById(), WardenWin::HandleData(), QueuePayload(), RegisterPayload(), WardenWin::RequestChecks(), and UnregisterPayload().

QueuedPayloads

std::list<uint16> WardenPayloadMgr::QueuedPayloads

The list of currently queued payload ids to be sent through Warden.

Referenced by ClearQueuedPayloads(), DequeuePayload(), GetPayloadCountInQueue(), GetPayloadsInQueue(), QueuePayload(), and WardenWin::RequestChecks().

WardenPayloadCheckType

uint32 constexpr WardenPayloadMgr::WardenPayloadCheckType = 139

staticconstexpr

The checktype used for warden payloads.

Referenced by RegisterPayload().

WardenPayloadOffsetMax

uint16 constexpr WardenPayloadMgr::WardenPayloadOffsetMax = 9999

staticconstexpr

The maximum id available for custom payloads.

Referenced by GetFreePayloadId().

WardenPayloadOffsetMin

uint16 constexpr WardenPayloadMgr::WardenPayloadOffsetMin = 5000

staticconstexpr

The minimum id available for custom payloads.

Referenced by GetCheckPacketSize(), GetFreePayloadId(), WardenWin::HandleData(), RegisterPayload(), and WardenWin::RequestChecks().