memory

Documentation

Overview

Package memory provides the memory implementation of the sync package.

Index

• type Coordinator
  • func NewCoordinator(serverInfo *sync.ServerInfo) *Coordinator
  • func (c *Coordinator) Close() error
  • func (c *Coordinator) Members() map[string]*sync.ServerInfo
  • func (c *Coordinator) NewLocker(ctx context.Context, key sync.Key) (sync.Locker, error)
  • func (c *Coordinator) Publish(ctx context.Context, publisherID *time.ActorID, event sync.DocEvent)
  • func (c *Coordinator) PublishToLocal(ctx context.Context, publisherID *time.ActorID, event sync.DocEvent)
  • func (c *Coordinator) Subscribe(ctx context.Context, subscriber types.Client, documentID types.ID) (*sync.Subscription, []types.Client, error)
  • func (c *Coordinator) Unsubscribe(ctx context.Context, documentID types.ID, sub *sync.Subscription) error
  • func (c *Coordinator) UpdatePresence(_ context.Context, publisher *types.Client, documentID types.ID) error
• type PubSub
  • func NewPubSub() *PubSub
  • func (m *PubSub) GetPeers(documentID types.ID) []types.Client
  • func (m *PubSub) Publish(ctx context.Context, publisherID *time.ActorID, event sync.DocEvent)
  • func (m *PubSub) Subscribe(ctx context.Context, subscriber types.Client, documentID types.ID) (*sync.Subscription, error)
  • func (m *PubSub) Unsubscribe(ctx context.Context, documentID types.ID, sub *sync.Subscription)
  • func (m *PubSub) UpdatePresence(publisher *types.Client, documentID types.ID) *sync.Subscription

Types

type Coordinator

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

Coordinator is a memory-based implementation of sync.Coordinator.

func NewCoordinator

func NewCoordinator(serverInfo *sync.ServerInfo) *Coordinator

NewCoordinator creates an instance of Coordinator.

func (*Coordinator) Close

func (c *Coordinator) Close() error

Close closes all resources of this Coordinator.

func (*Coordinator) Members

func (c *Coordinator) Members() map[string]*sync.ServerInfo

Members returns the members of this cluster.

func (*Coordinator) NewLocker

func (c *Coordinator) NewLocker(
	ctx context.Context,
	key sync.Key,
) (sync.Locker, error)

NewLocker creates locker of the given key.

func (*Coordinator) Publish

func (c *Coordinator) Publish(
	ctx context.Context,
	publisherID *time.ActorID,
	event sync.DocEvent,
)

Publish publishes the given event.

func (*Coordinator) PublishToLocal

func (c *Coordinator) PublishToLocal(
	ctx context.Context,
	publisherID *time.ActorID,
	event sync.DocEvent,
)

PublishToLocal publishes the given event.

func (*Coordinator) Subscribe

func (c *Coordinator) Subscribe(
	ctx context.Context,
	subscriber types.Client,
	documentID types.ID,
) (*sync.Subscription, []types.Client, error)

Subscribe subscribes to the given documents.

func (*Coordinator) Unsubscribe

func (c *Coordinator) Unsubscribe(
	ctx context.Context,
	documentID types.ID,
	sub *sync.Subscription,
) error

Unsubscribe unsubscribes the given documents.

func (*Coordinator) UpdatePresence

func (c *Coordinator) UpdatePresence(
	_ context.Context,
	publisher *types.Client,
	documentID types.ID,
) error

UpdatePresence updates the presence of the given client.

type PubSub

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

PubSub is the memory implementation of PubSub, used for single server.

func NewPubSub

func NewPubSub() *PubSub

NewPubSub creates an instance of PubSub.

func (*PubSub) GetPeers

func (m *PubSub) GetPeers(documentID types.ID) []types.Client

GetPeers returns the peers of the given document.

func (*PubSub) Publish

func (m *PubSub) Publish(
	ctx context.Context,
	publisherID *time.ActorID,
	event sync.DocEvent,
)

Publish publishes the given event.

func (*PubSub) Subscribe

func (m *PubSub) Subscribe(
	ctx context.Context,
	subscriber types.Client,
	documentID types.ID,
) (*sync.Subscription, error)

Subscribe subscribes to the given document keys.

func (*PubSub) Unsubscribe

func (m *PubSub) Unsubscribe(
	ctx context.Context,
	documentID types.ID,
	sub *sync.Subscription,
)

Unsubscribe unsubscribes the given docKeys.

func (*PubSub) UpdatePresence

func (m *PubSub) UpdatePresence(
	publisher *types.Client,
	documentID types.ID,
) *sync.Subscription

UpdatePresence updates the presence of the given client.