/ doc / toc / ARCCore / Class / ClientUpdatePosition

ClientUpdatePosition

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/Assembly = ARCCore
__TOCDet/Description = Describes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned.0x000D0x000A(or actually, it describes up to which point in time client already has updated data).0x000D0x000A0x000D0x000ACommunicated between client and server as follows:0x000D0x000A0x000D0x000A1) At initialization of -ActualConnection-:0x000D0x000ASent by client to server in order to inform the server about the client's update status.0x000D0x000A0x000D0x000A2) For every new -PropertyStreamLine- sent from server to client:0x000D0x000ASent by server to client. Done by prepending to the -PropertyStreamLine- being sent, with '::' (double colon) as a separator.0x000D0x000AExplains from where in the -PropertyStream- this line originated.0x000D0x000AThe server also keeps track of the last value sent to the client as long as the -ActualConnection- is active.0x000D0x000A0x000D0x000AUsed in connection with -Subscription- which describes WHAT data is required from the -PropertyStream-.0x000D0x000ATODO: Clarify difference between -ClientUpdatePosition- and -FromTime- / -ToTime-.0x000D0x000A0x000D0x000ATODO: Build revision number into this? (-DataRetention- or keep in filename?0x000D0x000A0x000D0x000ATODO: Ensure that the format being used suits the encoding mechanism well (see EncodeValuePart) (no special encoding should be necessary as want a human readable format also after encoding)0x000D0x000A0x000D0x000ADescribes status of a client's up-to-date level.0x000D0x000ANote that client in this case not only means -Client- but any -ARNodeType-.0x000D0x000Ar0x000AExamples:0x000D0x000A0x000D0x000A1) 'ClientDatastoreIsEmpty' (see -ClientDatastoreIsEmpty-).0x000D0x000A0x000D0x000A2) 'OnlyNewDataIsRequested' (see -OnlyNewDataIsRequested-).0x000D0x000A0x000D0x000A3) 'GoBack|1000' (see -IsGoBack-) means start from 1000 elements back.0x000D0x000A0x000D0x000A4) 'StorageFile0042|42042': The common scenario. Last update was index 42042 in 'StorageFile0042', next update should be at least 42043 (or index 0 in next file)0x000D0x000A0x000D0x000AAn 'IsEndOfStream' marker may be added, like this:0x000D0x000A'StorageFile0068|42042042|IsEndOfStream' (see -IsAtEndOfStream-).0x000D0x000A0x000D0x000AThis class is immutable.0x000D0x000A
__TOCDet/DocFragType = Class
__TOCDet/LongDescription = 0x000D0x000ATODO: Note how we assume that if we have multiple outgoing connections, that is, if we0x000D0x000ATODO: have multiple CoreDB's to choose from, they are all compatible regarding clientUpdateStatus.0x000D0x000ATODO: This would probably not be the case with how clientUpdateStatus is built up today0x000D0x000ATODO: (Apr 2020) with filename + index.0x000D0x000ATODO: Consider adding timestamp, actual property line or similar, in order for different CoreDB instances to more TODO: accurately decide from where to 'pick-up' from when receiving a new incoming connection with a subscription request.TODO: OR, alternatively, ensure that CoreDB instances coordinate among themselves so that they always have the exact same TODO. storage-layout (having a master instance at any given time for instance).0x000D0x000A0x000D0x000ATODO: If we add timestamp, it can then be up to the client to keep track of it, by 'listening' to Timestamps / 'Heartbeats' inserted in the TODO: property stream. The client can then transmit it to the server, as a backup, in case the ordinary filename + index TODO: information makes no sense. Using only Timestamp would of course lead to some overlap (duplicate property stream lines being sent), TOOD: since it is probably quite coarse.0x000D0x000ATODO: Other ideas for keeping clients correctly in sync:0x000D0x000ATODO: Server can inject the current position at regular intervals in the property stream. This serves the same purpose as injecting a TODO: Timestamp / 'Heartbeat' but the position becomes exact instead of approximate. When the client understands that there is someTODO: corruption present, it can look for the last such value, delete stored data after that position, and update from server from this TODO: exact known position. (actually the client can inject the position itself, since it receives the position with any value sent)
__TOCDet/Name = ClientUpdatePosition
__TOCDet/Namespace = ARCCore
__TOCDet/Type = ClientUpdatePosition
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/ClassNamespace = ARCCore
__TOCDet/Attribute/ClassType = ClientUpdatePosition
__TOCDet/Attribute/Description = Describes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned.0x000D0x000A(or actually, it describes up to which point in time client already has updated data).0x000D0x000A0x000D0x000ACommunicated between client and server as follows:0x000D0x000A0x000D0x000A1) At initialization of -ActualConnection-:0x000D0x000ASent by client to server in order to inform the server about the client's update status.0x000D0x000A0x000D0x000A2) For every new -PropertyStreamLine- sent from server to client:0x000D0x000ASent by server to client. Done by prepending to the -PropertyStreamLine- being sent, with '::' (double colon) as a separator.0x000D0x000AExplains from where in the -PropertyStream- this line originated.0x000D0x000AThe server also keeps track of the last value sent to the client as long as the -ActualConnection- is active.0x000D0x000A0x000D0x000AUsed in connection with -Subscription- which describes WHAT data is required from the -PropertyStream-.0x000D0x000ATODO: Clarify difference between -ClientUpdatePosition- and -FromTime- / -ToTime-.0x000D0x000A0x000D0x000ATODO: Build revision number into this? (-DataRetention- or keep in filename?0x000D0x000A0x000D0x000ATODO: Ensure that the format being used suits the encoding mechanism well (see EncodeValuePart) (no special encoding should be necessary as want a human readable format also after encoding)0x000D0x000A0x000D0x000ADescribes status of a client's up-to-date level.0x000D0x000ANote that client in this case not only means -Client- but any -ARNodeType-.0x000D0x000Ar0x000AExamples:0x000D0x000A0x000D0x000A1) 'ClientDatastoreIsEmpty' (see -ClientDatastoreIsEmpty-).0x000D0x000A0x000D0x000A2) 'OnlyNewDataIsRequested' (see -OnlyNewDataIsRequested-).0x000D0x000A0x000D0x000A3) 'GoBack|1000' (see -IsGoBack-) means start from 1000 elements back.0x000D0x000A0x000D0x000A4) 'StorageFile0042|42042': The common scenario. Last update was index 42042 in 'StorageFile0042', next update should be at least 42043 (or index 0 in next file)0x000D0x000A0x000D0x000AAn 'IsEndOfStream' marker may be added, like this:0x000D0x000A'StorageFile0068|42042042|IsEndOfStream' (see -IsAtEndOfStream-).0x000D0x000A0x000D0x000AThis class is immutable.0x000D0x000A
__TOCDet/Attribute/Interfaces = ITypeDescriber0x003BIEquatable0xoooo003CClientUpdatePosition0xoooo003E
__TOCDet/Attribute/InterfacesDirectlyImplemented = ITypeDescriber0x003BIEquatable0xoooo003CClientUpdatePosition0xoooo003E
__TOCDet/Attribute/LongDescription = 0x000D0x000ATODO: Note how we assume that if we have multiple outgoing connections, that is, if we0x000D0x000ATODO: have multiple CoreDB's to choose from, they are all compatible regarding clientUpdateStatus.0x000D0x000ATODO: This would probably not be the case with how clientUpdateStatus is built up today0x000D0x000ATODO: (Apr 2020) with filename + index.0x000D0x000ATODO: Consider adding timestamp, actual property line or similar, in order for different CoreDB instances to more TODO: accurately decide from where to 'pick-up' from when receiving a new incoming connection with a subscription request.TODO: OR, alternatively, ensure that CoreDB instances coordinate among themselves so that they always have the exact same TODO. storage-layout (having a master instance at any given time for instance).0x000D0x000A0x000D0x000ATODO: If we add timestamp, it can then be up to the client to keep track of it, by 'listening' to Timestamps / 'Heartbeats' inserted in the TODO: property stream. The client can then transmit it to the server, as a backup, in case the ordinary filename + index TODO: information makes no sense. Using only Timestamp would of course lead to some overlap (duplicate property stream lines being sent), TOOD: since it is probably quite coarse.0x000D0x000ATODO: Other ideas for keeping clients correctly in sync:0x000D0x000ATODO: Server can inject the current position at regular intervals in the property stream. This serves the same purpose as injecting a TODO: Timestamp / 'Heartbeat' but the position becomes exact instead of approximate. When the client understands that there is someTODO: corruption present, it can look for the last such value, delete stored data after that position, and update from server from this TODO: exact known position. (actually the client can inject the position itself, since it receives the position with any value sent)
ClientDatastoreIsEmpty/__TOCDet/Assembly = ARCCore
ClientDatastoreIsEmpty/__TOCDet/Description = Used by the subscribing client to signify that it has no data stored locally, and it therefore needs an update from the beginning of the -PropertyStream-, that is, 'from the beginning of time'.0x000D0x000A0x000D0x000AThis will usually be the case when a new node is introduced, and it needs to build up its own local cache.0x000D0x000A0x000D0x000ASee also -ClientDatastoreIsEmptyInstance-.
ClientDatastoreIsEmpty/__TOCDet/DocFragType = ClassMember
ClientDatastoreIsEmpty/__TOCDet/IsInherited = False
ClientDatastoreIsEmpty/__TOCDet/IsInheritedDoc = False
ClientDatastoreIsEmpty/__TOCDet/Lines = 5
ClientDatastoreIsEmpty/__TOCDet/Name = ClientDatastoreIsEmpty
ClientDatastoreIsEmpty/__TOCDet/Namespace = ARCCore
ClientDatastoreIsEmpty/__TOCDet/Type = ClientUpdatePosition
ClientDatastoreIsEmpty/__TOCDet/Attribute/DeclaringType = ClientUpdatePosition
ClientDatastoreIsEmpty/__TOCDet/Attribute/Description = Used by the subscribing client to signify that it has no data stored locally, and it therefore needs an update from the beginning of the -PropertyStream-, that is, 'from the beginning of time'.0x000D0x000A0x000D0x000AThis will usually be the case when a new node is introduced, and it needs to build up its own local cache.0x000D0x000A0x000D0x000ASee also -ClientDatastoreIsEmptyInstance-.
ClientDatastoreIsEmpty/__TOCDet/Attribute/MethodName = ClientDatastoreIsEmpty
ClientDatastoreIsEmpty/__TOCDet/Attribute/MethodSignature = Boolean ClientDatastoreIsEmpty
ClientDatastoreIsEmptyInstance/__TOCDet/Assembly = ARCCore
ClientDatastoreIsEmptyInstance/__TOCDet/Description = See also -ClientDatastoreIsEmpty.
ClientDatastoreIsEmptyInstance/__TOCDet/DocFragType = ClassMember
ClientDatastoreIsEmptyInstance/__TOCDet/IsInherited = False
ClientDatastoreIsEmptyInstance/__TOCDet/IsInheritedDoc = False
ClientDatastoreIsEmptyInstance/__TOCDet/Lines = 1
ClientDatastoreIsEmptyInstance/__TOCDet/Name = ClientDatastoreIsEmptyInstance
ClientDatastoreIsEmptyInstance/__TOCDet/Namespace = ARCCore
ClientDatastoreIsEmptyInstance/__TOCDet/Type = ClientUpdatePosition
ClientDatastoreIsEmptyInstance/__TOCDet/Attribute/DeclaringType = ClientUpdatePosition
ClientDatastoreIsEmptyInstance/__TOCDet/Attribute/Description = See also -ClientDatastoreIsEmpty.
ClientDatastoreIsEmptyInstance/__TOCDet/Attribute/MethodName = ClientDatastoreIsEmptyInstance
ClientDatastoreIsEmptyInstance/__TOCDet/Attribute/MethodSignature = ARCCore.ClientUpdatePosition ClientDatastoreIsEmptyInstance
Filename/__TOCDet/Assembly = ARCCore
Filename/__TOCDet/Description = Filename like '2020-04-03 08:42:22_R001'
Filename/__TOCDet/DocFragType = ClassMember
Filename/__TOCDet/IsInherited = False
Filename/__TOCDet/IsInheritedDoc = False
Filename/__TOCDet/Lines = 1
Filename/__TOCDet/Name = Filename
Filename/__TOCDet/Namespace = ARCCore
Filename/__TOCDet/Type = ClientUpdatePosition
Filename/__TOCDet/Attribute/DeclaringType = ClientUpdatePosition
Filename/__TOCDet/Attribute/Description = Filename like '2020-04-03 08:42:22_R001'
Filename/__TOCDet/Attribute/MethodName = Filename
Filename/__TOCDet/Attribute/MethodSignature = System.String Filename
Index/__TOCDet/Assembly = ARCCore
Index/__TOCDet/Description = Index (zero-based) into file. Value of -1 means blank update status / no data received at all (or no data received for this specific filename)
Index/__TOCDet/DocFragType = ClassMember
Index/__TOCDet/IsInherited = False
Index/__TOCDet/IsInheritedDoc = False
Index/__TOCDet/Lines = 2
Index/__TOCDet/LongDescription = 32 bit because List0x003Cstring0x003E which is used for storage do not support 64 bit indexing anyway
Index/__TOCDet/Name = Index
Index/__TOCDet/Namespace = ARCCore
Index/__TOCDet/Type = ClientUpdatePosition
Index/__TOCDet/Attribute/DeclaringType = ClientUpdatePosition
Index/__TOCDet/Attribute/Description = Index (zero-based) into file. Value of -1 means blank update status / no data received at all (or no data received for this specific filename)
Index/__TOCDet/Attribute/LongDescription = 32 bit because List0x003Cstring0x003E which is used for storage do not support 64 bit indexing anyway
Index/__TOCDet/Attribute/MethodName = Index
Index/__TOCDet/Attribute/MethodSignature = Int32 Index
IsAtEndOfStream/__TOCDet/Assembly = ARCCore
IsAtEndOfStream/__TOCDet/Description = Necessary in order to implement -AdHocQuery-. 0x000D0x000AOnly sent by server to client. Signals to the client that it has now received all data available (for the time being, of course).0x000D0x000AUsed by subscribing client in order decide when an -AdHocQuery- query is complete.0x000D0x000AUsually ignored by client for continous on-going -Subscription-.0x000D0x000A0x000D0x000ANOTE: Not implemented as of May 2020.0x000D0x000A0x000D0x000ANote that fundamentally different from -OnlyNewDataIsRequested (the latter is communicated from client to server, this flag is communicated from server to client)
IsAtEndOfStream/__TOCDet/DocFragType = ClassMember
IsAtEndOfStream/__TOCDet/IsInherited = False
IsAtEndOfStream/__TOCDet/IsInheritedDoc = False
IsAtEndOfStream/__TOCDet/Lines = 8
IsAtEndOfStream/__TOCDet/Name = IsAtEndOfStream
IsAtEndOfStream/__TOCDet/Namespace = ARCCore
IsAtEndOfStream/__TOCDet/Type = ClientUpdatePosition
IsAtEndOfStream/__TOCDet/Attribute/DeclaringType = ClientUpdatePosition
IsAtEndOfStream/__TOCDet/Attribute/Description = Necessary in order to implement -AdHocQuery-. 0x000D0x000AOnly sent by server to client. Signals to the client that it has now received all data available (for the time being, of course).0x000D0x000AUsed by subscribing client in order decide when an -AdHocQuery- query is complete.0x000D0x000AUsually ignored by client for continous on-going -Subscription-.0x000D0x000A0x000D0x000ANOTE: Not implemented as of May 2020.0x000D0x000A0x000D0x000ANote that fundamentally different from -OnlyNewDataIsRequested (the latter is communicated from client to server, this flag is communicated from server to client)
IsAtEndOfStream/__TOCDet/Attribute/MethodName = IsAtEndOfStream
IsAtEndOfStream/__TOCDet/Attribute/MethodSignature = Boolean IsAtEndOfStream
IsGoBack/__TOCDet/Assembly = ARCCore
IsGoBack/__TOCDet/Description = Has to be translated by -StreamProcessor- into a concrete filename / index.0x000D0x000AUseful when subscribing client wants (in general) new log-data, but also data for the last few minutes, for instance when you see a special situation and want to look into the latest log data.0x000D0x000ATODO: 'GoBack' is not implemented as of May 2020.0x000D0x000ATODO: Implement GoBack also as relative time, like 'minus 30 seconds' or absolute time like 'from 08:52'0x000D0x000ATODO: Consider also necessity for Subscription.StartAt / EndAt, which are similar concepts
IsGoBack/__TOCDet/DocFragType = ClassMember
IsGoBack/__TOCDet/IsInherited = False
IsGoBack/__TOCDet/IsInheritedDoc = False
IsGoBack/__TOCDet/Lines = 5
IsGoBack/__TOCDet/Name = IsGoBack
IsGoBack/__TOCDet/Namespace = ARCCore
IsGoBack/__TOCDet/Type = ClientUpdatePosition
IsGoBack/__TOCDet/Attribute/DeclaringType = ClientUpdatePosition
IsGoBack/__TOCDet/Attribute/Description = Has to be translated by -StreamProcessor- into a concrete filename / index.0x000D0x000AUseful when subscribing client wants (in general) new log-data, but also data for the last few minutes, for instance when you see a special situation and want to look into the latest log data.0x000D0x000ATODO: 'GoBack' is not implemented as of May 2020.0x000D0x000ATODO: Implement GoBack also as relative time, like 'minus 30 seconds' or absolute time like 'from 08:52'0x000D0x000ATODO: Consider also necessity for Subscription.StartAt / EndAt, which are similar concepts
IsGoBack/__TOCDet/Attribute/MethodName = IsGoBack
IsGoBack/__TOCDet/Attribute/MethodSignature = Boolean IsGoBack
OnlyNewDataIsRequested/__TOCDet/Assembly = ARCCore
OnlyNewDataIsRequested/__TOCDet/Description = Used by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data.0x000D0x000A0x000D0x000AA typical example is starting up a log-console in order to monitor some action.0x000D0x000A0x000D0x000ANote that this indication is only approximate because data gets continously added to the -PropertyStream-.0x000D0x000A0x000D0x000AAbout the internal implementation: Note how -Communicate- immediately replaces this value with the actual up-to-date position (instead of waiting for -StreamProcessor- to decide from where to start sending data, because then some new data may be lost. One would then not risk loosing a few tenths of seconds of -PropertyStream- data only because it takes some time for -StreamProcessor- to start processing the client request)0x000D0x000A0x000D0x000ASee also -OnlyNewDataIsRequestedInstance-.
OnlyNewDataIsRequested/__TOCDet/DocFragType = ClassMember
OnlyNewDataIsRequested/__TOCDet/IsInherited = False
OnlyNewDataIsRequested/__TOCDet/IsInheritedDoc = False
OnlyNewDataIsRequested/__TOCDet/Lines = 9
OnlyNewDataIsRequested/__TOCDet/Name = OnlyNewDataIsRequested
OnlyNewDataIsRequested/__TOCDet/Namespace = ARCCore
OnlyNewDataIsRequested/__TOCDet/Type = ClientUpdatePosition
OnlyNewDataIsRequested/__TOCDet/Attribute/DeclaringType = ClientUpdatePosition
OnlyNewDataIsRequested/__TOCDet/Attribute/Description = Used by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data.0x000D0x000A0x000D0x000AA typical example is starting up a log-console in order to monitor some action.0x000D0x000A0x000D0x000ANote that this indication is only approximate because data gets continously added to the -PropertyStream-.0x000D0x000A0x000D0x000AAbout the internal implementation: Note how -Communicate- immediately replaces this value with the actual up-to-date position (instead of waiting for -StreamProcessor- to decide from where to start sending data, because then some new data may be lost. One would then not risk loosing a few tenths of seconds of -PropertyStream- data only because it takes some time for -StreamProcessor- to start processing the client request)0x000D0x000A0x000D0x000ASee also -OnlyNewDataIsRequestedInstance-.
OnlyNewDataIsRequested/__TOCDet/Attribute/MethodName = OnlyNewDataIsRequested
OnlyNewDataIsRequested/__TOCDet/Attribute/MethodSignature = Boolean OnlyNewDataIsRequested
OnlyNewDataIsRequestedInstance/__TOCDet/Assembly = ARCCore
OnlyNewDataIsRequestedInstance/__TOCDet/Description = See also -OnlyNewDataIsRequested.
OnlyNewDataIsRequestedInstance/__TOCDet/DocFragType = ClassMember
OnlyNewDataIsRequestedInstance/__TOCDet/IsInherited = False
OnlyNewDataIsRequestedInstance/__TOCDet/IsInheritedDoc = False
OnlyNewDataIsRequestedInstance/__TOCDet/Lines = 1
OnlyNewDataIsRequestedInstance/__TOCDet/Name = OnlyNewDataIsRequestedInstance
OnlyNewDataIsRequestedInstance/__TOCDet/Namespace = ARCCore
OnlyNewDataIsRequestedInstance/__TOCDet/Type = ClientUpdatePosition
OnlyNewDataIsRequestedInstance/__TOCDet/Attribute/DeclaringType = ClientUpdatePosition
OnlyNewDataIsRequestedInstance/__TOCDet/Attribute/Description = See also -OnlyNewDataIsRequested.
OnlyNewDataIsRequestedInstance/__TOCDet/Attribute/MethodName = OnlyNewDataIsRequestedInstance
OnlyNewDataIsRequestedInstance/__TOCDet/Attribute/MethodSignature = ARCCore.ClientUpdatePosition OnlyNewDataIsRequestedInstance

Edit single sub keys only: __TOCDet / ClientDatastoreIsEmpty / ClientDatastoreIsEmptyInstance / Filename / Index / IsAtEndOfStream / IsGoBack / OnlyNewDataIsRequested / OnlyNewDataIsRequestedInstance

Generated 2025-05-23 20:57:16.717 UTC