LiveCheckpointOffer class

The checkpoint the peer will send: the frontier state at H (H's commit and state tree, and the settled-letter outcome commits beside it), one deterministic Git pack. It is the same shape as an epoch boundary's frontier state (CAP-825), whether or not epochs are on.

Available extensions

Constructors

LiveCheckpointOffer({String? head, String? packId, Int64? bytes, int? chunkBytes, Iterable<String>? shallow, Iterable<RetainedRef>? outcomes, bool? remount, Int64? offersBehind, String? requestId, String? sealed, String? main})
factory
LiveCheckpointOffer.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
LiveCheckpointOffer.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

bytes ↔ Int64
getter/setter pair
chunkBytes ↔ int
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
getter/setter pair
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
main ↔ String
The peer's main when it offered this checkpoint. Above head, the copy levels to it after mounting.
getter/setter pair
offersBehind ↔ Int64
getter/setter pair
outcomes → PbList<RetainedRef>
The settled-letter outcome refs whose commits the pack carries (#567).
no setter
packId ↔ String
getter/setter pair
remount ↔ bool
Offered instead of offers: the copy is further behind than its remount bound, or its head is not in the peer's custody.
getter/setter pair
requestId ↔ String
Set when this transfer is a history slice, not a checkpoint: the slice's request id. head is then the shallow boundary the slice continues below, shallow its new boundary.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sealed ↔ String
The main this peer's custodian has made durable. A checkpoint is offered at it whenever the peer knows it and it is on main; the offers above it follow in batches, so a stream never waits for a seal. A copy bookmarks the checkpoint's head only when it is this sealed head.
getter/setter pair
shallow → PbList<String>
no setter
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearBytes() → void
clearChunkBytes() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearHead() → void
clearMain() → void
clearOffersBehind() → void
clearPackId() → void
clearRemount() → void
clearRequestId() → void
clearSealed() → void
clone() → LiveCheckpointOffer
Creates a deep copy of the fields in this message.
copyWith(void updates(LiveCheckpointOffer)) → LiveCheckpointOffer
Apply updates to a copy of this message.
createEmptyInstance() → LiveCheckpointOffer
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasBytes() → bool
hasChunkBytes() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasHead() → bool
hasMain() → bool
hasOffersBehind() → bool
hasPackId() → bool
hasRemount() → bool
hasRequestId() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSealed() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited