lid

type CheckResponse struct {
	Signee string `json:"signee,omitempty"` // The owner of the lock.
	Level  int    `json:"level,omitempty"`  // The level of the lock.
}

type Error struct {
	Code    int
	Msg     string
	Payload interface{}
}

type LockOpts struct {
	Force      bool          `json:"force,omitempty"` // If true then force the lock, even if someone else owns it.
	Duration   time.Duration // Override the service default
	TimeToLive time.Duration // Override the service default
}

type LockRequest struct {
	Signature string `json:"signature,omitempty"` // The ID for this lock
	Signee    string `json:"signee,omitempty"`    // The owner requesting the lock
	Level     int    `json:"level,omitempty"`     // The level of lock requested. Leave this at the default 0 if you don't require levels.
}

type LockResponse struct {
	Status         LockResponseStatus `json:"status,omitempty"`
	PreviousSignee string             `json:"previous_signee,omitempty"` // If I acquired a stale lock, this is the former owner
}

type LockResponseStatus int

type Service interface {
	// Lock acquires the supplied lock. An error means the lock was not
	// acquired; success could be for various reasons supplied in the response.
	// The lock will be acquired if:
	// * It does not exist
	// * Or it does, and I own it
	// * Or it does, I don't own it, but my lock level is higher
	// * Or it does, I don't own it, but it's expired
	Lock(req LockRequest, opts *LockOpts) (LockResponse, error)

	// Unlock releases the supplied lock. Error is only returned if the lock
	// is owned by another signee; nil error means the lock no longer
	// exists, whether it did before or not.
	// The lock will be released if:
	// * It does not exist
	// * Or it does, and I own it
	Unlock(req UnlockRequest, opts *UnlockOpts) (UnlockResponse, error)

	// Check answers the current state of the lock.
	// DO NOT USE THIS FUNCTION. There's little value in finding out
	// what state a lock was in at some previous point in time; it
	// exists solely to ease transitioning of a private service to this
	// library. It will likely be removed at some point.
	Check(signature string) (CheckResponse, error)
}

type ServiceBootstrap interface {
	OpenService() Service
	CloseService() error
}

type ServiceDebug interface {
	SetDuration(time.Duration)
}

type ServiceOpts struct {
	Table      string        // Name of the table with lock data. NOTE: The package will manage this table, deleting it at will.
	Duration   time.Duration // The duration before the lock expires.
	TimeToLive time.Duration // Non-empty values will enable time to live on the lock table and expire items after the duration.
}

type UnlockOpts struct {
}

type UnlockRequest struct {
	Signature string `json:"signature,omitempty"` // The ID for this lock
	Signee    string `json:"signee,omitempty"`    // The owner requesting the lock
}

type UnlockResponse struct {
	Status UnlockResponseStatus `json:"status,omitempty"`
}

type UnlockResponseStatus int