github.com/kaleido-io/firefly@v0.0.0-20210622132723-8b4b6aacb971/pkg/fftypes/offset.go (about)

     1  // Copyright © 2021 Kaleido, Inc.
     2  //
     3  // SPDX-License-Identifier: Apache-2.0
     4  //
     5  // Licensed under the Apache License, Version 2.0 (the "License");
     6  // you may not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing, software
    12  // distributed under the License is distributed on an "AS IS" BASIS,
    13  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  // See the License for the specific language governing permissions and
    15  // limitations under the License.
    16  
    17  package fftypes
    18  
    19  type OffsetType = LowerCasedType
    20  
    21  const (
    22  	// OffsetTypeBatch is an offset stored by the batch manager on the messages table
    23  	OffsetTypeBatch OffsetType = "batch"
    24  	// OffsetTypeAggregator is an offset stored by the aggregator on the events table
    25  	OffsetTypeAggregator OffsetType = "aggregator"
    26  	// OffsetTypeSubscription is an offeset stored by a dispatcher on the events table
    27  	OffsetTypeSubscription OffsetType = "subscription"
    28  )
    29  
    30  // Offset is a simple stored data structure that records a sequence position within another collection
    31  type Offset struct {
    32  	ID        *UUID      `json:"id"`
    33  	Type      OffsetType `json:"type"`
    34  	Namespace string     `json:"namespace"`
    35  	Name      string     `json:"name"`
    36  	Current   int64      `json:"current,omitempty"`
    37  }