github/client-go
1
0
Fork 0
mirror of https://github.com/kubernetes/client-go.git synced 2025-06-30 08:51:53 +00:00
Code Issues Projects Releases Wiki Activity

Update the wording of the DeltaFIFO

Browse Source 
Kubernetes-commit: 3a107951f0bf16a022b70a667c98833e4ac1d540
This commit is contained in:
Victor Timofei 2020-12-24 16:33:04 +02:00 committed by Kubernetes Publisher
parent 710a222444
commit 53a09c71a4
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
tools/cache/delta_fifo.go vendored
View File

@ -51,7 +51,7 @@ type DeltaFIFOOptions struct {
EmitDeltaTypeReplaced bool EmitDeltaTypeReplaced bool
} }
// DeltaFIFO is like FIFO, but differs in three ways. One is that the // DeltaFIFO is like FIFO, but differs in two ways. One is that the
// accumulator associated with a given object's key is not that object // accumulator associated with a given object's key is not that object
// but rather a Deltas, which is a slice of Delta values for that // but rather a Deltas, which is a slice of Delta values for that
// object. Applying an object to a Deltas means to append a Delta // object. Applying an object to a Deltas means to append a Delta
@ -61,12 +61,11 @@ type DeltaFIFOOptions struct {
// Deleted if the older Deleted's object is a // Deleted if the older Deleted's object is a
// DeletedFinalStateUnknown. // DeletedFinalStateUnknown.
// //
// The second difference is that DeltaFIFO has an additional way that // The other difference is that DeltaFIFO has two additional ways that
// an object can be applied to an accumulator, called Replaced. However, // an object can be applied to an accumulator: Replaced and Sync.
// if EmitDeltaTypeReplaced is not set to true, Sync will be used in // If EmitDeltaTypeReplaced is not set to true, Sync will be used in
// replace events for backwards compatibility. // replace events for backwards compatibility. Sync is used for periodic
// // resync events.
// The last difference is that Sync is used for periodic resync events.
// //
// DeltaFIFO is a producer-consumer queue, where a Reflector is // DeltaFIFO is a producer-consumer queue, where a Reflector is
// intended to be the producer, and the consumer is whatever calls // intended to be the producer, and the consumer is whatever calls
@ -149,8 +148,9 @@ const (
Sync DeltaType = "Sync" Sync DeltaType = "Sync"
) )
// Delta is the type stored by a DeltaFIFO. It tells you what change // Delta is a member of Deltas (a list of Delta objects) which
// happened, and the object's state after* that change. // in its turn is the type stored by a DeltaFIFO. It tells you what
// change happened, and the object's state after* that change.
// //
// [*] Unless the change is a deletion, and then you'll get the final // [*] Unless the change is a deletion, and then you'll get the final
// state of the object before it was deleted. // state of the object before it was deleted.