irsol::server::handlers::CommandAbortHandler Class Reference

Handler for aborting ongoing operations for a client session. More...

#include <command_abort.hpp>

Inheritance diagram for irsol::server::handlers::CommandAbortHandler:

Public Member Functions
	CommandAbortHandler (std::shared_ptr< Context > ctx)
	Constructs the CommandAbortHandler.
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, irsol::protocol::Command &&message) final override
	Processes an abort command.
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 aborting ongoing operations for a client session.

Processes abort commands to stop frame collection gis.

Definition at line 22 of file command_abort.hpp.

Constructor & Destructor Documentation

CommandAbortHandler()

irsol::server::handlers::CommandAbortHandler::CommandAbortHandler

(

std::shared_ptr< Context >

ctx

)

Constructs the CommandAbortHandler.

Parameters

ctx	Handler context.

Definition at line 9 of file command_abort.cpp.

: CommandHandler(ctx) {}

Member Function Documentation

process()

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

finaloverrideprotected

Processes an abort command.

Parameters

session	The client session.
message	The abort command message.

Returns

Vector of outbound messages (success or error).

Definition at line 12 of file command_abort.cpp.

{
  auto& state = session->userData().frameListeningState;
  if(!state.running()) {
    IRSOL_NAMED_LOG_INFO(
      session->id(), "Session is not listening to frames. Ignoring abort request.");
    return {};
  }
 
  IRSOL_NAMED_LOG_INFO(session->id(), "Stopping request set to detached background thread..");
  state.stop();
  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/command_abort.hpp
• src/irsol/lib/irsol/server/handlers/command_abort.cpp