synchub

Documentation

Index

• Variables
• type Event
• type Sync
• type SyncHub
  • func NewSyncHub(opts ...SyncHubOption) *SyncHub
  • func (sh *SyncHub) Ack(syncID interface{}, ack interface{}) bool
  • func (sh *SyncHub) Add(syncID interface{}, opts ...SyncOption) Sync
  • func (sh *SyncHub) Cancel(syncID interface{}, notify bool) bool
  • func (sh *SyncHub) Close()
  • func (sh *SyncHub) Done(syncID interface{}) bool
  • func (sh *SyncHub) DoneSub(syncID interface{}, subSyncID interface{}) bool
  • func (sh *SyncHub) Error(syncID interface{}, err error) bool
  • func (sh *SyncHub) New(syncID interface{}, opts ...SyncOption) Sync
• type SyncHubOption
  • func OptionTimer(tmr timer.Timer) SyncHubOption
• type SyncOption
  • func WithCallback(cb func(*Event)) SyncOption
  • func WithContext(ctx context.Context) SyncOption
  • func WithData(data interface{}) SyncOption
  • func WithEventChan(ch chan *Event) SyncOption
  • func WithSub(subSyncIDs ...interface{}) SyncOption
  • func WithTimeout(d time.Duration) SyncOption

Variables

var (
	ErrSyncTimeout        = errors.New("timeout")
	ErrSyncHubForceClosed = errors.New("force closed")
	ErrSyncHubClosed      = errors.New("synchub closed")
	ErrSyncCanceled       = errors.New("sync canceled")
	ErrSyncIDResynced     = errors.New("id resynced")
	ErrTimerNotWorking    = errors.New("timer not working")
)

Types

type Event

type Event struct {
	SyncID    interface{}
	Data, Ack interface{}
	Error     error
}

type Sync

type Sync interface {
	C() <-chan *Event
	Cancel(notify bool) bool
	Done() bool
	DoneSub(subSyncID interface{}) bool
	Ack(ack interface{}) bool
	Error(err error) bool
}

A Sync presents the handler of a synchronize.

type SyncHub

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

func NewSyncHub

func NewSyncHub(opts ...SyncHubOption) *SyncHub

func (*SyncHub) Ack

func (sh *SyncHub) Ack(syncID interface{}, ack interface{}) bool

func (*SyncHub) Add

func (sh *SyncHub) Add(syncID interface{}, opts ...SyncOption) Sync

func (*SyncHub) Cancel

func (sh *SyncHub) Cancel(syncID interface{}, notify bool) bool

func (*SyncHub) Close

func (sh *SyncHub) Close()

func (*SyncHub) Done

func (sh *SyncHub) Done(syncID interface{}) bool

Done finish the Sync, false means no such syncID

func (*SyncHub) DoneSub

func (sh *SyncHub) DoneSub(syncID interface{}, subSyncID interface{}) bool

DoneSubSyncID finish the partial Sync if other subSyncID exists or else to finish the complete Sync return false means syncID or subSyncID not found

func (*SyncHub) Error

func (sh *SyncHub) Error(syncID interface{}, err error) bool

func (*SyncHub) New

func (sh *SyncHub) New(syncID interface{}, opts ...SyncOption) Sync

deprecated

type SyncHubOption

type SyncHubOption func(*SyncHub)

func OptionTimer

func OptionTimer(tmr timer.Timer) SyncHubOption

type SyncOption

type SyncOption func(*synchronize)

Options for Sync

func WithCallback

func WithCallback(cb func(*Event)) SyncOption

Callback if perfered than channel

func WithContext

func WithContext(ctx context.Context) SyncOption

bad design, but still I want keep the capability

func WithData

func WithData(data interface{}) SyncOption

func WithEventChan

func WithEventChan(ch chan *Event) SyncOption

func WithSub

func WithSub(subSyncIDs ...interface{}) SyncOption

func WithTimeout

func WithTimeout(d time.Duration) SyncOption