ChangeUserForwarder Class Reference

forwards COM_CHANGE_USER from client to the server. More...

#include <classic_change_user_forwarder.h>

Inheritance diagram for ChangeUserForwarder:

Public Types
enum class	Stage {   Command , Connect , Connected , Response ,   FetchUserAttrs , FetchUserAttrsDone , SendAuthOk , Ok ,   Error , Done }
Public Types inherited from BasicProcessor
enum class	Result {   Again , RecvFromClient , SendToClient , RecvFromServer ,   RecvFromBoth , SendToServer , SendableToServer , Suspend ,   Done , Void }

Public Member Functions
stdx::expected< Result, std::error_code >	process () override
	forward the change-user message flow. More...
void	stage (Stage stage)
Stage	stage () const
Public Member Functions inherited from Processor
	BasicProcessor (MysqlRoutingClassicConnectionBase *conn)
Public Member Functions inherited from BasicProcessor
	BasicProcessor (MysqlRoutingClassicConnectionBase *conn)
virtual	~BasicProcessor ()=default
const MysqlRoutingClassicConnectionBase *	connection () const
MysqlRoutingClassicConnectionBase *	connection ()

Private Member Functions
stdx::expected< Result, std::error_code >	command ()
stdx::expected< Result, std::error_code >	connect ()
stdx::expected< Result, std::error_code >	connected ()
stdx::expected< Result, std::error_code >	fetch_user_attrs ()
stdx::expected< Result, std::error_code >	fetch_user_attrs_done ()
stdx::expected< Result, std::error_code >	send_auth_ok ()
stdx::expected< Result, std::error_code >	response ()
stdx::expected< Result, std::error_code >	ok ()
stdx::expected< Result, std::error_code >	error ()

Private Attributes
RouterRequireFetcher::Result	required_connection_attributes_fetcher_result_
Stage	stage_ {Stage::Command}
TraceEvent *	trace_event_command_ {}
TraceEvent *	trace_event_connect_and_forward_command_ {}
TraceEvent *	trace_event_forward_command_ {}

Additional Inherited Members
Static Public Attributes inherited from ForwardingProcessor
static constexpr const std::chrono::milliseconds	kConnectRetryInterval
	interval between connect-retries. More...
Protected Member Functions inherited from ForwardingProcessor
stdx::expected< Result, std::error_code >	forward_server_to_client (bool noflush=false)
	forward the current packet from the server-side to the client-side. More...
stdx::expected< Result, std::error_code >	forward_client_to_server (bool noflush=false)
	forward the current packet from the client-side to the server-side. More...
stdx::expected< Processor::Result, std::error_code >	skip_or_inject_end_of_columns (bool no_flush=false)
	adjust the end-of-columns packet. More...
stdx::expected< bool, std::error_code >	pool_server_connection ()
	move the server connection to the pool. More...
stdx::expected< Processor::Result, std::error_code >	socket_reconnect_start (TraceEvent *parent_event)
	reconnect a socket. More...
stdx::expected< Processor::Result, std::error_code >	mysql_reconnect_start (TraceEvent *parent_event)
	reconnect a mysql classic connection. More...
stdx::expected< Result, std::error_code >	recv_server_failed_and_check_client_socket (std::error_code ec)
	handle error-code of a failed receive() from the server-socket and check the status of the client socket. More...
stdx::expected< Processor::Result, std::error_code >	reconnect_send_error_msg (Channel &src_channel, ClassicProtocolState &src_protocol)
	send a Error msg based on the reconnect_error(). More...
template<class Proto >
stdx::expected< Processor::Result, std::error_code >	reconnect_send_error_msg (TlsSwitchableConnection< Proto > &conn)
void	reconnect_error (classic_protocol::message::server::Error err)
	set the reconnect error. More...
classic_protocol::message::server::Error	reconnect_error () const
	get the reconnect error. More...
Protected Member Functions inherited from Processor
stdx::expected< Result, std::error_code >	send_server_failed (std::error_code ec)
stdx::expected< Result, std::error_code >	recv_server_failed (std::error_code ec)
stdx::expected< Result, std::error_code >	send_client_failed (std::error_code ec)
stdx::expected< Result, std::error_code >	recv_client_failed (std::error_code ec)
stdx::expected< Result, std::error_code >	server_socket_failed (std::error_code ec)
stdx::expected< Result, std::error_code >	client_socket_failed (std::error_code ec)
stdx::expected< void, std::error_code >	discard_current_msg (Channel &src_channel, ClassicProtocolState &src_protocol)
	discard to current message. More...
template<class Proto >
stdx::expected< void, std::error_code >	discard_current_msg (TlsSwitchableConnection< Proto > &conn)
void	trace (Tracer::Event e)
Tracer &	tracer ()
TraceEvent *	trace_span (TraceEvent *parent_span, const std::string_view &prefix)
	start a span. More...
void	trace_span_end (TraceEvent *event, TraceEvent::StatusCode status_code=TraceEvent::StatusCode::kUnset)
	end a span and set a status-code. More...
TraceEvent *	trace_command (const std::string_view &prefix)
	start a command span. More...
TraceEvent *	trace_connect_and_forward_command (TraceEvent *parent_span)
	start a connect-and-forward span. More...
TraceEvent *	trace_connect (TraceEvent *parent_span)
	start a connect span. More...
void	trace_set_connection_attributes (TraceEvent *ev)
	start a connect span. More...
TraceEvent *	trace_forward_command (TraceEvent *parent_span)
	start a forward span. More...
void	trace_command_end (TraceEvent *event, TraceEvent::StatusCode status_code=TraceEvent::StatusCode::kUnset)
	end a command span and set a status-code. More...
Static Protected Member Functions inherited from ForwardingProcessor
template<class T >
static bool	message_can_be_forwarded_as_is (ClassicProtocolState &src_protocol, ClassicProtocolState &dst_protocol, const T &msg)
	check of the capabilities of the source and the destination are the same for this message. More...
static bool	connect_error_is_transient (const classic_protocol::message::server::Error &err)
	check if the error is a transient error. More...
Static Protected Member Functions inherited from Processor
static void	log_fatal_error_code (const char *msg, std::error_code ec)
	log a message with error-code as error. More...

Detailed Description

forwards COM_CHANGE_USER from client to the server.

Member Enumeration Documentation

Stage

enum class ChangeUserForwarder::Stage

strong

Enumerator
Command
Connect
Connected
Response
FetchUserAttrs
FetchUserAttrsDone
SendAuthOk
Ok
Error
Done

Member Function Documentation

command()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::command ( )

private

connect()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::connect ( )

private

connected()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::connected ( )

private

error()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::error ( )

private

fetch_user_attrs()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::fetch_user_attrs ( )

private

fetch_user_attrs_done()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::fetch_user_attrs_done ( )

private

ok()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::ok ( )

private

process()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::process ( )

overridevirtual

forward the change-user message flow.

Expected overall flow:

c->s: COM_CHANGE_USER
alt fast-path
alt
c<-s: Error
else
c<-s: Ok
end
else auth-method-switch
c<-s: auth-method-switch
c->s: auth-method-data
loop more data
c<-s: auth-method-data
opt
c->s: auth-method-data
end
end
alt
c<-s: Error
else
c<-s: Ok
end
end

If there is no server connection, it is created on demand.

Implements BasicProcessor.

response()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::response ( )

private

send_auth_ok()

stdx::expected< Processor::Result, std::error_code > ChangeUserForwarder::send_auth_ok ( )

private

stage() [1/2]

Stage ChangeUserForwarder::stage ( ) const

inline

stage() [2/2]

void ChangeUserForwarder::stage ( Stage  stage )

inline

Member Data Documentation

required_connection_attributes_fetcher_result_

RouterRequireFetcher::Result ChangeUserForwarder::required_connection_attributes_fetcher_result_

private

stage_

Stage ChangeUserForwarder::stage_ {Stage::Command}

private

trace_event_command_

TraceEvent* ChangeUserForwarder::trace_event_command_ {}

private

trace_event_connect_and_forward_command_

TraceEvent* ChangeUserForwarder::trace_event_connect_and_forward_command_ {}

private

trace_event_forward_command_

TraceEvent* ChangeUserForwarder::trace_event_forward_command_ {}

private

---

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

• router/src/routing/src/classic_change_user_forwarder.h
• router/src/routing/src/classic_change_user_forwarder.cc