PeerStreamEffect class
Inside a device's Peer Office only (architecture/peer_catchup.md): a procedure's request of its workspace's stream. The office serves it over the workspace's live socket and answers the procedure itself; a shell never performs it and refuses one it is handed.
- Available extensions
Constructors
- PeerStreamEffect({String? effectId, String? workspace, LiveCheckpointRequest? checkpoint, LiveHistoryRequest? history, LiveRefRequest? ref, LiveFrontier? level, bool? startOnly, String? upstream, String? credentialCapability})
-
factory
-
PeerStreamEffect.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- PeerStreamEffect.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- checkpoint ↔ LiveCheckpointRequest
-
getter/setter pair
- credentialCapability ↔ String
-
getter/setter pair
- effectId ↔ String
-
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- history ↔ LiveHistoryRequest
-
getter/setter pair
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - level ↔ LiveFrontier
-
Bring this copy level with the peer's main over the socket: batches of offers after its head,
or (with
remount_after_offers, from a copy holding no work above its bookmark) a checkpoint to remount when it is further behind than that.getter/setter pair - ref ↔ LiveRefRequest
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startOnly ↔ bool
-
Only start the ask and answer at once (an empty receipt): the procedure does other work (its
law products) while the stream delivers, then asks again without
start_onlyto wait for it.getter/setter pair - unknownFields → UnknownFieldSet
-
no setterinherited
- upstream ↔ String
-
Where the workspace is followed from (its custodian's workspace URL) and the credential the
stream presents, for a workspace this copy streams without a follow of its own (a prerequisite).
getter/setter pair
- workspace ↔ String
-
getter/setter pair
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
-
clearCheckpoint(
) → void -
clearCredentialCapability(
) → void -
clearEffectId(
) → 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
-
clearHistory(
) → void -
clearLevel(
) → void -
clearRef(
) → void -
clearRequest(
) → void -
clearStartOnly(
) → void -
clearUpstream(
) → void -
clearWorkspace(
) → void -
clone(
) → PeerStreamEffect - Creates a deep copy of the fields in this message.
-
copyWith(
void updates(PeerStreamEffect)) → PeerStreamEffect -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → PeerStreamEffect - 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. -
ensureCheckpoint(
) → LiveCheckpointRequest -
ensureHistory(
) → LiveHistoryRequest -
ensureLevel(
) → LiveFrontier -
ensureRef(
) → LiveRefRequest -
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
-
hasCheckpoint(
) → bool -
hasCredentialCapability(
) → bool -
hasEffectId(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasHistory(
) → bool -
hasLevel(
) → bool -
hasRef(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasStartOnly(
) → bool -
hasUpstream(
) → bool -
hasWorkspace(
) → 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 aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.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
otherinto 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
Applyupdatesto 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
-
whichRequest(
) → PeerStreamEffect_Request -
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.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