foundation/util/sequencer/sequencer.go

/*
	Copyright 2019 Netfoundry, Inc.

	Licensed under the Apache License, Version 2.0 (the "License");
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at

	https://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
*/

package sequencer

import (
	"errors"
	"time"
)

// this is simple queue which sorts items according to their sequence number
// and waits until sequence can be completed without gaps
type Sequencer interface {
	PutSequenced(seq uint32, v interface{}) error
	GetNext() interface{}
	GetNextWithDeadline(t time.Time) (interface{}, error)
	Close()
}

var ErrClosed = errors.New("sequencer closed")
var ErrTimedOut = errors.New("operation timed out")