org.apache.flink.runtime.state.memory

Class AbstractMemStateSnapshot<K,N,SV,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>>

java.lang.Object

org.apache.flink.runtime.state.memory.AbstractMemStateSnapshot<K,N,SV,S,SD>

Type Parameters:

K - The type of the key in the snapshot state.

N - The type of the namespace in the snapshot state.

SV - The type of the value in the snapshot state.

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, KvStateSnapshot<K,N,S,SD,MemoryStateBackend>, StateObject

Direct Known Subclasses:

MemFoldingState.Snapshot, MemListState.Snapshot, MemReducingState.Snapshot, MemValueState.Snapshot

public abstract class AbstractMemStateSnapshot<K,N,SV,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>>
extends Object
implements KvStateSnapshot<K,N,S,SD,MemoryStateBackend>

A snapshot of a MemValueState for a checkpoint. The data is stored in a heap byte array, in serialized form.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.flink.api.common.typeutils.TypeSerializer<K>	keySerializer Key Serializer
protected org.apache.flink.api.common.typeutils.TypeSerializer<N>	namespaceSerializer Namespace Serializer
protected SD	stateDesc StateDescriptor, for sanity checks
protected org.apache.flink.api.common.typeutils.TypeSerializer<SV>	stateSerializer Serializer for the state value

Constructor Summary

Constructors

Constructor and Description
AbstractMemStateSnapshot(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer, SD stateDesc, byte[] data) Creates a new heap memory state snapshot.

Method Summary

Modifier and Type	Method and Description
void	close()
abstract KvState<K,N,S,SD,MemoryStateBackend>	createMemState(HashMap<N,Map<K,SV>> stateMap)
void	discardState() Discarding the heap state is a no-op.
long	getStateSize() Returns the size of the state in bytes.
KvState<K,N,S,SD,MemoryStateBackend>	restoreState(MemoryStateBackend stateBackend, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, ClassLoader classLoader) Loads the key/value state back from this snapshot.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

keySerializer

protected final org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer

Key Serializer

namespaceSerializer

protected final org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer

Namespace Serializer

stateSerializer

protected final org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer

Serializer for the state value

stateDesc

protected final SD extends org.apache.flink.api.common.state.StateDescriptor<S,?> stateDesc

StateDescriptor, for sanity checks

Constructor Detail

AbstractMemStateSnapshot

public AbstractMemStateSnapshot(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                                org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                                org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer,
                                SD stateDesc,
                                byte[] data)

Creates a new heap memory state snapshot.

Parameters:

keySerializer - The serializer for the keys.

namespaceSerializer - The serializer for the namespace.

stateSerializer - The serializer for the elements in the state HashMap

stateDesc - The state identifier

data - The serialized data of the state key/value pairs

Method Detail

createMemState

public abstract KvState<K,N,S,SD,MemoryStateBackend> createMemState(HashMap<N,Map<K,SV>> stateMap)

restoreState

public KvState<K,N,S,SD,MemoryStateBackend> restoreState(MemoryStateBackend stateBackend,
                                                         org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                                                         ClassLoader classLoader)
                                                  throws Exception

Description copied from interface: KvStateSnapshot

Loads the key/value state back from this snapshot.

Specified by:

restoreState in interface KvStateSnapshot<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,MemoryStateBackend>

Parameters:

stateBackend - The state backend that created this snapshot and can restore the key/value state from this snapshot.

keySerializer - The serializer for the keys.

classLoader - The class loader for user-defined types.

Returns:

An instance of the key/value state loaded from this snapshot.

Throws:

Exception - Exceptions can occur during the state loading and are forwarded.

discardState

public void discardState()

Discarding the heap state is a no-op.

Specified by:

discardState in interface StateObject

getStateSize

public long getStateSize()

Description copied from interface: StateObject

Returns the size of the state in bytes.

If the the size is not known, return 0.

Specified by:

getStateSize in interface StateObject

Returns:

Size of the state in bytes.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable