binder

type ClientInfo struct {
	UserID    string `json:"user_id"`
	SessionID string `json:"session_id"`
}

type ClientUpdate struct {
	ClientInfo ClientInfo `json:"client"`
	Message    Message    `json:"message"`
}

type Config struct {
	FlushPeriod           int64               `json:"flush_period_ms" yaml:"flush_period_ms"`
	RetentionPeriod       int64               `json:"retention_period_s" yaml:"retention_period_s"`
	ClientKickPeriod      int64               `json:"kick_period_ms" yaml:"kick_period_ms"`
	CloseInactivityPeriod int64               `json:"close_inactivity_period_s" yaml:"close_inactivity_period_s"`
	OTBufferConfig        text.OTBufferConfig `json:"transform_buffer" yaml:"transform_buffer"`
}

type Error struct {
	ID  string
	Err error
}

type Message struct {
	Content  string `json:"content,omitempty"`
	Position *int64 `json:"position,omitempty"`
	Active   bool   `json:"active"`
}

type Portal interface {
	// UserID - Returns the user identifier associated with this binder session.
	UserID() string

	// SessionID - Returns the unique session identifier associated with this binder session.
	SessionID() string

	// BaseVersion - Returns the version of the binder as it was when this session opened.
	BaseVersion() int

	// Document - Returns the document contents as it was when this session opened.
	Document() store.Document

	// ReleaseDocument - Releases the cached document.
	ReleaseDocument()

	// TransformReadChan - Get the channel for reading transforms from other binder clients.
	TransformReadChan() <-chan text.OTransform

	// UpdateReadChan - Get the channel for reading meta updates from other binder clients.
	UpdateReadChan() <-chan ClientUpdate

	// SendTransform - Submits an operational transform to the document, this call adds the
	// transform to the stack of pending changes and broadcasts it to all other connected clients.
	// The transform must be submitted with the target version (the version that the client believed
	// it was, at the time it was made), and the actual version is returned.
	SendTransform(ot text.OTransform, timeout time.Duration) (int, error)

	// SendMessage - Broadcasts a message out to all other connected clients.
	SendMessage(message Message)

	// Exit - Inform the binder that this client is shutting down, this call will block until
	// acknowledged by the binder. Therefore, you may specify a timeout.
	Exit(timeout time.Duration)
}

type Type interface {
	// ID - Returns the ID of this binder.
	ID() string

	// GetUsers - Returns a list of connected users.
	GetUsers(timeout time.Duration) ([]string, error)

	// KickUser - Kick a connected user from this binder.
	KickUser(userID string, timeout time.Duration) error

	// Subscribe - Register a new client as an editor of this binder document.
	Subscribe(userID string, timeout time.Duration) (Portal, error)

	// SubscribeReadOnly - Register a new client as a read only viewer of this binder document.
	SubscribeReadOnly(userID string, timeout time.Duration) (Portal, error)

	// Close - Close the binder and shut down all clients, also flushes and cleans up the document.
	Close()
}