public class KeyGroupsStateHandle extends Object implements StreamStateHandle, KeyedStateHandle
Constructor and Description |
---|
KeyGroupsStateHandle(KeyGroupRangeOffsets groupRangeOffsets,
StreamStateHandle streamStateHandle) |
Modifier and Type | Method and Description |
---|---|
void |
discardState()
Discards the state referred to and solemnly owned by this handle, to free up resources in
the persistent storage.
|
boolean |
equals(Object o) |
StreamStateHandle |
getDelegateStateHandle() |
KeyGroupRangeOffsets |
getGroupRangeOffsets() |
KeyGroupsStateHandle |
getIntersection(KeyGroupRange keyGroupRange)
Returns a state over a range that is the intersection between this
handle's key-group range and the provided key-group range.
|
KeyGroupRange |
getKeyGroupRange()
Returns the range of the key groups contained in the state.
|
long |
getOffsetForKeyGroup(int keyGroupId) |
long |
getStateSize()
Returns the size of the state in bytes.
|
int |
hashCode() |
FSDataInputStream |
openInputStream()
Returns an
FSDataInputStream that can be used to read back the data that
was previously written to the stream. |
void |
registerSharedStates(SharedStateRegistry stateRegistry)
Register both newly created and already referenced shared states in the given
SharedStateRegistry . |
String |
toString() |
public KeyGroupsStateHandle(KeyGroupRangeOffsets groupRangeOffsets, StreamStateHandle streamStateHandle)
groupRangeOffsets
- range of key-group ids that in the state of this handlestreamStateHandle
- handle to the actual state of the key-groupspublic KeyGroupRangeOffsets getGroupRangeOffsets()
public StreamStateHandle getDelegateStateHandle()
public long getOffsetForKeyGroup(int keyGroupId)
keyGroupId
- the id of a key-group. the id must be contained in the range of this handle.public KeyGroupsStateHandle getIntersection(KeyGroupRange keyGroupRange)
KeyedStateHandle
getIntersection
in interface KeyedStateHandle
keyGroupRange
- a key group range to intersect.public KeyGroupRange getKeyGroupRange()
KeyedStateHandle
getKeyGroupRange
in interface KeyedStateHandle
public void registerSharedStates(SharedStateRegistry stateRegistry)
CompositeStateHandle
SharedStateRegistry
. This method is called when the checkpoint
successfully completes or is recovered from failures.
After this is completed, newly created shared state is considered as published is no longer
owned by this handle. This means that it should no longer be deleted as part of calls to
StateObject.discardState()
. Instead, StateObject.discardState()
will trigger an unregistration
from the registry.
registerSharedStates
in interface CompositeStateHandle
stateRegistry
- The registry where shared states are registered.public void discardState() throws Exception
StateObject
discardState
in interface StateObject
Exception
public long getStateSize()
StateObject
0
.
The values produced by this method are only used for informational purposes and for metrics/monitoring. If this method returns wrong values, the checkpoints and recovery will still behave correctly. However, efficiency may be impacted (wrong space pre-allocation) and functionality that depends on metrics (like monitoring) will be impacted.
Note for implementors: This method should not perform any I/O operations
while obtaining the state size (hence it does not declare throwing an IOException
).
Instead, the state size should be stored in the state object, or should be computable from
the state stored in this object.
The reason is that this method is called frequently by several parts of the checkpointing
and issuing I/O requests from this method accumulates a heavy I/O load on the storage
system at higher scale.
getStateSize
in interface StateObject
public FSDataInputStream openInputStream() throws IOException
StreamStateHandle
FSDataInputStream
that can be used to read back the data that
was previously written to the stream.openInputStream
in interface StreamStateHandle
IOException
Copyright © 2014–2019 The Apache Software Foundation. All rights reserved.