lintel 0.2.0
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
lintel::MessageQueueDto Class Reference

#include <MessageQueueDto.h>

Inheritance diagram for lintel::MessageQueueDto:
lintel::JsonSerializable

Public Member Functions

 MessageQueueDto ()=default
 
 MessageQueueDto (const MessageQueueEntry &messsageQueueEntry, int32_t messages)
 
const std::string & getName () const
 
const std::string & getProcess () const
 
int32_t getMaxMessages () const
 
int32_t getMessages () const
 
void serialize (rapidjson::Writer< rapidjson::StringBuffer > *writer) const override
 
bool deserialize (const rapidjson::Value &obj) override
 
- Public Member Functions inherited from lintel::JsonSerializable
 JsonSerializable ()=default
 
virtual ~JsonSerializable ()=default
 
virtual std::string serialize () const
 
virtual void deserialize (const std::string &json)
 

Detailed Description

DTO representing a single message queue with its current state

Constructor & Destructor Documentation

◆ MessageQueueDto() [1/2]

lintel::MessageQueueDto::MessageQueueDto ( )
default

Default constructor

◆ MessageQueueDto() [2/2]

lintel::MessageQueueDto::MessageQueueDto ( const MessageQueueEntry &  messsageQueueEntry,
int32_t  messages 
)

Construct from a MessageQueueEntry and current message count

Parameters
messsageQueueEntryThe configuration entry
messagesThe current message count

Member Function Documentation

◆ deserialize()

bool lintel::MessageQueueDto::deserialize ( const rapidjson::Value &  obj)
overridevirtual

Deserialize from JSON

Parameters
objThe JSON value
Returns
True on success

Reimplemented from lintel::JsonSerializable.

◆ getMaxMessages()

int32_t lintel::MessageQueueDto::getMaxMessages ( ) const

Get the maximum message count

Returns
The max messages

◆ getMessages()

int32_t lintel::MessageQueueDto::getMessages ( ) const

Get the current message count

Returns
The current messages

◆ getName()

const std::string & lintel::MessageQueueDto::getName ( ) const

Get the queue name

Returns
The name

◆ getProcess()

const std::string & lintel::MessageQueueDto::getProcess ( ) const

Get the owning process name

Returns
The process name

◆ serialize()

void lintel::MessageQueueDto::serialize ( rapidjson::Writer< rapidjson::StringBuffer > *  writer) const
overridevirtual

Serialize to JSON

Parameters
writerThe rapidjson writer

Implements lintel::JsonSerializable.


The documentation for this class was generated from the following file: