kurlyk::BaseWebSocketClient::FSMEventData Struct Reference

Represents an event in the finite state machine (FSM) with optional associated data and callback. More...

Public Member Functions
	FSMEventData (FSMEventData &&other) noexcept
	Move constructor for FSMEventData.
FSMEventData &	operator= (FSMEventData &&other) noexcept
	Move assignment operator for FSMEventData.
	FSMEventData (const FSMEventData &)=delete
	Deleted copy constructor to prevent copying.
FSMEventData &	operator= (const FSMEventData &)=delete
	Deleted copy assignment operator to prevent copying.
	FSMEventData (FsmEvent event_type, std::unique_ptr< WebSocketEventData > &&event_data)
	Constructs FSMEventData with an event type and WebSocket event data.
	FSMEventData (FsmEvent event_type, std::unique_ptr< WebSocketConfig > &&config_data, std::function< void(bool)> &&callback)
	Constructs FSMEventData with an event type, configuration data, and a callback.
	FSMEventData (FsmEvent event_type, std::function< void(bool)> &&callback)
	Constructs FSMEventData with an event type and a callback.
	FSMEventData (FsmEvent event_type)
	Constructs FSMEventData with only an event type.

Public Attributes
FsmEvent	event_type
	The type of the FSM event.
std::unique_ptr< WebSocketEventData >	event_data
	Optional WebSocket event data associated with the FSM event.
std::unique_ptr< WebSocketConfig >	config_data
	Optional configuration data for FSM settings.
std::function< void(bool)>	callback
	Optional callback function to execute on event completion.

Detailed Description

Represents an event in the finite state machine (FSM) with optional associated data and callback.

Definition at line 261 of file BaseWebSocketClient.hpp.

Constructor & Destructor Documentation

FSMEventData() [1/6]

kurlyk::BaseWebSocketClient::FSMEventData::FSMEventData ( FSMEventData && other )

inlinenoexcept

Move constructor for FSMEventData.

Transfers ownership of the event data, configuration data, and callback from another FSMEventData instance.

Definition at line 269 of file BaseWebSocketClient.hpp.

FSMEventData() [2/6]

kurlyk::BaseWebSocketClient::FSMEventData::FSMEventData ( const FSMEventData & )

delete

Deleted copy constructor to prevent copying.

FSMEventData() [3/6]

kurlyk::BaseWebSocketClient::FSMEventData::FSMEventData ( FsmEvent event_type, std::unique_ptr< WebSocketEventData > && event_data )

inline

Constructs FSMEventData with an event type and WebSocket event data.

Parameters

event_type	The type of the FSM event.
event_data	Unique pointer to the WebSocket event data.

Definition at line 298 of file BaseWebSocketClient.hpp.

FSMEventData() [4/6]

kurlyk::BaseWebSocketClient::FSMEventData::FSMEventData ( FsmEvent event_type, std::unique_ptr< WebSocketConfig > && config_data, std::function< void(bool)> && callback )

inline

Constructs FSMEventData with an event type, configuration data, and a callback.

Parameters

event_type	The type of the FSM event.
config_data	Unique pointer to the configuration data.
callback	Callback function to be executed on event completion.

Definition at line 309 of file BaseWebSocketClient.hpp.

FSMEventData() [5/6]

kurlyk::BaseWebSocketClient::FSMEventData::FSMEventData ( FsmEvent event_type, std::function< void(bool)> && callback )

inline

Constructs FSMEventData with an event type and a callback.

Parameters

event_type	The type of the FSM event.
callback	Callback function to be executed on event completion.

Definition at line 321 of file BaseWebSocketClient.hpp.

FSMEventData() [6/6]

kurlyk::BaseWebSocketClient::FSMEventData::FSMEventData ( FsmEvent event_type )

inline

Constructs FSMEventData with only an event type.

Parameters

event_type

The type of the FSM event.

Definition at line 330 of file BaseWebSocketClient.hpp.

Member Function Documentation

operator=() [1/2]

FSMEventData & kurlyk::BaseWebSocketClient::FSMEventData::operator= ( const FSMEventData & )

delete

Deleted copy assignment operator to prevent copying.

operator=() [2/2]

FSMEventData & kurlyk::BaseWebSocketClient::FSMEventData::operator= ( FSMEventData && other )

inlinenoexcept

Move assignment operator for FSMEventData.

Transfers ownership of the event data, configuration data, and callback from another FSMEventData instance.

Returns

A reference to this FSMEventData instance.

Definition at line 279 of file BaseWebSocketClient.hpp.

Member Data Documentation

callback

std::function<void(bool)> kurlyk::BaseWebSocketClient::FSMEventData::callback

Optional callback function to execute on event completion.

Definition at line 265 of file BaseWebSocketClient.hpp.

config_data

std::unique_ptr<WebSocketConfig> kurlyk::BaseWebSocketClient::FSMEventData::config_data

Optional configuration data for FSM settings.

Definition at line 264 of file BaseWebSocketClient.hpp.

event_data

std::unique_ptr<WebSocketEventData> kurlyk::BaseWebSocketClient::FSMEventData::event_data

Optional WebSocket event data associated with the FSM event.

Definition at line 263 of file BaseWebSocketClient.hpp.

event_type

FsmEvent kurlyk::BaseWebSocketClient::FSMEventData::event_type

The type of the FSM event.

Definition at line 262 of file BaseWebSocketClient.hpp.

---

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

• include/kurlyk/websocket/client/BaseWebSocketClient.hpp