client

Documentation

Index

• Constants
• type EleCli
  • func NewClient(host, path string, timeout uint) *EleCli
  • func (ec *EleCli) Abdicate() (bool, error)
  • func (ec *EleCli) Close()
  • func (ec *EleCli) Connect() error
  • func (ec *EleCli) Promote() (bool, error)
  • func (ec *EleCli) Role() (Role, error)
• type Role
  • func (r Role) String() string

Constants

const (
	// RoleCandidate represents a candidate
	RoleCandidate = Role(0)

	// RoleFollower represents a follower
	RoleFollower = Role(1)

	// RoleLeader represents a leader
	RoleLeader = Role(2)
)

Types

type EleCli

type EleCli struct {
	// contains filtered or unexported fields
}

EleCli is the client of the elector

func NewClient

func NewClient(host, path string, timeout uint) *EleCli

NewClient returns a elector client

func (*EleCli) Abdicate

func (ec *EleCli) Abdicate() (bool, error)

Abdicate the leadership

func (*EleCli) Close

func (ec *EleCli) Close()

Close the connection with the server

func (*EleCli) Connect

func (ec *EleCli) Connect() error

Connect the elector user request server We prefer to use unix domain socket to decrease the TIME_WAIT hanging socket when using TCP

func (*EleCli) Promote

func (ec *EleCli) Promote() (bool, error)

Promote to leader

func (*EleCli) Role

func (ec *EleCli) Role() (Role, error)

Role return the current elector's role

type Role

type Role uint

Role represents the role of the elector

func (Role) String

func (r Role) String() string