Base handler for frame acquisition commands (gi, gis). More...

#include <command_gi_base.hpp>

Inheritance diagram for irsol::server::handlers::internal::CommandGIBaseHandler:

Public Member Functions
	CommandGIBaseHandler (std::shared_ptr< Context > ctx)
	Constructs the CommandGIBaseHandler.

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::Command &&message) final override
	Processes a frame acquisition command, starting the frame collection thread.

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.

Private Member Functions
std::string	getDescription (const protocol::Command &message, std::shared_ptr< irsol::server::ClientSession > session) const
	Generates a description string for the command execution.

virtual std::vector< irsol::protocol::OutMessage >	validate (const protocol::Command &message, std::shared_ptr< irsol::server::ClientSession > session) const =0
	Validates parameters before starting listener thread.

virtual uint64_t	getInputSequenceLength (const protocol::Command &message, std::shared_ptr< irsol::server::ClientSession > session) const =0
	Retrieves the input sequence length to use to start the listening.

virtual double	getFrameRate (const protocol::Command &message, std::shared_ptr< irsol::server::ClientSession > session) const =0
	Retrieves the frame rate to use to start the listening.

void	startListeningThread (std::shared_ptr< irsol::server::ClientSession > session, std::shared_ptr< irsol::server::frame_collector::FrameCollector::frame_queue_t > queue, protocol::Command &&command, const std::string &description)
	Starts the frame listening thread for the client 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

Base handler for frame acquisition commands (gi, gis).

Provides common logic for starting frame collection and managing client registration.

See also: irsol::server::handlers::CommandGIHandler; irsol::server::handlers::CommandGISHandler

Definition at line 32 of file command_gi_base.hpp.

Constructor & Destructor Documentation

◆ CommandGIBaseHandler()

irsol::server::handlers::internal::CommandGIBaseHandler::CommandGIBaseHandler ( std::shared_ptr< Context > ctx )

Constructs the CommandGIBaseHandler.

Parameters

ctx	Handler context.

Definition at line 21 of file command_gi_base.cpp.

21: CommandHandler(ctx) {}

irsol::server::handlers::internal::HandlerBase::ctx

std::shared_ptr< Context > ctx

Handler context (provides access to app and utilities).

Definition base.hpp:81

irsol::server::handlers::CommandHandler

internal::HandlerBase< protocol::Command > CommandHandler

Handler type for command messages.

Definition base.hpp:96

Member Function Documentation

◆ getDescription()

std::string irsol::server::handlers::internal::CommandGIBaseHandler::getDescription	(	const protocol::Command &	message,
		std::shared_ptr< irsol::server::ClientSession >	session
	)		const

private

Generates a description string for the command execution.

Parameters

message	The command message.
session	The client session.

Returns: Description string.

Definition at line 55 of file command_gi_base.cpp.

{
  std::stringstream ss;
  ss << session->id() << " - " << message.toString();
  return ss.str();
}

◆ getFrameRate()

virtual double irsol::server::handlers::internal::CommandGIBaseHandler::getFrameRate	(	const protocol::Command &	message,
		std::shared_ptr< irsol::server::ClientSession >	session
	)		const

privatepure virtual

Retrieves the frame rate to use to start the listening.

Parameters

message	The command message.
session	The client session.

Returns: Frame rate for acquisition.

Note: This method must be implemented by derived classes to provide specific frame rate logic.

See also: irsol::server::handlers::CommandGIHandler::getFrameRate; irsol::server::handlers::CommandGISHandler::getFrameRate

Implemented in irsol::server::handlers::CommandGIHandler, and irsol::server::handlers::CommandGISHandler.

◆ getInputSequenceLength()

virtual uint64_t irsol::server::handlers::internal::CommandGIBaseHandler::getInputSequenceLength	(	const protocol::Command &	message,
		std::shared_ptr< irsol::server::ClientSession >	session
	)		const

privatepure virtual

Retrieves the input sequence length to use to start the listening.

Parameters

message	The command message.
session	The client session.

Returns: Number of frames to acquire.

Note: This method must be implemented by derived classes to provide specific sequence length logic.

See also: irsol::server::handlers::CommandGIHandler::getInputSequenceLength; irsol::server::handlers::CommandGISHandler::getInputSequenceLength

Implemented in irsol::server::handlers::CommandGIHandler, and irsol::server::handlers::CommandGISHandler.

◆ process()

std::vector< out_message_t > irsol::server::handlers::internal::CommandGIBaseHandler::process	(	std::shared_ptr< irsol::server::ClientSession >	session,
		protocol::Command &&	message
	)

finaloverrideprotected

Processes a frame acquisition command, starting the frame collection thread.

Parameters

session	The client session.
message	The command message.

Returns: Vector of outbound messages (success or error).

Definition at line 24 of file command_gi_base.cpp.

{
 
  auto& collector = ctx->app.frameCollector();
  auto& state     = session->userData().frameListeningState;
 
  if(state.running()) {
    IRSOL_NAMED_LOG_WARN(session->id(), "Session already listening to frames. Ignoring request.");
    std::vector<out_message_t> result;
    result.emplace_back(protocol::Error::from(message, "Session is already listening to frames"));
    return result;
  }
 
  if(auto errors = validate(message, session); errors.size()) {
    return errors;
  }
 
  auto queue = collector.makeQueuePtr();
  startListeningThread(session, queue, std::move(message), getDescription(message, session));
 
  const uint64_t numFrames = getInputSequenceLength(message, session);
  const double   fps       = getFrameRate(message, session);
  collector.registerClient(session->id(), fps, queue, numFrames);
 
  IRSOL_NAMED_LOG_INFO(session->id(), "Client registered for {} frames at FPS {}", numFrames, fps);
  return {};
}

◆ startListeningThread()

void irsol::server::handlers::internal::CommandGIBaseHandler::startListeningThread	(	std::shared_ptr< irsol::server::ClientSession >	session,
		std::shared_ptr< irsol::server::frame_collector::FrameCollector::frame_queue_t >	queue,
		protocol::Command &&	command,
		const std::string &	description
	)

private

Starts the frame listening thread for the client session.

Parameters

session	The client session.
queue	The frame queue for collected frames.
command	The command message.
description	Description string for logging.

See also: irsol::server::internal::FrameListeningState::start

Definition at line 65 of file command_gi_base.cpp.

{
  auto& state = session->userData().frameListeningState;
 
  state.start(
    [session, queue, message = std::move(command)](
      std::shared_ptr<std::atomic<bool>> stopRequest) mutable {
      // Reset the state of the user-data related to frame-listening
      auto& state                         = session->userData().frameListeningState;
      state.gisParams.inputSequenceNumber = 0;
 
      IRSOL_NAMED_LOG_INFO(
        session->id(), "Started frame listening thread for {}", message.toString());
 
      std::unique_ptr<frame_collector::Frame> framePtr;
      bool                                    interrupted = false;
      while(!interrupted && (!queue->done() && queue->pop(framePtr))) {
        IRSOL_NAMED_LOG_DEBUG(
          session->id(),
          "Sending frame {} to client: {}",
          state.gisParams.inputSequenceNumber,
          framePtr->image.toString());
        {
          auto                                     lock = std::scoped_lock(session->socketMutex());
          std::vector<irsol::protocol::OutMessage> result;
          result.emplace_back(irsol::protocol::OutMessage(std::move(framePtr->image)));
          result.emplace_back(irsol::protocol::Success::asStatus(
            "isn", {static_cast<int>(state.gisParams.inputSequenceNumber)}));
          session->handleOutMessages(std::move(result));
        }
        ++state.gisParams.inputSequenceNumber;
        if(stopRequest->load()) {
          interrupted = true;
        }
      }
 
      if(interrupted) {
        IRSOL_NAMED_LOG_INFO(
          session->id(), "Stopping execution of frame-collection due to stop-request.");
        // TODO: on user-stop requests do we want to return a success?
        return;
      }
 
      {
        auto lock = std::scoped_lock(session->socketMutex());
        session->handleOutMessage(protocol::Success::from(message));
      }
      IRSOL_NAMED_LOG_INFO(session->id(), "{} frame sending complete", message.toString());
    },
    description);
}

◆ validate()

virtual std::vector< irsol::protocol::OutMessage > irsol::server::handlers::internal::CommandGIBaseHandler::validate	(	const protocol::Command &	message,
		std::shared_ptr< irsol::server::ClientSession >	session
	)		const

privatepure virtual

Validates parameters before starting listener thread.

Parameters

message	The command message.
session	The client session.

Returns: Vector of protocol::Error messages (empty if no error).

Note: This method must be implemented by derived classes to provide specific validation logic.

See also: irsol::server::handlers::CommandGIHandler::validate; irsol::server::handlers::CommandGISHandler::validate

Implemented in irsol::server::handlers::CommandGIHandler, and irsol::server::handlers::CommandGISHandler.

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

src/irsol/include/irsol/server/handlers/command_gi_base.hpp
src/irsol/lib/irsol/server/handlers/command_gi_base.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommandGIBaseHandler()

Member Function Documentation

◆ getDescription()

◆ getFrameRate()

◆ getInputSequenceLength()

◆ process()

◆ startListeningThread()

◆ validate()