irsol::server::handlers::AssignmentFrameRateHandler Class Reference

Handler for assignment of the frame rate parameter. More...

#include <assignment_frame_rate.hpp>

Inheritance diagram for irsol::server::handlers::AssignmentFrameRateHandler:

Public Member Functions
	AssignmentFrameRateHandler (std::shared_ptr< Context > ctx)
	Constructs the AssignmentFrameRateHandler.
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::Assignment &&message) final override
	Processes an assignment message to set the 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 assignment of the frame rate parameter.

Processes assignment messages to set the frame rate for frame collection in a client session.

Definition at line 24 of file assignment_frame_rate.hpp.

Constructor & Destructor Documentation

AssignmentFrameRateHandler()

irsol::server::handlers::AssignmentFrameRateHandler::AssignmentFrameRateHandler

(

std::shared_ptr< Context >

ctx

)

Constructs the AssignmentFrameRateHandler.

Parameters

ctx	Handler context.

Definition at line 9 of file assignment_frame_rate.cpp.

  : AssignmentHandler(ctx)
{}

Member Function Documentation

process()

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

finaloverrideprotected

Processes an assignment message to set the frame rate.

Parameters

session	The client session.
message	The assignment message.

Returns

Vector of outbound messages (success or error).

Definition at line 14 of file assignment_frame_rate.cpp.

{
  auto& frameListeningState = session->userData().frameListeningState;
  if(frameListeningState.running()) {
    IRSOL_NAMED_LOG_WARN(
      session->id(), "Session is already listening to frames. Cannot set a frameRate.");
    std::vector<out_message_t> result;
    result.emplace_back(irsol::protocol::Error::from(
      message, "Session is already listening to frames. Cannot set a frameRate."));
    return result;
  }
  const double frameRate = irsol::utils::toDouble(message.value);
  if(frameRate <= 0) {
    IRSOL_NAMED_LOG_WARN(session->id(), "frameRate ({}) must be positive.", frameRate);
    std::vector<out_message_t> result;
    result.emplace_back(irsol::protocol::Error::from(message, "frameRate must be positive."));
    return result;
  }
  IRSOL_NAMED_LOG_INFO(session->id(), "Setting 'frameRate' to {}", frameRate);
 
  frameListeningState.gisParams.frameRate = frameRate;
  std::vector<out_message_t> result;
  result.emplace_back(irsol::protocol::Success::from(message));
  return result;
}

---

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

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