/
partition.go
59 lines (46 loc) · 1.66 KB
/
partition.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// Copyright 2019-present Open Networking Foundation.
//
// 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
//
// http://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 primitive
import (
"context"
"github.com/atomix/go-framework/pkg/atomix/stream"
"time"
)
// Index is a partition log index
type Index uint64
// PartitionContext provides the current state of the partition
type PartitionContext interface {
ProtocolContext
// PartitionID is the partition identifier
PartitionID() PartitionID
// Index returns the current index of the service
Index() Index
// Timestamp returns a deterministic, monotonically increasing timestamp
Timestamp() time.Time
}
// PartitionID is a partition identifier
type PartitionID int
// Partition is the interface for a partition client
type Partition interface {
// MustLeader returns whether the client can only be used on the leader
MustLeader() bool
// IsLeader returns whether the client is the leader
IsLeader() bool
// Leader returns the current leader
Leader() string
// Write sends a write request
Write(ctx context.Context, input []byte, stream stream.WriteStream) error
// Read sends a read request
Read(ctx context.Context, input []byte, stream stream.WriteStream) error
}