syncclient

Documentation

Index

• type Options
• type SyncerClient
  • func New(discoverer *discovery.Discoverer, myVersion, myHostname, myInfo string, ...) *SyncerClient
  • func (s *SyncerClient) Start(cxt context.Context) error
  • func (s *SyncerClient) SupportsNodeResourceUpdates(timeout time.Duration) (bool, error)

Types

type Options

type Options struct {
	ReadTimeout    time.Duration
	ReadBufferSize int
	WriteTimeout   time.Duration
	KeyFile        string
	CertFile       string
	CAFile         string
	ServerCN       string
	ServerURISAN   string
	SyncerType     syncproto.SyncerType

	// DisableDecoderRestart disables decoder restart and the features that depend on
	// it (such as compression).  Useful for simulating an older client in UT.
	DisableDecoderRestart bool

	// DebugLogReads tells the client to wrap each connection with a Reader that
	// logs every read.  Intended only for use in tests!
	DebugLogReads bool
	// DebugDiscardKVUpdates discards all KV updates from typha without decoding them.
	// Useful for load testing Typha without having to run a "full" client.
	DebugDiscardKVUpdates bool

	// FIPSModeEnabled Enables FIPS 140-2 verified crypto mode.
	FIPSModeEnabled bool
}

type SyncerClient

type SyncerClient struct {
	ID uint64

	Finished sync.WaitGroup
	// contains filtered or unexported fields
}

func New

func New(
	discoverer *discovery.Discoverer,
	myVersion, myHostname, myInfo string,
	cbs api.SyncerCallbacks,
	options *Options,
) *SyncerClient

func (*SyncerClient) Start

func (s *SyncerClient) Start(cxt context.Context) error

func (*SyncerClient) SupportsNodeResourceUpdates

func (s *SyncerClient) SupportsNodeResourceUpdates(timeout time.Duration) (bool, error)

SupportsNodeResourceUpdates waits for the Typha server to send a hello and returns true if the server supports node resource updates. If the given timeout is reached, an error is returned.