For Babelfish Release 1.12.5.15

AttributeValueDataPacketAPIResponse Class

Definition

Namespace: Scopos.BabelFish.Responses.AttributeValueAPI
Assembly: BabelFish (in BabelFish.dll) Version: 1.12.5.15+bc7490f802416c9e774304c66372b6a26afede1d
C#
public class AttributeValueDataPacketAPIResponse : AttributeValueDataPacket
Inheritance
Object    IDeserializableAbstractClass    AttributeValueDataPacket    AttributeValueDataPacketAPIResponse

Constructors

AttributeValueDataPacketAPIResponseInitializes a new instance of the AttributeValueDataPacketAPIResponse class

Properties

AttributeDef the SetName, formatted as a string, of the Attribute definition.
(Inherited from AttributeValueDataPacket)
AttributeValue Property that contains the value.
(Inherited from AttributeValueDataPacket)
AttributeValueTask Property that holds the task to finish deserializing an AttributeValue. See also
(Inherited from AttributeValueDataPacket)
CheckSum A hashed value that is unique to this instance. The value is calculated by the CalculateChecksum() method.
(Inherited from AttributeValueDataPacket)
ConcreteClassId Implementation of the IDeserializableAbstractClass interface. To have added control over the Deserialization of abstract classes, in to Concrete classes, the JSON should include a ConcreteClassId that specifies the Concrete class.
(Inherited from AttributeValueDataPacket)
Message 
StatusCode 
Visibility Property storing how broadly this AttributeValue may be shared.
(Inherited from AttributeValueDataPacket)

Methods

CalculateChecksum Calculates a checksum value that represents the current state of the instance's properties, excluding the LastUpdated and CheckSum properties. Assuming the underlying data did not change, the value of this method should be the same across multiple serializations and deserializations of the same instance.

The intent of this method is two-fold. First to provide a way to verify the integrity of the instance's data after deserialization. If someone (or something) modified the serialized values then CalculateChecksum should return a different value. While we may not know what changed, we can at least detect something manipulated the data.

The second intent is to compare the value of the instance on the server to the local copy. If the value is the same (on the server and locally) then the server has the up to date instance value.


(Inherited from AttributeValueDataPacket)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FinishInitializationAsync Deserilization of a AttributeValueDataPacket is handled by the overridden ReadJson() method of AttributeValueDataPacketConverter class. Because to deserialize an AttributeValue the Definition of the Attribute must be known. And reading the Definition is an IO bound Async call. But ReadJson() is not Async and can't be made async because it is overridden. To get around this limitation, the Task is assigned to AttributeValueTask (instead of awaiting and assigning to AttributeValue. The awaiting of AttributeValueTask is then handled in an async call sepeartly.
(Inherited from AttributeValueDataPacket)
GetAttributeDefinitionAsync Retreives the Attribute Definition referenced by the instantiating class.
(Inherited from AttributeValueDataPacket)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

See Also