#include <RetryableRequestMessageState.h>

Inheritance diagram for RetryableRequestMessageState:

Collaboration diagram for RetryableRequestMessageState:

Public Types
using	MessageHandler = std::function< void(Vehicle *vehicle, const mavlink_message_t &message)>

using	FailureHandler = std::function< void(Vehicle::RequestMessageResultHandlerFailureCode_t failureCode, MAV_RESULT result)>

using	SkipPredicate = std::function< bool()>

Public Types inherited from QGCAbstractState
using	EntryCallback = std::function< void()>

using	ExitCallback = std::function< void()>

using	EventHandler = std::function< bool(QEvent *)>

Signals
void	messageReceived (const mavlink_message_t &message)
	Emitted when message is successfully received.

void	retriesExhausted ()
	Emitted when all retries are exhausted.

Signals inherited from WaitStateBase
void	completed ()

void	timeout ()

void	timedOut ()

Signals inherited from QGCAbstractState
void	advance ()

void	error ()

Public Member Functions
	RetryableRequestMessageState (const QString &stateName, QState *parent, uint32_t messageId, MessageHandler messageHandler=nullptr, int maxRetries=1, int compId=MAV_COMP_ID_AUTOPILOT1, int timeoutMsecs=5000)

void	setFailureHandler (FailureHandler handler)
	Set handler called when all retries fail.

void	setSkipPredicate (SkipPredicate predicate)

void	setFailOnMaxRetries (bool fail)
	If true, emit error() after max retries instead of advance()

Vehicle::RequestMessageResultHandlerFailureCode_t	lastFailureCode () const
	Get the failure code from the last attempt.

MAV_RESULT	lastResult () const
	Get the MAV_RESULT from the last attempt.

int	retryCount () const
	Get current retry count.

int	maxRetries () const
	Get max retries setting.

Public Member Functions inherited from WaitStateBase
	WaitStateBase (const QString &stateName, QState *parent, int timeoutMsecs=0)

void	restartWait ()

Public Member Functions inherited from QGCState
	QGCState (const QString &stateName, QState *parentState)

template<typename PointerToMemberFunction >
QSignalTransition *	addThisTransition (PointerToMemberFunction signal, QAbstractState *target)
	Simpler version of QState::addTransition which assumes the sender is this.

void	setLocalErrorState (QAbstractState *errorState)

QAbstractState *	localErrorState () const
	Get the per-state error state (nullptr if using global)

void	setProperty (QObject object, const char name, const QVariant &value)

void	setEnabled (QObject *object, bool enabled)
	Convenience overload for setting enabled state on widgets/controls.

void	setVisible (QObject *object, bool visible)
	Convenience overload for setting visible state on widgets/controls.

Public Member Functions inherited from QGCAbstractState
	QGCAbstractState (const QString &stateName, QState *parent)

QGCStateMachine *	machine () const

Vehicle *	vehicle () const

QString	stateName () const

class StateContext *	context () const

void	setOnEntry (EntryCallback callback)
	Set a callback to be invoked when the state is entered.

void	setOnExit (ExitCallback callback)
	Set a callback to be invoked when the state is exited.

void	setCallbacks (EntryCallback onEntry, ExitCallback onExit=nullptr)
	Set both entry and exit callbacks.

void	setEventHandler (EventHandler handler)
	Set a custom event handler for this state.

Protected Member Functions
void	connectWaitSignal () override
	Subclasses override to set up their signal connections.

void	disconnectWaitSignal () override
	Subclasses override to tear down their signal connections.

void	onWaitEntered () override
	Called when the state is entered - subclasses should call base implementation.

void	onWaitExited () override
	Called when the state is exited - subclasses should call base implementation.

void	onWaitTimeout () override
	Called when the timeout expires - default emits timeout(), subclasses can override.

Protected Member Functions inherited from WaitStateBase
void	waitComplete ()

void	waitFailed ()

int	timeoutMsecs () const

Protected Member Functions inherited from QGCAbstractState
virtual void	onEnter ()
	Override to perform actions on state entry.

virtual void	onLeave ()
	Override to perform actions on state exit.

void	onEntry (QEvent *event) override

void	onExit (QEvent *event) override

bool	event (QEvent *event) override

Detailed Description

Requests a MAVLink message with built-in retry logic. On failure, retries up to maxRetries times before giving up.

Emits advance() on success or after all retries exhausted. Emits error() only if explicitly requested via failOnMaxRetries.

Example usage:

auto* state = new RetryableRequestMessageState(
    "GetVersion", &machine,
    MAVLINK_MSG_ID_AUTOPILOT_VERSION,
    [this](Vehicle* v, const mavlink_message_t& msg) {
        // Handle successful message
    },
    2  // max retries
);

Definition at line 25 of file RetryableRequestMessageState.h.

Member Typedef Documentation

◆ FailureHandler

using RetryableRequestMessageState::FailureHandler = std::function<void(Vehicle::RequestMessageResultHandlerFailureCode_t failureCode, MAV_RESULT result)>

Definition at line 32 of file RetryableRequestMessageState.h.

◆ MessageHandler

using RetryableRequestMessageState::MessageHandler = std::function<void(Vehicle* vehicle, const mavlink_message_t& message)>

Definition at line 31 of file RetryableRequestMessageState.h.

◆ SkipPredicate

using RetryableRequestMessageState::SkipPredicate = std::function<bool()>

Definition at line 33 of file RetryableRequestMessageState.h.

Constructor & Destructor Documentation

◆ RetryableRequestMessageState()

RetryableRequestMessageState::RetryableRequestMessageState	(	const QString &	stateName,
		QState *	parent,
		uint32_t	messageId,
		MessageHandler	messageHandler = `nullptr`,
		int	maxRetries = `1`,
		int	compId = `MAV_COMP_ID_AUTOPILOT1`,
		int	timeoutMsecs = `5000`
	)

Create a retryable request message state

Parameters

stateName	Name for this state
parent	Parent state
messageId	MAVLink message ID to request
messageHandler	Handler called on successful message receipt
maxRetries	Maximum retry attempts (default: 1)
compId	Component ID to request from (default: MAV_COMP_ID_AUTOPILOT1)
timeoutMsecs	Timeout per attempt in milliseconds (default: 5000)