irsol::server::handlers::InquiryFrameRateHandler Class Reference

Handler for inquiry of the current frame rate parameter. More...

#include <inquiry_frame_rate.hpp>

Inheritance diagram for irsol::server::handlers::InquiryFrameRateHandler:

Public Member Functions
	InquiryFrameRateHandler (std::shared_ptr< Context > ctx)
	Constructs the InquiryFrameRateHandler.
Public Member Functions inherited from irsol::server::handlers::internal::HandlerBase< T, >
virtual std::vector< out_message_t >	operator() (const irsol::types::client_id_t &clientId, T &&message)
	Invokes the handler for a given client and message.

Protected Member Functions
std::vector< out_message_t >	process (std::shared_ptr< irsol::server::ClientSession > session, protocol::Inquiry &&message) final override
	Processes an inquiry message to retrieve the current frame rate.
Protected Member Functions inherited from irsol::server::handlers::internal::HandlerBase< T, >
	HandlerBase (std::shared_ptr< Context > ctx)
	Constructs the handler base.
virtual std::vector< out_message_t >	process (std::shared_ptr< irsol::server::ClientSession > session, T &&message)=0
	Processes the protocol message for the given session.

Additional Inherited Members
Protected Attributes inherited from irsol::server::handlers::internal::HandlerBase< T, >
std::shared_ptr< Context >	ctx
	Handler context (provides access to app and utilities).

Detailed Description

Handler for inquiry of the current frame rate parameter.

Processes inquiry messages to retrieve the current frame rate setting.

Definition at line 23 of file inquiry_frame_rate.hpp.

Constructor & Destructor Documentation

InquiryFrameRateHandler()

irsol::server::handlers::InquiryFrameRateHandler::InquiryFrameRateHandler

(

std::shared_ptr< Context >

ctx

)

Constructs the InquiryFrameRateHandler.

Parameters

ctx	Handler context.

Definition at line 11 of file inquiry_frame_rate.cpp.

                                                                          : InquiryHandler(ctx)
{}

Member Function Documentation

process()

std::vector< out_message_t > irsol::server::handlers::InquiryFrameRateHandler::process ( std::shared_ptr< irsol::server::ClientSession >  session, protocol::Inquiry &&  message  )

finaloverrideprotected

Processes an inquiry message to retrieve the current frame rate.

Parameters

session	The client session.
message	The inquiry message.

Returns

Vector of outbound messages containing the frame rate.

Definition at line 15 of file inquiry_frame_rate.cpp.

{
  auto& frameListeningState = session->userData().frameListeningState;
  auto  frameRate           = frameListeningState.gisParams.frameRate;
 
  std::vector<out_message_t> result;
  result.emplace_back(
    irsol::protocol::Success::from(message, irsol::types::protocol_value_t{frameRate}));
  return result;
}

---

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

• src/irsol/include/irsol/server/handlers/inquiry_frame_rate.hpp
• src/irsol/lib/irsol/server/handlers/inquiry_frame_rate.cpp