/ doc / toc / ARCAPI / Class / DataStorage

DataStorage

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 = ARCAPI
__TOCDet/Description = The all-in-memory global application data storage.0x000D0x000A0x000D0x000ADoes also contain the necessary global locking object for thread-safe access (-Lock-).0x000D0x000A0x000D0x000AIs usually accessed within -ARAAPI- as a static instance Program.DataStorage.0x000D0x000A0x000D0x000ACan be kept up to date by -Subscription- to -PropertyStream- (see -OutsideLocalReceiver-).0x000D0x000A0x000D0x000AWill usually contain (in addition to -dt-), also other 'branches' like -app- and -doc-.0x000D0x000A0x000D0x000ASee constructor for information about -ExposingApplicationState- through this class.0x000D0x000A0x000D0x000AThis class is immutable.
__TOCDet/DocFragType = Class
__TOCDet/Name = DataStorage
__TOCDet/Namespace = ARCAPI
__TOCDet/Type = DataStorage
__TOCDet/Attribute/AssemblyName = ARCAPI
__TOCDet/Attribute/ClassNamespace = ARCAPI
__TOCDet/Attribute/ClassType = DataStorage
__TOCDet/Attribute/Description = The all-in-memory global application data storage.0x000D0x000A0x000D0x000ADoes also contain the necessary global locking object for thread-safe access (-Lock-).0x000D0x000A0x000D0x000AIs usually accessed within -ARAAPI- as a static instance Program.DataStorage.0x000D0x000A0x000D0x000ACan be kept up to date by -Subscription- to -PropertyStream- (see -OutsideLocalReceiver-).0x000D0x000A0x000D0x000AWill usually contain (in addition to -dt-), also other 'branches' like -app- and -doc-.0x000D0x000A0x000D0x000ASee constructor for information about -ExposingApplicationState- through this class.0x000D0x000A0x000D0x000AThis class is immutable.
.ctor/__TOCDet/Assembly = ARCAPI
.ctor/__TOCDet/Description = This method will:0x000D0x000AInitialize -Storage-,0x000D0x000AInitialize -ControllerStorage-.0x000D0x000A
.ctor/__TOCDet/DocFragType = ClassMember
.ctor/__TOCDet/IsInherited = False
.ctor/__TOCDet/IsInheritedDoc = False
.ctor/__TOCDet/Lines = 4
.ctor/__TOCDet/Name = .ctor
.ctor/__TOCDet/Namespace = ARCAPI
.ctor/__TOCDet/Type = DataStorage
.ctor/__TOCDet/Attribute/DeclaringType = DataStorage
.ctor/__TOCDet/Attribute/Description = This method will:0x000D0x000AInitialize -Storage-,0x000D0x000AInitialize -ControllerStorage-.0x000D0x000A
.ctor/__TOCDet/Attribute/MethodName = .ctor
.ctor/__TOCDet/Attribute/MethodSignature = Void .ctor(ARCCore.IK, System.Collections.Generic.IEnumerable0x006010x005BSystem.Reflection.Assembly0x005D, Boolean, ARCCore.IP)
ControllerStorage/__TOCDet/Assembly = ARCAPI
ControllerStorage/__TOCDet/Description = Usually (but not always) a branch of -Storage- (like Storage0x005B"log"0x005D0x005B"0x007BnodeId0x007D"0x005D0x005B"Controller"0x005D).0x000D0x000A0x000D0x000AEnables -BaseController-.- CatchAll- to dispatch an API request to the correct controller.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for documentation.0x000D0x000A0x000D0x000A
ControllerStorage/__TOCDet/DocFragType = ClassMember
ControllerStorage/__TOCDet/IsInherited = False
ControllerStorage/__TOCDet/IsInheritedDoc = False
ControllerStorage/__TOCDet/Lines = 7
ControllerStorage/__TOCDet/Name = ControllerStorage
ControllerStorage/__TOCDet/Namespace = ARCAPI
ControllerStorage/__TOCDet/Type = DataStorage
ControllerStorage/__TOCDet/Attribute/DeclaringType = DataStorage
ControllerStorage/__TOCDet/Attribute/Description = Usually (but not always) a branch of -Storage- (like Storage0x005B"log"0x005D0x005B"0x007BnodeId0x007D"0x005D0x005B"Controller"0x005D).0x000D0x000A0x000D0x000AEnables -BaseController-.- CatchAll- to dispatch an API request to the correct controller.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for documentation.0x000D0x000A0x000D0x000A
ControllerStorage/__TOCDet/Attribute/MethodName = ControllerStorage
ControllerStorage/__TOCDet/Attribute/MethodSignature = ARCCore.IP ControllerStorage
Create/__TOCDet/Assembly = ARCAPI
Create/__TOCDet/Description = Creates a -DataStorage- instance with default parameters.0x000D0x000A0x000D0x000ANote: You are not obliged to use this method, you can call constructor directly instead and set up this instance 'manually'.0x000D0x000A0x000D0x000AThis method will:0x000D0x000ACall constructor with assemblies from -UtilCore-.-Assemblies- and -DoNotStoreInternally- FALSE,0x000D0x000ACreate -dt- container (if not already set)r0x000ACreate -doc- container with -Documentator-,0x000D0x000ASet -DocLinks-,0x000D0x000AConnect -ExternalReceiver- to -SendFromLocalOrigin- and0x000D0x000ACreate -app- container with data about -StreamProcessor-, -ControllerStorage-, -IPRelationsKeysPointingTo- and -IPRelationsKeysPointingFrom-.
Create/__TOCDet/DocFragType = ClassMember
Create/__TOCDet/IsInherited = False
Create/__TOCDet/IsInheritedDoc = False
Create/__TOCDet/Lines = 10
Create/__TOCDet/Name = Create
Create/__TOCDet/Namespace = ARCAPI
Create/__TOCDet/Type = DataStorage
Create/__TOCDet/Attribute/DeclaringType = DataStorage
Create/__TOCDet/Attribute/Description = Creates a -DataStorage- instance with default parameters.0x000D0x000A0x000D0x000ANote: You are not obliged to use this method, you can call constructor directly instead and set up this instance 'manually'.0x000D0x000A0x000D0x000AThis method will:0x000D0x000ACall constructor with assemblies from -UtilCore-.-Assemblies- and -DoNotStoreInternally- FALSE,0x000D0x000ACreate -dt- container (if not already set)r0x000ACreate -doc- container with -Documentator-,0x000D0x000ASet -DocLinks-,0x000D0x000AConnect -ExternalReceiver- to -SendFromLocalOrigin- and0x000D0x000ACreate -app- container with data about -StreamProcessor-, -ControllerStorage-, -IPRelationsKeysPointingTo- and -IPRelationsKeysPointingFrom-.
Create/__TOCDet/Attribute/MethodName = Create
Create/__TOCDet/Attribute/MethodSignature = ARCAPI.DataStorage Create(ARCCore.IK, ARCCore.IP, ARCCore.StreamProcessor, Boolean)
DocLinks/__TOCDet/Assembly = ARCAPI
DocLinks/__TOCDet/Description = Note that may be null.0x000D0x000A0x000D0x000AA collection of relevant keys from -Storage-, usually limited to Storage0x005B"doc"0x005D.0x000D0x000A0x000D0x000AEnables -LinkInsertionInDocumentation-.0x000D0x000AOriginates (normally) from -DocLinkCollection-.-Create-.0x000D0x000A0x000D0x000AMost relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.0x000D0x000AIf on the other hand documentation storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.0x000D0x000A0x000D0x000AOften set at application startup with links to (static) documentation.0x000D0x000AThis will improve error message for instance, by enabling linking directy to the documentation in the error message.0x000D0x000A0x000D0x000ANOTE: From Dec 2021 it it ASSUMED in AgoRapide in general that content here is static and will not change,0x000D0x000ANOTE: In other words, that content may be accessed without any locking (see -Lock-).0x000D0x000ANOTE: This significantly reduces the performance impact of NOTE: -LinkInsertionInDocumentation-.
DocLinks/__TOCDet/DocFragType = ClassMember
DocLinks/__TOCDet/IsInherited = False
DocLinks/__TOCDet/IsInheritedDoc = False
DocLinks/__TOCDet/Lines = 16
DocLinks/__TOCDet/Name = DocLinks
DocLinks/__TOCDet/Namespace = ARCAPI
DocLinks/__TOCDet/Type = DataStorage
DocLinks/__TOCDet/Attribute/DeclaringType = DataStorage
DocLinks/__TOCDet/Attribute/Description = Note that may be null.0x000D0x000A0x000D0x000AA collection of relevant keys from -Storage-, usually limited to Storage0x005B"doc"0x005D.0x000D0x000A0x000D0x000AEnables -LinkInsertionInDocumentation-.0x000D0x000AOriginates (normally) from -DocLinkCollection-.-Create-.0x000D0x000A0x000D0x000AMost relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.0x000D0x000AIf on the other hand documentation storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.0x000D0x000A0x000D0x000AOften set at application startup with links to (static) documentation.0x000D0x000AThis will improve error message for instance, by enabling linking directy to the documentation in the error message.0x000D0x000A0x000D0x000ANOTE: From Dec 2021 it it ASSUMED in AgoRapide in general that content here is static and will not change,0x000D0x000ANOTE: In other words, that content may be accessed without any locking (see -Lock-).0x000D0x000ANOTE: This significantly reduces the performance impact of NOTE: -LinkInsertionInDocumentation-.
DocLinks/__TOCDet/Attribute/MethodName = DocLinks
DocLinks/__TOCDet/Attribute/MethodSignature = ARCDoc.DocLinkCollection DocLinks
DoNotStoreInternally/__TOCDet/Assembly = ARCAPI
DoNotStoreInternally/__TOCDet/Description = Typically used by -AddController-.0x000D0x000A0x000D0x000ASignals that properties should not be added to -DataStorage- directly. 0x000D0x000AWill typically be used in situations where one wants to ensure that data is actually added to -CoreDB- before showing it in the API. This would again typically be implemented by using -ExternalReceiver- and waiting for the data to come back over a -Subscription- to the -PropertyStream-.0x000D0x000A0x000D0x000ANOTE: As of Jun 2020 there is no mechanism in AgoRapide for ensuring that this actually happens other than for the client to use polling against the API to ensure that the round-trip to the core and back has completed.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
DoNotStoreInternally/__TOCDet/DocFragType = ClassMember
DoNotStoreInternally/__TOCDet/IsInherited = False
DoNotStoreInternally/__TOCDet/IsInheritedDoc = False
DoNotStoreInternally/__TOCDet/Lines = 8
DoNotStoreInternally/__TOCDet/Name = DoNotStoreInternally
DoNotStoreInternally/__TOCDet/Namespace = ARCAPI
DoNotStoreInternally/__TOCDet/Type = DataStorage
DoNotStoreInternally/__TOCDet/Attribute/DeclaringType = DataStorage
DoNotStoreInternally/__TOCDet/Attribute/Description = Typically used by -AddController-.0x000D0x000A0x000D0x000ASignals that properties should not be added to -DataStorage- directly. 0x000D0x000AWill typically be used in situations where one wants to ensure that data is actually added to -CoreDB- before showing it in the API. This would again typically be implemented by using -ExternalReceiver- and waiting for the data to come back over a -Subscription- to the -PropertyStream-.0x000D0x000A0x000D0x000ANOTE: As of Jun 2020 there is no mechanism in AgoRapide for ensuring that this actually happens other than for the client to use polling against the API to ensure that the round-trip to the core and back has completed.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
DoNotStoreInternally/__TOCDet/Attribute/MethodName = DoNotStoreInternally
DoNotStoreInternally/__TOCDet/Attribute/MethodSignature = Boolean DoNotStoreInternally
ExternalReceiver/__TOCDet/Assembly = ARCAPI
ExternalReceiver/__TOCDet/Description = Typically used by -AddController-. 0x000D0x000AWill normally be a method calling -SendFromLocalOrigin-.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
ExternalReceiver/__TOCDet/DocFragType = ClassMember
ExternalReceiver/__TOCDet/IsInherited = False
ExternalReceiver/__TOCDet/IsInheritedDoc = False
ExternalReceiver/__TOCDet/Lines = 4
ExternalReceiver/__TOCDet/Name = ExternalReceiver
ExternalReceiver/__TOCDet/Namespace = ARCAPI
ExternalReceiver/__TOCDet/Type = DataStorage
ExternalReceiver/__TOCDet/Attribute/DeclaringType = DataStorage
ExternalReceiver/__TOCDet/Attribute/Description = Typically used by -AddController-. 0x000D0x000AWill normally be a method calling -SendFromLocalOrigin-.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
ExternalReceiver/__TOCDet/Attribute/MethodName = ExternalReceiver
ExternalReceiver/__TOCDet/Attribute/MethodSignature = System.Action0x006010x005BSystem.String0x005D ExternalReceiver
Lock/__TOCDet/Assembly = ARCAPI
Lock/__TOCDet/Description = Locking object for thread-safe access from simultaneous API requests.0x000D0x000A0x000D0x000A-BaseController- components like -RQController- and -EditController- (offering HTML forms POSTing to -AddController-) will typically need to acquire a Read lock (EnterReadLock),0x000D0x000Awhile components like -AddController- will typically need to acquire a Write lock (EnterWriteLock).0x000D0x000A0x000D0x000ALocking is also need by when keeping storage up-to-date by -Subscription- to -PropertyStream- through -OutsideLocalReceiver-.0x000D0x000A0x000D0x000AIn -ARCEvent- typical components requiring read locks are -ProcessController-, -ESController- and -UIController- while -ASController- requires first a read lock (for parsing) and then a write lock.0x000D0x000A0x000D0x000ANOTE: It is assumed that -DocLinks- can be accessed without locking0x000D0x000ANOTE: (see under -DocLinks- for details).
Lock/__TOCDet/DocFragType = ClassMember
Lock/__TOCDet/IsInherited = False
Lock/__TOCDet/IsInheritedDoc = False
Lock/__TOCDet/Lines = 11
Lock/__TOCDet/Name = Lock
Lock/__TOCDet/Namespace = ARCAPI
Lock/__TOCDet/Type = DataStorage
Lock/__TOCDet/Attribute/DeclaringType = DataStorage
Lock/__TOCDet/Attribute/Description = Locking object for thread-safe access from simultaneous API requests.0x000D0x000A0x000D0x000A-BaseController- components like -RQController- and -EditController- (offering HTML forms POSTing to -AddController-) will typically need to acquire a Read lock (EnterReadLock),0x000D0x000Awhile components like -AddController- will typically need to acquire a Write lock (EnterWriteLock).0x000D0x000A0x000D0x000ALocking is also need by when keeping storage up-to-date by -Subscription- to -PropertyStream- through -OutsideLocalReceiver-.0x000D0x000A0x000D0x000AIn -ARCEvent- typical components requiring read locks are -ProcessController-, -ESController- and -UIController- while -ASController- requires first a read lock (for parsing) and then a write lock.0x000D0x000A0x000D0x000ANOTE: It is assumed that -DocLinks- can be accessed without locking0x000D0x000ANOTE: (see under -DocLinks- for details).
Lock/__TOCDet/Attribute/MethodName = Lock
Lock/__TOCDet/Attribute/MethodSignature = System.Threading.ReaderWriterLockSlim Lock
Storage/__TOCDet/Assembly = ARCAPI
Storage/__TOCDet/Description = The actual storage.0x000D0x000A0x000D0x000AThe root-pointer to all objects stored.
Storage/__TOCDet/DocFragType = ClassMember
Storage/__TOCDet/IsInherited = False
Storage/__TOCDet/IsInheritedDoc = False
Storage/__TOCDet/Lines = 3
Storage/__TOCDet/Name = Storage
Storage/__TOCDet/Namespace = ARCAPI
Storage/__TOCDet/Type = DataStorage
Storage/__TOCDet/Attribute/DeclaringType = DataStorage
Storage/__TOCDet/Attribute/Description = The actual storage.0x000D0x000A0x000D0x000AThe root-pointer to all objects stored.
Storage/__TOCDet/Attribute/MethodName = Storage
Storage/__TOCDet/Attribute/MethodSignature = ARCCore.IP Storage

Edit single sub keys only: __TOCDet / .ctor / ControllerStorage / Create / DocLinks / DoNotStoreInternally / ExternalReceiver / Lock / Storage

Generated 2024-06-28 20:38:37.143 UTC