syncacl

Documentation

Index

• Constants
• Variables
• func NewRequest(peerId, objectId, spaceId, head string, root *consensusproto.RawRecordWithId) *objectmessages.Request
• type InnerHeadUpdate
  • func (h InnerHeadUpdate) Heads() []string
  • func (h InnerHeadUpdate) Marshall(data objectmessages.ObjectMeta) ([]byte, error)
  • func (h InnerHeadUpdate) MsgSize() uint64
• type InnerRequest
  • func (r *InnerRequest) Marshall() ([]byte, error)
  • func (r *InnerRequest) MsgSize() uint64
• type RequestFactory
  • func NewRequestFactory(spaceId string) RequestFactory
• type Response
  • func (r *Response) MsgSize() uint64
  • func (r *Response) ProtoMessage() (proto.Message, error)
  • func (r *Response) SetProtoMessage(message proto.Message) error
• type SyncAcl
  • func New() SyncAcl
• type SyncClient
  • func NewSyncClient(spaceId string, syncService sync.SyncService) SyncClient

Constants

const CName = "common.acl.syncacl"

Variables

var (
	ErrUnexpectedMessageType  = errors.New("unexpected message type")
	ErrUnexpectedResponseType = errors.New("unexpected response type")
	ErrUnexpectedRequestType  = errors.New("unexpected request type")
	ErrUnknownHead            = errors.New("unknown head")
)

var (
	ErrMessageIsRequest    = errors.New("message is request")
	ErrMessageIsNotRequest = errors.New("message is not request")
)

var (
	ErrSyncAclClosed = errors.New("sync acl is closed")
)

Functions

func NewRequest

func NewRequest(peerId, objectId, spaceId, head string, root *consensusproto.RawRecordWithId) *objectmessages.Request

Types

type InnerHeadUpdate

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

func (InnerHeadUpdate) Heads

func (h InnerHeadUpdate) Heads() []string

func (InnerHeadUpdate) Marshall

func (h InnerHeadUpdate) Marshall(data objectmessages.ObjectMeta) ([]byte, error)

func (InnerHeadUpdate) MsgSize

func (h InnerHeadUpdate) MsgSize() uint64

type InnerRequest

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

func (*InnerRequest) Marshall

func (r *InnerRequest) Marshall() ([]byte, error)

func (*InnerRequest) MsgSize

func (r *InnerRequest) MsgSize() uint64

type RequestFactory

type RequestFactory interface {
	CreateHeadUpdate(l list.AclList, added []*consensusproto.RawRecordWithId) (headUpdate *objectmessages.HeadUpdate)
	CreateFullSyncRequest(peerId string, l list.AclList) *objectmessages.Request
	CreateFullSyncResponse(l list.AclList, theirHead string) (resp *Response, err error)
}

func NewRequestFactory

func NewRequestFactory(spaceId string) RequestFactory

type Response

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

func (*Response) MsgSize

func (r *Response) MsgSize() uint64

func (*Response) ProtoMessage

func (r *Response) ProtoMessage() (proto.Message, error)

func (*Response) SetProtoMessage

func (r *Response) SetProtoMessage(message proto.Message) error

type SyncAcl

type SyncAcl interface {
	app.ComponentRunnable
	list.AclList
	syncdeps.ObjectSyncHandler
	SetHeadUpdater(updater headupdater.HeadUpdater)
	SyncWithPeer(ctx context.Context, p peer.Peer) (err error)
	SetAclUpdater(updater headupdater.AclUpdater)
}

func New

func New() SyncAcl

type SyncClient

type SyncClient interface {
	RequestFactory
	Broadcast(ctx context.Context, headUpdate *objectmessages.HeadUpdate) error
	QueueRequest(ctx context.Context, req syncdeps.Request) (err error)
}

func NewSyncClient

func NewSyncClient(spaceId string, syncService sync.SyncService) SyncClient