syncdeps

Documentation

Index

• Constants
• type Message
• type ObjectSyncHandler
• type QueueSizeUpdater
• type Request
• type RequestSender
• type Response
• type ResponseCollector
• type SyncHandler

Constants

const (
	MsgTypeIncoming = iota
	MsgTypeOutgoing
	MsgTypeIncomingRequest
	MsgTypeOutgoingRequest
	MsgTypeReceivedResponse
	MsgTypeSentResponse
)

const CName = "common.sync.syncdeps"

Types

type Message

type Message interface {
	ObjectId() string
	MsgSize() uint64
}

type ObjectSyncHandler

type ObjectSyncHandler interface {
	HandleHeadUpdate(ctx context.Context, statusUpdater syncstatus.StatusUpdater, headUpdate drpc.Message) (Request, error)
	HandleStreamRequest(ctx context.Context, rq Request, updater QueueSizeUpdater, send func(resp proto.Message) error) (Request, error)
	HandleDeprecatedRequest(ctx context.Context, req *spacesyncproto.ObjectSyncMessage) (resp *spacesyncproto.ObjectSyncMessage, err error)
	HandleResponse(ctx context.Context, peerId, objectId string, resp Response) error
	ResponseCollector() ResponseCollector
}

type QueueSizeUpdater

type QueueSizeUpdater interface {
	UpdateQueueSize(size uint64, msgType int, add bool)
}

type Request

type Request interface {
	PeerId() string
	ObjectId() string
	Proto() (proto.Message, error)
	MsgSize() uint64
}

type RequestSender

type RequestSender interface {
	SendRequest(ctx context.Context, rq Request, collector ResponseCollector) error
}

type Response

type Response interface {
	multiqueue.Sizeable
}

type ResponseCollector

type ResponseCollector interface {
	NewResponse() Response
	CollectResponse(ctx context.Context, peerId, objectId string, resp Response) error
}

type SyncHandler

type SyncHandler interface {
	app.Component
	HandleHeadUpdate(ctx context.Context, headUpdate drpc.Message) (Request, error)
	HandleStreamRequest(ctx context.Context, rq Request, updater QueueSizeUpdater, sendResponse func(resp proto.Message) error) (Request, error)
	HandleDeprecatedObjectSync(ctx context.Context, req *spacesyncproto.ObjectSyncMessage) (resp *spacesyncproto.ObjectSyncMessage, err error)
	ApplyRequest(ctx context.Context, rq Request, requestSender RequestSender) error
	TryAddMessage(ctx context.Context, peerId string, msg multiqueue.Sizeable, q *mb.MB[multiqueue.Sizeable]) error
	SendStreamRequest(ctx context.Context, rq Request, receive func(stream drpc.Stream) error) (err error)
	NewMessage() drpc.Message
}