BasicProcessor Class Reference

base class of all the processors. More...

#include <processor.h>

Inheritance diagram for BasicProcessor:

Public Types
enum class	Result {   Again , RecvFromClient , SendToClient , RecvFromServer ,   RecvFromBoth , SendToServer , SendableToServer , Suspend ,   Done , Void }

Public Member Functions
	BasicProcessor (MysqlRoutingClassicConnectionBase *conn)
virtual	~BasicProcessor ()=default
const MysqlRoutingClassicConnectionBase *	connection () const
MysqlRoutingClassicConnectionBase *	connection ()
virtual stdx::expected< Result, std::error_code >	process ()=0
virtual std::string	diagnostic_name () const
	best-effort human-readable processor type. More...
virtual std::optional< std::string_view >	diagnostic_stage_name () const
	stage name of a staged processor. More...

Private Attributes
MysqlRoutingClassicConnectionBase *	conn_

Detailed Description

base class of all the processors.

Processor

• have their own internal state
• expose a process() function which will be called until it returns Result::Done

Processors are stacked.

The methods:

• push_processor()
• pop_processor()

allow to add and remove elements for the stack.

The top-most processor's process() function is called.

Member Enumeration Documentation

Result

enum class BasicProcessor::Result

strong

Enumerator
Again
RecvFromClient
SendToClient
RecvFromServer
RecvFromBoth
SendToServer
SendableToServer
Suspend
Done
Void

Constructor & Destructor Documentation

BasicProcessor()

BasicProcessor::BasicProcessor ( MysqlRoutingClassicConnectionBase *  conn )

inline

~BasicProcessor()

virtual BasicProcessor::~BasicProcessor ( )

virtualdefault

Member Function Documentation

connection() [1/2]

MysqlRoutingClassicConnectionBase * BasicProcessor::connection ( )

inline

connection() [2/2]

const MysqlRoutingClassicConnectionBase * BasicProcessor::connection ( ) const

inline

diagnostic_name()

std::string BasicProcessor::diagnostic_name ( ) const

virtual

best-effort human-readable processor type.

diagnostic_stage_name()

virtual std::optional< std::string_view > BasicProcessor::diagnostic_stage_name ( ) const

inlinevirtual

stage name of a staged processor.

Returns

stage name or std::nullopt if processor has no explicit stages.

Reimplemented in AwaitClientOrServerProcessor, ClientToServerForwarder, ServerToClientForwarder, AuthCachingSha2Forwarder, AuthCleartextForwarder, AuthGenericForwarder, AuthForwarder, AuthNativeForwarder, AuthSha256Forwarder, BinlogDumpForwarder, ChangeUserForwarder, CloneForwarder, DebugForwarder, InitSchemaForwarder, KillForwarder, ListFieldsForwarder, PingForwarder, QueryForwarder, QuitForwarder, RegisterReplicaForwarder, ReloadForwarder, ResetConnectionForwarder, SetOptionForwarder, StatisticsForwarder, StmtCloseForwarder, StmtExecuteForwarder, StmtFetchForwarder, StmtParamAppendDataForwarder, StmtPrepareForwarder, StmtResetForwarder, AuthCachingSha2Sender, AuthCleartextSender, AuthNativeSender, AuthSha256Sender, ChangeUserSender, InitSchemaSender, QuerySender, QuitSender, ResetConnectionSender, SetOptionSender, CommandProcessor, ConnectProcessor, FlowProcessor, SendProcessor< toServer >, ServerGreetor, ServerFirstConnector, ServerFirstAuthenticator, ClientGreetor, and LazyConnector.

process()

virtual stdx::expected< Result, std::error_code > BasicProcessor::process ( )

pure virtual

Implemented in AwaitClientOrServerProcessor, ClientToServerForwarder, ServerToClientForwarder, AuthCachingSha2Forwarder, AuthCleartextForwarder, AuthGenericForwarder, AuthForwarder, AuthNativeForwarder, AuthOpenidConnectForwarder, AuthSha256Forwarder, BinlogDumpForwarder, ChangeUserForwarder, CloneForwarder, DebugForwarder, InitSchemaForwarder, KillForwarder, ListFieldsForwarder, PingForwarder, QueryForwarder, QuitForwarder, RegisterReplicaForwarder, ReloadForwarder, ResetConnectionForwarder, SetOptionForwarder, StatisticsForwarder, StmtCloseForwarder, StmtExecuteForwarder, StmtFetchForwarder, StmtParamAppendDataForwarder, StmtPrepareForwarder, StmtResetForwarder, AuthCachingSha2Sender, AuthCleartextSender, AuthNativeSender, AuthOpenidConnectSender, AuthSha256Sender, ChangeUserSender, InitSchemaSender, QuerySender, QuitSender, ResetConnectionSender, SetOptionSender, CommandProcessor, ConnectProcessor, FlowProcessor, SendProcessor< toServer >, ServerGreetor, ServerFirstConnector, ServerFirstAuthenticator, ClientGreetor, and LazyConnector.

Member Data Documentation

conn_

MysqlRoutingClassicConnectionBase* BasicProcessor::conn_

private

---

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

• router/src/routing/src/processors/base/processor.h
• router/src/routing/src/processors/base/processor.cc