irsol::server::handlers::internal::HandlerBase< T, > Class Template Reference

Generic handler base class for protocol messages. More...

#include <base.hpp>

Inheritance diagram for irsol::server::handlers::internal::HandlerBase< T, >:

Public Member Functions
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
	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.

Protected Attributes
std::shared_ptr< Context >	ctx
	Handler context (provides access to app and utilities).

Detailed Description

template<typename T, std::enable_if_t< irsol::traits::is_type_in_variant< T, irsol::protocol::InMessage >::value, int > = 0>
class irsol::server::handlers::internal::HandlerBase< T, >

Generic handler base class for protocol messages.

Template Parameters

T	Protocol message type (Assignment, Inquiry, Command).

Provides the interface for processing protocol messages for a given client session.

Definition at line 38 of file base.hpp.

Constructor & Destructor Documentation

HandlerBase()

template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant< T, irsol::protocol::InMessage >::value, int > = 0>

irsol::server::handlers::internal::HandlerBase< T, >::HandlerBase ( std::shared_ptr< Context >  ctx )

inlineprotected

Constructs the handler base.

Parameters

ctx	Handler context.

Definition at line 68 of file base.hpp.

: ctx(ctx){};

Member Function Documentation

operator()()

template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant< T, irsol::protocol::InMessage >::value, int > = 0>

virtual std::vector< out_message_t > irsol::server::handlers::internal::HandlerBase< T, >::operator() ( const irsol::types::client_id_t &  clientId, T &&  message  )

inlinevirtual

Invokes the handler for a given client and message.

Parameters

clientId	The client identifier.
message	The protocol message.

Returns

Vector of outbound messages (success or error).

Note

This method is invoked by the irsol::server::handlers::MessageHandler::handle method.

Definition at line 50 of file base.hpp.

  {
    // Retrieve the current session using the client ID
    auto session = ctx->getSession(clientId);
    if(!session) {
      IRSOL_LOG_ERROR("No session found for client {}", clientId);
      return {};
    }
    return process(session, std::move(message));
  }

process()

template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant< T, irsol::protocol::InMessage >::value, int > = 0>

virtual std::vector< out_message_t > irsol::server::handlers::internal::HandlerBase< T, >::process ( std::shared_ptr< irsol::server::ClientSession >  session, T &&  message  )

protectedpure virtual

Processes the protocol message for the given session.

Parameters

session	The client session.
message	The protocol message.

Returns

Vector of outbound messages (success or error).

Implemented in irsol::server::handlers::LambdaHandler< T, >.

Member Data Documentation

ctx

template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant< T, irsol::protocol::InMessage >::value, int > = 0>

std::shared_ptr<Context> irsol::server::handlers::internal::HandlerBase< T, >::ctx

protected

Handler context (provides access to app and utilities).

Definition at line 81 of file base.hpp.

---

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

• src/irsol/include/irsol/server/handlers/base.hpp