Encapsulates data for a WebSocket event, providing information about event type, message, status, and errors. More...

#include <WebSocketEventData.hpp>

Public Attributes
WebSocketEventType	event_type
	Type of the WebSocket event, defining what occurred (e.g., Open, Close, Message, Error).

std::string	message
	The message content associated with the event, if any.

long	status_code
	Status code related to the event, set during the `Open` event (e.g., HTTP status code).

std::error_code	error_code
	Error code for the `Error` event, if an error occurred.

WebSocketSenderPtr	sender
	Pointer to the WebSocket sender, allowing further actions related to this event.

Detailed Description

Encapsulates data for a WebSocket event, providing information about event type, message, status, and errors.

This class is used to represent events that occur within the WebSocket lifecycle, such as connection open, message received, connection close, or errors.

Definition at line 15 of file WebSocketEventData.hpp.

Member Data Documentation

◆ error_code

std::error_code kurlyk::WebSocketEventData::error_code

Error code for the Error event, if an error occurred.

Definition at line 20 of file WebSocketEventData.hpp.

◆ event_type

WebSocketEventType kurlyk::WebSocketEventData::event_type

Type of the WebSocket event, defining what occurred (e.g., Open, Close, Message, Error).

Definition at line 17 of file WebSocketEventData.hpp.

◆ message

std::string kurlyk::WebSocketEventData::message

The message content associated with the event, if any.

Definition at line 18 of file WebSocketEventData.hpp.

◆ sender

WebSocketSenderPtr kurlyk::WebSocketEventData::sender

Pointer to the WebSocket sender, allowing further actions related to this event.

Definition at line 21 of file WebSocketEventData.hpp.

◆ status_code

long kurlyk::WebSocketEventData::status_code

Status code related to the event, set during the Open event (e.g., HTTP status code).

Definition at line 19 of file WebSocketEventData.hpp.

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

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