Class ReplicationServerGroup

Base class used to implement load balancing features.

Inheritance

System.Object

ReplicationServerGroup

ReplicationRoundRobinServerGroup

Namespace: MySql.Data.MySqlClient.Replication

Assembly: MySql.Data.dll

Version: 9.2.0

Syntax

public abstract class ReplicationServerGroup

Constructors

ReplicationServerGroup(String, Int32)

Declaration

public ReplicationServerGroup(string name, int retryTime)

Parameters

Type	Name	Description
System.String	name	The group name.
System.Int32	retryTime	The number of seconds to perform a retry.

Fields

servers

List of servers available for replication.

Declaration

protected List<ReplicationServer> servers

Field Value

Type	Description
System.Collections.Generic.List<ReplicationServer>

Properties

Name

Gets the group name.

Declaration

public string Name { get; protected set; }

Property Value

Type	Description
System.String

RetryTime

Gets the retry time between connections to failed servers.

Declaration

public int RetryTime { get; protected set; }

Property Value

Type	Description
System.Int32

Servers

Gets the server list in the group.

Declaration

protected IList<ReplicationServer> Servers { get; }

Property Value

Type	Description
System.Collections.Generic.IList<ReplicationServer>

Methods

AddServer(String, Boolean, String)

Adds a server into the group.

Declaration

protected ReplicationServer AddServer(string name, bool isSource, string connectionString)

Parameters

Type	Name	Description
System.String	name	The server name.
System.Boolean	isSource	A flag indicating if the server to add is source or replica.
System.String	connectionString	The connection string used by this server.

Returns

Type	Description
ReplicationServer	A ReplicationServer object representing the recently added object.

GetServer(Boolean)

Must be implemented. Defines the next server for a custom load balancing implementation.

Declaration

protected abstract ReplicationServer GetServer(bool isSource)

Parameters

Type	Name	Description
System.Boolean	isSource	Defines if the server to return is a source or any.

Returns

Type	Description
ReplicationServer	The next server based on the load balancing implementation. Null if no available server is found.

GetServer(Boolean, MySqlConnectionStringBuilder)

Defines the next server for a custom load balancing implementation.

Declaration

protected virtual ReplicationServer GetServer(bool isSource, MySqlConnectionStringBuilder settings)

Parameters

Type	Name	Description
System.Boolean	isSource	Defines if the server to return is a source or any.
MySqlConnectionStringBuilder	settings	Currently not being used.

Returns

Type	Description
ReplicationServer	The next server based on the load balancing implementation. Null if no available server is found.

GetServer(String)

Gets a server by name.

Declaration

protected ReplicationServer GetServer(string name)

Parameters

Type	Name	Description
System.String	name	The server name.

Returns

Type	Description
ReplicationServer	The replication server.

HandleFailover(ReplicationServer)

Handles a failed connection to a server.

Declaration

protected virtual void HandleFailover(ReplicationServer server)

Parameters

Type	Name	Description
ReplicationServer	server	The failed server.

Remarks

This method can be overrided to implement a custom failover handling.

HandleFailover(ReplicationServer, Exception)

Handles a failed connection to a server.

Declaration

protected virtual void HandleFailover(ReplicationServer server, Exception exception)

Parameters

Type	Name	Description
ReplicationServer	server	The failed server.
System.Exception	exception	The exception that caused the failover.

RemoveServer(String)

Removes a server from the group.

Declaration

protected void RemoveServer(string name)

Parameters

Type	Name	Description
System.String	name	The server name.