storage

Documentation

Index

• type Client
  • func NewClient(user gregor.UID, device gregor.DeviceID, createSm func() gregor.StateMachine, ...) *Client
  • func (c *Client) ConsumeMessage(ctx context.Context, m gregor.Message) error
  • func (c *Client) InBandMessagesFromState(s gregor.State) ([]gregor.InBandMessage, error)
  • func (c *Client) Restore(ctx context.Context) error
  • func (c *Client) Save(ctx context.Context) error
  • func (c *Client) State(ctx context.Context, cli gregor1.IncomingInterface) (res gregor.State, err error)
  • func (c *Client) StateMachineConsumeLocalDismissal(ctx context.Context, id gregor.MsgID) error
  • func (c *Client) StateMachineConsumeMessage(ctx context.Context, m gregor1.Message) error
  • func (c *Client) StateMachineInBandMessagesSince(ctx context.Context, t time.Time, filterLocalDismissals bool) ([]gregor.InBandMessage, error)
  • func (c *Client) StateMachineLatestCTime(ctx context.Context) *time.Time
  • func (c *Client) StateMachineState(ctx context.Context, t gregor.TimeOrOffset, applyLocalState bool) (gregor.State, error)
  • func (c *Client) Stop()
  • func (c *Client) Sync(ctx context.Context, cli gregor1.IncomingInterface, ...) (res []gregor.InBandMessage, err error)
  • func (c *Client) SyncFromTime(ctx context.Context, cli gregor1.IncomingInterface, t *time.Time, ...) (msgs []gregor.InBandMessage, err error)
• type ErrHashMismatch
  • func (e ErrHashMismatch) Error() string
• type LocalStorageEngine
• type TestingEvents
  • func NewTestingEvents() *TestingEvents

Types

type Client

type Client struct {
	User    gregor.UID
	Device  gregor.DeviceID
	Sm      gregor.StateMachine
	Storage LocalStorageEngine
	Log     logger.Logger
	Clock   clockwork.Clock

	// testing events
	TestingEvents *TestingEvents
	// contains filtered or unexported fields
}

func NewClient

func NewClient(user gregor.UID, device gregor.DeviceID, createSm func() gregor.StateMachine,
	storage LocalStorageEngine, incomingClient func() gregor1.IncomingInterface, log logger.Logger) *Client

func (*Client) ConsumeMessage

func (c *Client) ConsumeMessage(ctx context.Context, m gregor.Message) error

func (*Client) InBandMessagesFromState

func (c *Client) InBandMessagesFromState(s gregor.State) ([]gregor.InBandMessage, error)

func (*Client) Restore

func (c *Client) Restore(ctx context.Context) error

func (*Client) Save

func (c *Client) Save(ctx context.Context) error

func (*Client) State

func (c *Client) State(ctx context.Context, cli gregor1.IncomingInterface) (res gregor.State, err error)

func (*Client) StateMachineConsumeLocalDismissal

func (c *Client) StateMachineConsumeLocalDismissal(ctx context.Context, id gregor.MsgID) error

func (*Client) StateMachineConsumeMessage

func (c *Client) StateMachineConsumeMessage(ctx context.Context, m gregor1.Message) error

func (*Client) StateMachineInBandMessagesSince

func (c *Client) StateMachineInBandMessagesSince(ctx context.Context, t time.Time, filterLocalDismissals bool) ([]gregor.InBandMessage, error)

func (*Client) StateMachineLatestCTime

func (c *Client) StateMachineLatestCTime(ctx context.Context) *time.Time

func (*Client) StateMachineState

func (c *Client) StateMachineState(ctx context.Context, t gregor.TimeOrOffset,
	applyLocalState bool) (gregor.State, error)

func (*Client) Stop

func (c *Client) Stop()

func (*Client) Sync

func (c *Client) Sync(ctx context.Context, cli gregor1.IncomingInterface,
	syncRes *chat1.SyncAllNotificationRes) (res []gregor.InBandMessage, err error)

func (*Client) SyncFromTime

func (c *Client) SyncFromTime(ctx context.Context, cli gregor1.IncomingInterface, t *time.Time,
	syncResult *gregor1.SyncResult) (msgs []gregor.InBandMessage, err error)

type ErrHashMismatch

type ErrHashMismatch struct{}

func (ErrHashMismatch) Error

func (e ErrHashMismatch) Error() string

type LocalStorageEngine

type LocalStorageEngine interface {
	Store(uid gregor.UID, state []byte, outbox [][]byte, localdismissals [][]byte) error
	Load(uid gregor.UID) (state []byte, outbox [][]byte, localdismissals [][]byte, err error)
}

type TestingEvents

type TestingEvents struct {
	OutboxSend chan gregor1.Message
}

func NewTestingEvents

func NewTestingEvents() *TestingEvents