mysqlctlclient

Documentation

Overview

Package mysqlctlclient contains the generic client side of the remote mysqlctl protocol.

Index

• func RegisterMysqlctlClientFactory(name string, factory MysqlctlClientFactory)
• type MysqlctlClient
  • func New(network, addr string, dialTimeout time.Duration) (MysqlctlClient, error)
• type MysqlctlClientFactory

Functions

func RegisterMysqlctlClientFactory

func RegisterMysqlctlClientFactory(name string, factory MysqlctlClientFactory)

RegisterMysqlctlClientFactory allows a client implementation to register itself

Types

type MysqlctlClient

type MysqlctlClient interface {
	// Start calls Mysqld.Start remotely.
	Start(mysqlWaitTime time.Duration) error
	// Shutdown calls Mysqld.Shutdown remotely.
	Shutdown(waitForMysqld bool, mysqlWaitTime time.Duration) error

	// Close will terminate the connection. This object won't be used anymore.
	Close()
}

MysqlctlClient defines the interface used to send remote mysqlctl commands

func New

func New(network, addr string, dialTimeout time.Duration) (MysqlctlClient, error)

New creates a client implementation as specified by a flag.

type MysqlctlClientFactory

type MysqlctlClientFactory func(network, addr string, dialTimeout time.Duration) (MysqlctlClient, error)

MysqlctlClientFactory functions are registered by client implementations.