org.apache.flink.runtime.checkpoint.savepoint

Class SavepointV2Serializer

java.lang.Object

org.apache.flink.runtime.checkpoint.savepoint.SavepointV2Serializer

All Implemented Interfaces:

SavepointSerializer<SavepointV2>

@Internal
 @VisibleForTesting
public class SavepointV2Serializer
extends Object
implements SavepointSerializer<SavepointV2>

(De)serializer for checkpoint metadata format version 2.

This format version adds

Basic checkpoint metadata layout:

  +--------------+---------------+-----------------+
  | checkpointID | master states | operator states |
  +--------------+---------------+-----------------+
  
  Master state:
  +--------------+---------------------+---------+------+---------------+
  | magic number | num remaining bytes | version | name | payload bytes |
  +--------------+---------------------+---------+------+---------------+
 

Field Summary

Fields

Modifier and Type	Field and Description
static SavepointV2Serializer	INSTANCE The singleton instance of the serializer

Method Summary

Modifier and Type	Method and Description
SavepointV2	deserialize(DataInputStream dis, ClassLoader cl) Deserializes a savepoint from an input stream.
static KeyedStateHandle	deserializeKeyedStateHandle(DataInputStream dis)
static OperatorStateHandle	deserializeOperatorStateHandle(DataInputStream dis)
static StreamStateHandle	deserializeStreamStateHandle(DataInputStream dis)
void	serialize(SavepointV2 checkpointMetadata, DataOutputStream dos) Serializes a savepoint to an output stream.
static void	serializeKeyedStateHandle(KeyedStateHandle stateHandle, DataOutputStream dos)
static void	serializeOperatorStateHandle(OperatorStateHandle stateHandle, DataOutputStream dos)
static void	serializeStreamStateHandle(StreamStateHandle stateHandle, DataOutputStream dos)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final SavepointV2Serializer INSTANCE

The singleton instance of the serializer

Method Detail

serialize

public void serialize(SavepointV2 checkpointMetadata,
                      DataOutputStream dos)
               throws IOException

Description copied from interface: SavepointSerializer

Serializes a savepoint to an output stream.

Specified by:

serialize in interface SavepointSerializer<SavepointV2>

Parameters:

checkpointMetadata - Savepoint to serialize

dos - Output stream to serialize the savepoint to

Throws:

IOException - Serialization failures are forwarded

deserialize

public SavepointV2 deserialize(DataInputStream dis,
                               ClassLoader cl)
                        throws IOException

Description copied from interface: SavepointSerializer

Deserializes a savepoint from an input stream.

Specified by:

deserialize in interface SavepointSerializer<SavepointV2>

Parameters:

dis - Input stream to deserialize savepoint from

cl - the user code class loader

Returns:

The deserialized savepoint

Throws:

IOException - Serialization failures are forwarded

serializeKeyedStateHandle

@VisibleForTesting
public static void serializeKeyedStateHandle(KeyedStateHandle stateHandle,
                                                                DataOutputStream dos)
                                                         throws IOException

Throws:

IOException

deserializeKeyedStateHandle

@VisibleForTesting
public static KeyedStateHandle deserializeKeyedStateHandle(DataInputStream dis)
                                                                       throws IOException

Throws:

IOException

serializeOperatorStateHandle

@VisibleForTesting
public static void serializeOperatorStateHandle(OperatorStateHandle stateHandle,
                                                                   DataOutputStream dos)
                                                            throws IOException

Throws:

IOException

deserializeOperatorStateHandle

@VisibleForTesting
public static OperatorStateHandle deserializeOperatorStateHandle(DataInputStream dis)
                                                                             throws IOException

Throws:

IOException

serializeStreamStateHandle

@VisibleForTesting
public static void serializeStreamStateHandle(StreamStateHandle stateHandle,
                                                                 DataOutputStream dos)
                                                          throws IOException

Throws:

IOException

deserializeStreamStateHandle

public static StreamStateHandle deserializeStreamStateHandle(DataInputStream dis)
                                                      throws IOException

Throws:

IOException