PConcurrent

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 = A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-).0x000D0x000A0x000D0x000AWith 'somewhat' thread-safe we mean that thread-safety is only guaranteed for writing / reading key and value pairs directly stored within this class, not for writing / reading to objects further down in the hierarchical storage.0x000D0x000A0x000D0x000AUse this base class when you want to -ExposingApplicationState- throughout the -PropertyStream-.0x000D0x000A(in other words, use this class as a base class for all parts of your application that do some kind of processing.)0x000D0x000A0x000D0x000ABy setting the -Logger-, every call to -TrySetP- will be logged.0x000D0x000A0x000D0x000AIn addition the metods -Log- and -HandleException- get more meaningful, as they will actually distribute the information somewhere.0x000D0x000A0x000D0x000AThe practical consequence of this is that you do not have to write log-code like this:0x000D0x000A  var c = new Connection()0x000D0x000A  c.Id ="My connection"0x000D0x000A  log("Created new connection with id " + c.Id)0x000D0x000A0x000D0x000ASee also -ExposingApplicationState-.0x000D0x000ANote that more memory-hungry due to use of ConcurrentDictionary
__TOCDet/DocFragType = Class
__TOCDet/LongDescription = Note that this class is normally meaningless to use as base-class for data-objects like 'Customer', 'Order' or similar, because they are by their nature meant to be distributed over the -PropertyStream- anyway, so changes to them will 'automatically' be logged (that is, sent to the -PropertyStream-).0x000D0x000A0x000D0x000ASome inheriting classes in -ARCCore- are -StreamProcessor- and -ActualConnection-.
__TOCDet/Name = PConcurrent
__TOCDet/Namespace = ARCCore
__TOCDet/Type = PConcurrent
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/ClassNamespace = ARCCore
__TOCDet/Attribute/ClassType = PConcurrent
__TOCDet/Attribute/CorrespondingEnumType = PConcurrentP
__TOCDet/Attribute/Description = A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-).0x000D0x000A0x000D0x000AWith 'somewhat' thread-safe we mean that thread-safety is only guaranteed for writing / reading key and value pairs directly stored within this class, not for writing / reading to objects further down in the hierarchical storage.0x000D0x000A0x000D0x000AUse this base class when you want to -ExposingApplicationState- throughout the -PropertyStream-.0x000D0x000A(in other words, use this class as a base class for all parts of your application that do some kind of processing.)0x000D0x000A0x000D0x000ABy setting the -Logger-, every call to -TrySetP- will be logged.0x000D0x000A0x000D0x000AIn addition the metods -Log- and -HandleException- get more meaningful, as they will actually distribute the information somewhere.0x000D0x000A0x000D0x000AThe practical consequence of this is that you do not have to write log-code like this:0x000D0x000A  var c = new Connection()0x000D0x000A  c.Id ="My connection"0x000D0x000A  log("Created new connection with id " + c.Id)0x000D0x000A0x000D0x000ASee also -ExposingApplicationState-.0x000D0x000ANote that more memory-hungry due to use of ConcurrentDictionary
__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
__TOCDet/Attribute/InterfacesDirectlyImplemented = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
__TOCDet/Attribute/LongDescription = Note that this class is normally meaningless to use as base-class for data-objects like 'Customer', 'Order' or similar, because they are by their nature meant to be distributed over the -PropertyStream- anyway, so changes to them will 'automatically' be logged (that is, sent to the -PropertyStream-).0x000D0x000A0x000D0x000ASome inheriting classes in -ARCCore- are -StreamProcessor- and -ActualConnection-.
__TOCDet/Attribute/SubTypes = AddController0x003BBaseController0x003BEditController0x003BGQController0x003BRQController
ActualConnection/__TOCDet/Assembly = ARCCore
ActualConnection/__TOCDet/Description = The actual connection, its internal state, queue for sending and so on.0x000D0x000A
ActualConnection/__TOCDet/DocFragType = Class
ActualConnection/__TOCDet/LongDescription = TODO: May 2020: The code in this class should be tidied up a bit before any more functionality is added.0x000D0x000A0x000D0x000ANote how this class inherits -PConcurrent- which offers thread-safe access to properties (and is also able to -ExposingApplicationState- to outside).
ActualConnection/__TOCDet/Name = ActualConnection
ActualConnection/__TOCDet/Namespace = ARCCore
ActualConnection/__TOCDet/Type = ActualConnection
ActualConnection/__TOCDet/Attribute/AssemblyName = ARCCore
ActualConnection/__TOCDet/Attribute/BaseTypes = PConcurrent
ActualConnection/__TOCDet/Attribute/ClassNamespace = ARCCore
ActualConnection/__TOCDet/Attribute/ClassType = ActualConnection
ActualConnection/__TOCDet/Attribute/CorrespondingEnumType = ActualConnectionP
ActualConnection/__TOCDet/Attribute/Description = The actual connection, its internal state, queue for sending and so on.0x000D0x000A
ActualConnection/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
ActualConnection/__TOCDet/Attribute/LongDescription = TODO: May 2020: The code in this class should be tidied up a bit before any more functionality is added.0x000D0x000A0x000D0x000ANote how this class inherits -PConcurrent- which offers thread-safe access to properties (and is also able to -ExposingApplicationState- to outside).
BaseController/__TOCDet/Assembly = ARCAPI
BaseController/__TOCDet/Description = Contains basic functionality for serving API methods.0x000D0x000A0x000D0x000ARegarding -ExposingApplicationState-:0x000D0x000AThe specific controller instances serving requests are usually stored in a global -DataStorage- like 'app/0x007BnodeId0x007D/Controller/0x007BTypeOfController0x007D/0x007BControllerId0x007D...'.0x000D0x000A(in other words, -ControllerStorage- actually points to a branch inside -Storage-.)0x000D0x000A0x000D0x000AExamples of API requests and how they are resolved to a Controller by -CatchAll-:0x000D0x000AAPI request URL: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000AController instance (in this case of type -RQController-) to be found in controllerStorage0x005B"RQController"0x005D0x000D0x000AMethod -APIMethod- is called on this instance.0x000D0x000A0x000D0x000AThe following controller classes are included within -ARCAPI-:0x000D0x000A0x000D0x000A-RQController-:0x000D0x000AExecutes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000A-AddController-:0x000D0x000AParses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000A-GQController-:0x000D0x000AOffers GraphQL queries.0x000D0x000ANot implemented as of Feb 2022.0x000D0x000A0x000D0x000A-EditController-:0x000D0x000AOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000ANote how these controllers are sufficient for a basic CRUD API (Create, Read, Update, Delete).0x000D0x000A(Delete is done by using the metakey -Invalid-.)0x000D0x000A0x000D0x000AOften no additional -ApplicationSpecificCode- is needed.0x000D0x000A0x000D0x000A-ARCEvent- offers additional controllers of which the most important are -RSController- and -ESController- for operating against the -RegStream- and -EventStream- respectively.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for how -ApplicationSpecificCode- controllers are integrated.0x000D0x000A0x000D0x000AThis system has the following advantages:0x000D0x000A(Note: The concepts described below has shown little practical value as of Feb 2022).0x000D0x000A0x000D0x000A1) The API-routing syntax is by default exposed to the outside because the -ControllerStorage- is normally inserted into the global -DataStorage-.0x000D0x000ATherefore the standard query mechanism in AgoRapide can be used to get this information by querying like0x000D0x000A'RQ/log/0x005BnodeId0x005D/Controller'0x000D0x000A0x000D0x000A2) The API itself is discoverable even without querying like above, without much special code.0x000D0x000AThis is because an invalid API request is actually analyzed by the same mechanism answering standard queries.0x000D0x000AWhen the error message is returned it actually contains data about the correct syntax.0x000D0x000A0x000D0x000A3) The API is configurable both through the API itself and also over the -PropertyStream-.0x000D0x000AFor instance like 'Add/log/0x005BnodeId0x005D/Controller/RQ/~std/LogLevel = Warning' which would change the log level for the standard instance ('std') of -RQController- to 'Warning'.0x000D0x000A0x000D0x000A4) Different instances of the same controller type can exist and be configured individually.0x000D0x000AFor instance if some specific query needs additional logging down to debug level, a dedicated controller can be created for this and configured individually, like0x000D0x000A'Add/log/0x005BnodeId0x005D/Controller/RQController/~dbg/LogLevel = Debug'0x000D0x000A(Note: Such a debug controller is created by default by -BuildControllerStorage-).0x000D0x000A0x000D0x000ANOTE: Such specific controller instances can be used like 'RQ~dbg/...' instead of 'RQ/~dbg/...'. NOTE: This make inserted links more correct, for instance when -RQController- links to -EditController-0x000D0x000ANOTE: The reason for the somewhat special ~ prefix for the controller instance key is to avoid ambiguities NOTE: which are inherent because the complete hierarchical level has not been deemed necessary to specify explicitly.0x000D0x000A0x000D0x000ASome limitations of this approach are:0x000D0x000A1) Actual API method name is limited to the name of the controller type (without the 'Controller' part).0x000D0x000AThat is, a controller called CustomerController can only serve queries starting with 'Customer'.0x000D0x000A0x000D0x000ANote however that in your -ApplicationSpecificCode- you can implement any additional controllers with routing structure totally independent of this standard generic AgoRapide mechanism.0x000D0x000AIn other words, you can keep the AgoRapide mechanism for its standardised approach to data manipulation and add additional traditional controllers and methods as needed.0x000D0x000A0x000D0x000ANote how the -BaseController- classes (like this class) do not inherit any special Microsoft.AspNetCore.Mvc class. They are totally stand-alone with regard to Microsoft.AspNetCore.Mvc.0x000D0x000A0x000D0x000A
BaseController/__TOCDet/DocFragType = Class
BaseController/__TOCDet/Name = BaseController
BaseController/__TOCDet/Namespace = ARCAPI
BaseController/__TOCDet/Type = BaseController
BaseController/__TOCDet/Attribute/AssemblyName = ARCAPI
BaseController/__TOCDet/Attribute/BaseTypes = PConcurrent
BaseController/__TOCDet/Attribute/ClassNamespace = ARCAPI
BaseController/__TOCDet/Attribute/ClassType = BaseController
BaseController/__TOCDet/Attribute/CorrespondingEnumType = BaseControllerP
BaseController/__TOCDet/Attribute/Description = Contains basic functionality for serving API methods.0x000D0x000A0x000D0x000ARegarding -ExposingApplicationState-:0x000D0x000AThe specific controller instances serving requests are usually stored in a global -DataStorage- like 'app/0x007BnodeId0x007D/Controller/0x007BTypeOfController0x007D/0x007BControllerId0x007D...'.0x000D0x000A(in other words, -ControllerStorage- actually points to a branch inside -Storage-.)0x000D0x000A0x000D0x000AExamples of API requests and how they are resolved to a Controller by -CatchAll-:0x000D0x000AAPI request URL: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000AController instance (in this case of type -RQController-) to be found in controllerStorage0x005B"RQController"0x005D0x000D0x000AMethod -APIMethod- is called on this instance.0x000D0x000A0x000D0x000AThe following controller classes are included within -ARCAPI-:0x000D0x000A0x000D0x000A-RQController-:0x000D0x000AExecutes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000A-AddController-:0x000D0x000AParses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000A-GQController-:0x000D0x000AOffers GraphQL queries.0x000D0x000ANot implemented as of Feb 2022.0x000D0x000A0x000D0x000A-EditController-:0x000D0x000AOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000ANote how these controllers are sufficient for a basic CRUD API (Create, Read, Update, Delete).0x000D0x000A(Delete is done by using the metakey -Invalid-.)0x000D0x000A0x000D0x000AOften no additional -ApplicationSpecificCode- is needed.0x000D0x000A0x000D0x000A-ARCEvent- offers additional controllers of which the most important are -RSController- and -ESController- for operating against the -RegStream- and -EventStream- respectively.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for how -ApplicationSpecificCode- controllers are integrated.0x000D0x000A0x000D0x000AThis system has the following advantages:0x000D0x000A(Note: The concepts described below has shown little practical value as of Feb 2022).0x000D0x000A0x000D0x000A1) The API-routing syntax is by default exposed to the outside because the -ControllerStorage- is normally inserted into the global -DataStorage-.0x000D0x000ATherefore the standard query mechanism in AgoRapide can be used to get this information by querying like0x000D0x000A'RQ/log/0x005BnodeId0x005D/Controller'0x000D0x000A0x000D0x000A2) The API itself is discoverable even without querying like above, without much special code.0x000D0x000AThis is because an invalid API request is actually analyzed by the same mechanism answering standard queries.0x000D0x000AWhen the error message is returned it actually contains data about the correct syntax.0x000D0x000A0x000D0x000A3) The API is configurable both through the API itself and also over the -PropertyStream-.0x000D0x000AFor instance like 'Add/log/0x005BnodeId0x005D/Controller/RQ/~std/LogLevel = Warning' which would change the log level for the standard instance ('std') of -RQController- to 'Warning'.0x000D0x000A0x000D0x000A4) Different instances of the same controller type can exist and be configured individually.0x000D0x000AFor instance if some specific query needs additional logging down to debug level, a dedicated controller can be created for this and configured individually, like0x000D0x000A'Add/log/0x005BnodeId0x005D/Controller/RQController/~dbg/LogLevel = Debug'0x000D0x000A(Note: Such a debug controller is created by default by -BuildControllerStorage-).0x000D0x000A0x000D0x000ANOTE: Such specific controller instances can be used like 'RQ~dbg/...' instead of 'RQ/~dbg/...'. NOTE: This make inserted links more correct, for instance when -RQController- links to -EditController-0x000D0x000ANOTE: The reason for the somewhat special ~ prefix for the controller instance key is to avoid ambiguities NOTE: which are inherent because the complete hierarchical level has not been deemed necessary to specify explicitly.0x000D0x000A0x000D0x000ASome limitations of this approach are:0x000D0x000A1) Actual API method name is limited to the name of the controller type (without the 'Controller' part).0x000D0x000AThat is, a controller called CustomerController can only serve queries starting with 'Customer'.0x000D0x000A0x000D0x000ANote however that in your -ApplicationSpecificCode- you can implement any additional controllers with routing structure totally independent of this standard generic AgoRapide mechanism.0x000D0x000AIn other words, you can keep the AgoRapide mechanism for its standardised approach to data manipulation and add additional traditional controllers and methods as needed.0x000D0x000A0x000D0x000ANote how the -BaseController- classes (like this class) do not inherit any special Microsoft.AspNetCore.Mvc class. They are totally stand-alone with regard to Microsoft.AspNetCore.Mvc.0x000D0x000A0x000D0x000A
BaseController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
BaseController/__TOCDet/Attribute/SubTypes = AddController0x003BEditController0x003BGQController0x003BRQController
BaseController/AddController/__TOCDet/Assembly = ARCAPI
BaseController/AddController/__TOCDet/Description = Parses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000ASends to -ExternalReceiver- if given.0x000D0x000AAdds to the given -DataStorage- unless -DoNotStoreInternally- is specified.0x000D0x000A0x000D0x000ABulk addition of data:0x000D0x000AIf HTTP POST is used and the parameter postData is given, then it will be treated as a collection of -PropertyStreamLine-s, to which the original request will be prepended for every line.0x000D0x000AExample:0x000D0x000AIf request is 'Add/Customer/42' and postData is the following two lines0x000D0x000A  FirstName = John0x000D0x000A  LastName = Smith0x000D0x000Athen it will be treated as two separate requests like0x000D0x000A  Add/Customer/42/FirstName = John0x000D0x000A  Add/Customer/42/LastName = Smith0x000D0x000A0x000D0x000ATODO: Support use of Query for adding values to multiple entities at once.0x000D0x000ATODO: like 'Add/Customer/WHERE FirstName = John/NameEvaluation = NiceName'0x000D0x000A0x000D0x000AHint: You can test input validation by using the inbuilt classes of -ARCDoc-.0x000D0x000A(assuming that the Apple and Orange classes are included in -AllIPDerivedTypes-.)0x000D0x000AExample queries:0x000D0x000Aapi/Add/Apple/1/Colour = Red   // Should succeed0x000D0x000Aapi/Add/Apple/1/Colour = Redd  // Should fail0x000D0x000Aapi/Add/Apple/1/Color = Red    // Does not fail since Apple class accepts any property (it inherits -PRich-).0x000D0x000Aapi/Add/Orange/1/Color = Red    // Sould fail since Orange accepts only Colour and Name (it inherits -PExact-).0x000D0x000A
BaseController/AddController/__TOCDet/DocFragType = Class
BaseController/AddController/__TOCDet/Name = AddController
BaseController/AddController/__TOCDet/Namespace = ARCAPI
BaseController/AddController/__TOCDet/Type = AddController
BaseController/AddController/__TOCDet/Attribute/AssemblyName = ARCAPI
BaseController/AddController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
BaseController/AddController/__TOCDet/Attribute/ClassNamespace = ARCAPI
BaseController/AddController/__TOCDet/Attribute/ClassType = AddController
BaseController/AddController/__TOCDet/Attribute/Description = Parses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000ASends to -ExternalReceiver- if given.0x000D0x000AAdds to the given -DataStorage- unless -DoNotStoreInternally- is specified.0x000D0x000A0x000D0x000ABulk addition of data:0x000D0x000AIf HTTP POST is used and the parameter postData is given, then it will be treated as a collection of -PropertyStreamLine-s, to which the original request will be prepended for every line.0x000D0x000AExample:0x000D0x000AIf request is 'Add/Customer/42' and postData is the following two lines0x000D0x000A  FirstName = John0x000D0x000A  LastName = Smith0x000D0x000Athen it will be treated as two separate requests like0x000D0x000A  Add/Customer/42/FirstName = John0x000D0x000A  Add/Customer/42/LastName = Smith0x000D0x000A0x000D0x000ATODO: Support use of Query for adding values to multiple entities at once.0x000D0x000ATODO: like 'Add/Customer/WHERE FirstName = John/NameEvaluation = NiceName'0x000D0x000A0x000D0x000AHint: You can test input validation by using the inbuilt classes of -ARCDoc-.0x000D0x000A(assuming that the Apple and Orange classes are included in -AllIPDerivedTypes-.)0x000D0x000AExample queries:0x000D0x000Aapi/Add/Apple/1/Colour = Red   // Should succeed0x000D0x000Aapi/Add/Apple/1/Colour = Redd  // Should fail0x000D0x000Aapi/Add/Apple/1/Color = Red    // Does not fail since Apple class accepts any property (it inherits -PRich-).0x000D0x000Aapi/Add/Orange/1/Color = Red    // Sould fail since Orange accepts only Colour and Name (it inherits -PExact-).0x000D0x000A
BaseController/AddController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
BaseController/EditController/__TOCDet/Assembly = ARCAPI
BaseController/EditController/__TOCDet/Description = Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000AThe HTML form offered will POST directly to -AddController- with the postData-parameter set.0x000D0x000A0x000D0x000ATODO: Note that -JSON- is currently not supported.0x000D0x000ATODO: It might appear to be irrelevant, but it could contain the basic elements for building an HTML editing environment,0x000D0x000ATODO: enabling to client to construct its own HTML page.
BaseController/EditController/__TOCDet/DocFragType = Class
BaseController/EditController/__TOCDet/Name = EditController
BaseController/EditController/__TOCDet/Namespace = ARCAPI
BaseController/EditController/__TOCDet/Type = EditController
BaseController/EditController/__TOCDet/Attribute/AssemblyName = ARCAPI
BaseController/EditController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
BaseController/EditController/__TOCDet/Attribute/ClassNamespace = ARCAPI
BaseController/EditController/__TOCDet/Attribute/ClassType = EditController
BaseController/EditController/__TOCDet/Attribute/Description = Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000AThe HTML form offered will POST directly to -AddController- with the postData-parameter set.0x000D0x000A0x000D0x000ATODO: Note that -JSON- is currently not supported.0x000D0x000ATODO: It might appear to be irrelevant, but it could contain the basic elements for building an HTML editing environment,0x000D0x000ATODO: enabling to client to construct its own HTML page.
BaseController/EditController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
BaseController/GQController/__TOCDet/Assembly = ARCAPI
BaseController/GQController/__TOCDet/Description = Offers GraphQL queries.0x000D0x000A0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A
BaseController/GQController/__TOCDet/DocFragType = Class
BaseController/GQController/__TOCDet/Name = GQController
BaseController/GQController/__TOCDet/Namespace = ARCAPI
BaseController/GQController/__TOCDet/Type = GQController
BaseController/GQController/__TOCDet/Attribute/AssemblyName = ARCAPI
BaseController/GQController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
BaseController/GQController/__TOCDet/Attribute/ClassNamespace = ARCAPI
BaseController/GQController/__TOCDet/Attribute/ClassType = GQController
BaseController/GQController/__TOCDet/Attribute/Description = Offers GraphQL queries.0x000D0x000A0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A
BaseController/GQController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
BaseController/RQController/__TOCDet/Assembly = ARCAPI
BaseController/RQController/__TOCDet/Description = RQ = REST Query. Executes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000AThis class understands two main query-methods, 0x000D0x000A1) Direct key-based into data storage, and0x000D0x000A0x000D0x000A2) -QueryExpression- based.0x000D0x000A0x000D0x000AExamples of 1) Direct key-based into data storage queries:0x000D0x000A'Customer/42' =0x003E Get all the keys for Customer with id 42, but do not get sub-keys.0x000D0x000A'Customer/42/*' =0x003E Get all the keys for Customer with id 42, and also all underlying sub-keys (and their sub-keys and so on).0x000D0x000AAppend query with '.json' in order to get -JSON- (default is -HTML-) .0x000D0x000AFor -HTML- this controller is able to do -LinkInsertionInDocumentation-, presumed that -DocLinks- is set.0x000D0x000A0x000D0x000AExamples of 2) -QueryExpression- based queries.0x000D0x000A'Customer/WHERE FirstName = John/SELECT FirstName, LastName/SKIP 10/TAKE 10'0x000D0x000A(see -QueryExpression- for more examples).0x000D0x000A0x000D0x000A
BaseController/RQController/__TOCDet/DocFragType = Class
BaseController/RQController/__TOCDet/Name = RQController
BaseController/RQController/__TOCDet/Namespace = ARCAPI
BaseController/RQController/__TOCDet/Type = RQController
BaseController/RQController/__TOCDet/Attribute/AssemblyName = ARCAPI
BaseController/RQController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
BaseController/RQController/__TOCDet/Attribute/ClassNamespace = ARCAPI
BaseController/RQController/__TOCDet/Attribute/ClassType = RQController
BaseController/RQController/__TOCDet/Attribute/Description = RQ = REST Query. Executes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000AThis class understands two main query-methods, 0x000D0x000A1) Direct key-based into data storage, and0x000D0x000A0x000D0x000A2) -QueryExpression- based.0x000D0x000A0x000D0x000AExamples of 1) Direct key-based into data storage queries:0x000D0x000A'Customer/42' =0x003E Get all the keys for Customer with id 42, but do not get sub-keys.0x000D0x000A'Customer/42/*' =0x003E Get all the keys for Customer with id 42, and also all underlying sub-keys (and their sub-keys and so on).0x000D0x000AAppend query with '.json' in order to get -JSON- (default is -HTML-) .0x000D0x000AFor -HTML- this controller is able to do -LinkInsertionInDocumentation-, presumed that -DocLinks- is set.0x000D0x000A0x000D0x000AExamples of 2) -QueryExpression- based queries.0x000D0x000A'Customer/WHERE FirstName = John/SELECT FirstName, LastName/SKIP 10/TAKE 10'0x000D0x000A(see -QueryExpression- for more examples).0x000D0x000A0x000D0x000A
BaseController/RQController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
QueryProgress/__TOCDet/Assembly = ARCQuery
QueryProgress/__TOCDet/Description = Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.0x000D0x000A0x000D0x000AContains a special version of -ToHTMLSimpleSingle- which is necessary in order to present the final result because a query result:0x000D0x000A1) Is a uniform collection (of identical type), and0x000D0x000A2) Has a 'location' URL-wise that is very difficult to generate relative links for.0x000D0x000ATherefore, the standard -ToHTMLSimpleSingle- method is not very well suited.0x000D0x000A0x000D0x000ARecognized for instance by -RQController- in -ARAAPI-.0x000D0x000A0x000D0x000A
QueryProgress/__TOCDet/DocFragType = Class
QueryProgress/__TOCDet/Name = QueryProgress
QueryProgress/__TOCDet/Namespace = ARCQuery
QueryProgress/__TOCDet/Type = QueryProgress
QueryProgress/__TOCDet/Attribute/AssemblyName = ARCQuery
QueryProgress/__TOCDet/Attribute/BaseTypes = PConcurrent
QueryProgress/__TOCDet/Attribute/ClassNamespace = ARCQuery
QueryProgress/__TOCDet/Attribute/ClassType = QueryProgress
QueryProgress/__TOCDet/Attribute/CorrespondingEnumType = QueryProgressP
QueryProgress/__TOCDet/Attribute/Description = Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.0x000D0x000A0x000D0x000AContains a special version of -ToHTMLSimpleSingle- which is necessary in order to present the final result because a query result:0x000D0x000A1) Is a uniform collection (of identical type), and0x000D0x000A2) Has a 'location' URL-wise that is very difficult to generate relative links for.0x000D0x000ATherefore, the standard -ToHTMLSimpleSingle- method is not very well suited.0x000D0x000A0x000D0x000ARecognized for instance by -RQController- in -ARAAPI-.0x000D0x000A0x000D0x000A
QueryProgress/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
SomeAppComponent/__TOCDet/Assembly = ARCDoc
SomeAppComponent/__TOCDet/Description = Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.0x000D0x000AThe goal is -ExposingApplicationState-.
SomeAppComponent/__TOCDet/DocFragType = Class
SomeAppComponent/__TOCDet/Name = SomeAppComponent
SomeAppComponent/__TOCDet/Namespace = ARCDoc
SomeAppComponent/__TOCDet/Type = SomeAppComponent
SomeAppComponent/__TOCDet/Attribute/AssemblyName = ARCDoc
SomeAppComponent/__TOCDet/Attribute/BaseTypes = PConcurrent
SomeAppComponent/__TOCDet/Attribute/ClassNamespace = ARCDoc
SomeAppComponent/__TOCDet/Attribute/ClassType = SomeAppComponent
SomeAppComponent/__TOCDet/Attribute/CorrespondingEnumType = SomeAppComponentP
SomeAppComponent/__TOCDet/Attribute/Description = Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.0x000D0x000AThe goal is -ExposingApplicationState-.
SomeAppComponent/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
StreamProcessor/__TOCDet/Assembly = ARCCore
StreamProcessor/__TOCDet/Description = Implements the storage mechanism for AgoRapide.0x000D0x000A0x000D0x000ACoordinates the -PropertyStream- with other nodes.0x000D0x000A0x000D0x000ATODO: Implement discarding of data when not listening to incoming connections (saves memory usage).0x000D0x000ATODO: (search for this TODO in code to see where relevant to make changes).0x000D0x000A0x000D0x000AHas the following functionality:0x000D0x000A(note: Terminology is kept close to the one used for the MQTT protcol, although AgoRapide does not use MQTT in itself)0x000D0x000A0x000D0x000A1) Listen to incoming TCP/IP connections from other nodes. An incoming connections may be either for:0x000D0x000A   a) Incoming data (from a publishing client), for us to distribute.0x000D0x000A      (0x000D0x000A         as a -CoreDB- we would then store the data locally and          then distribute the data to all current downstream subscriber clients as relevant according to their respective subscriptions          (Note: For incoming data on an incoming connection an implicit -IsAll-, '+*', is assumed),          as a -ArmDB- we would then forward the data to a -CoreDB-      )0x000D0x000A      or for0x000D0x000A   b) Outgoing data, downstream subscribing client requests subscription0x000D0x000A      (0x000D0x000A        we would then typically be a -CoreDB- or a -ArmDB-.0x000D0x000A        After having reveived the -Subscription- and -ClientUpdatePosition-0x000D0x000A        from the subscribing client we will then keep the client continously up-to-date with new data.0x000D0x000A      ).0x000D0x000A0x000D0x000A2) Connect to other nodes. An outgoing connection may be either for0x000D0x000A   a) Publishing properties.       (         As a publishing -Client- the data would be locally in-application generated properties.0x000D0x000A         As an -ArmDB- the data would typically have been received over an incoming connection from a -Client-      )0x000D0x000A      or for0x000D0x000A   b) Receiving (as downstream subscribing client) data from upstream server.0x000D0x000A      (0x000D0x000A        We would then typically be an -ArmDB- or -Client-0x000D0x000A        We would send -Subscription- and -ClientUpdatePosition- as soon as connection is established.0x000D0x000A      )0x000D0x000A0x000D0x000A
StreamProcessor/__TOCDet/DocFragType = Class
StreamProcessor/__TOCDet/LongDescription = TODO: May 2020: The code in this class should be tidied up a bit before any more functionality is added.0x000D0x000A0x000D0x000ANote that the examples above do not take into scenarios like load-balancing and fault tolerance where -CoreDB- would be connecting among themselves.0x000D0x000A0x000D0x000ANote that information about outgoing connection and their purpose should be possible to distribute over the -PropertyStream-, therefore we have implemented the class -ActualConnection- (distribution itself not implemented as of Mar 2020).0x000D0x000A0x000D0x000ANote: A vision for AgoRapide is that load-balancing / fault tolerance and similar should be mostly a configuration issue around already in-built functionality in -ARCCore- / -StreamProcessor-. In other words the core functionality should provide a language which is suffiently rich in order for you to describe these different setups, there should be no need for additional C# code.0x000D0x000A0x000D0x000ANote how this class inherits -PConcurrent- which offers thread-safe access to properties (and is also able to -ExposingApplicationState- to outside).
StreamProcessor/__TOCDet/Name = StreamProcessor
StreamProcessor/__TOCDet/Namespace = ARCCore
StreamProcessor/__TOCDet/Type = StreamProcessor
StreamProcessor/__TOCDet/Attribute/AssemblyName = ARCCore
StreamProcessor/__TOCDet/Attribute/BaseTypes = PConcurrent
StreamProcessor/__TOCDet/Attribute/ClassNamespace = ARCCore
StreamProcessor/__TOCDet/Attribute/ClassType = StreamProcessor
StreamProcessor/__TOCDet/Attribute/CorrespondingEnumType = StreamProcessorP
StreamProcessor/__TOCDet/Attribute/Description = Implements the storage mechanism for AgoRapide.0x000D0x000A0x000D0x000ACoordinates the -PropertyStream- with other nodes.0x000D0x000A0x000D0x000ATODO: Implement discarding of data when not listening to incoming connections (saves memory usage).0x000D0x000ATODO: (search for this TODO in code to see where relevant to make changes).0x000D0x000A0x000D0x000AHas the following functionality:0x000D0x000A(note: Terminology is kept close to the one used for the MQTT protcol, although AgoRapide does not use MQTT in itself)0x000D0x000A0x000D0x000A1) Listen to incoming TCP/IP connections from other nodes. An incoming connections may be either for:0x000D0x000A   a) Incoming data (from a publishing client), for us to distribute.0x000D0x000A      (0x000D0x000A         as a -CoreDB- we would then store the data locally and          then distribute the data to all current downstream subscriber clients as relevant according to their respective subscriptions          (Note: For incoming data on an incoming connection an implicit -IsAll-, '+*', is assumed),          as a -ArmDB- we would then forward the data to a -CoreDB-      )0x000D0x000A      or for0x000D0x000A   b) Outgoing data, downstream subscribing client requests subscription0x000D0x000A      (0x000D0x000A        we would then typically be a -CoreDB- or a -ArmDB-.0x000D0x000A        After having reveived the -Subscription- and -ClientUpdatePosition-0x000D0x000A        from the subscribing client we will then keep the client continously up-to-date with new data.0x000D0x000A      ).0x000D0x000A0x000D0x000A2) Connect to other nodes. An outgoing connection may be either for0x000D0x000A   a) Publishing properties.       (         As a publishing -Client- the data would be locally in-application generated properties.0x000D0x000A         As an -ArmDB- the data would typically have been received over an incoming connection from a -Client-      )0x000D0x000A      or for0x000D0x000A   b) Receiving (as downstream subscribing client) data from upstream server.0x000D0x000A      (0x000D0x000A        We would then typically be an -ArmDB- or -Client-0x000D0x000A        We would send -Subscription- and -ClientUpdatePosition- as soon as connection is established.0x000D0x000A      )0x000D0x000A0x000D0x000A
StreamProcessor/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable0x003BIDisposable
StreamProcessor/__TOCDet/Attribute/InterfacesDirectlyImplemented = IDisposable
StreamProcessor/__TOCDet/Attribute/LongDescription = TODO: May 2020: The code in this class should be tidied up a bit before any more functionality is added.0x000D0x000A0x000D0x000ANote that the examples above do not take into scenarios like load-balancing and fault tolerance where -CoreDB- would be connecting among themselves.0x000D0x000A0x000D0x000ANote that information about outgoing connection and their purpose should be possible to distribute over the -PropertyStream-, therefore we have implemented the class -ActualConnection- (distribution itself not implemented as of Mar 2020).0x000D0x000A0x000D0x000ANote: A vision for AgoRapide is that load-balancing / fault tolerance and similar should be mostly a configuration issue around already in-built functionality in -ARCCore- / -StreamProcessor-. In other words the core functionality should provide a language which is suffiently rich in order for you to describe these different setups, there should be no need for additional C# code.0x000D0x000A0x000D0x000ANote how this class inherits -PConcurrent- which offers thread-safe access to properties (and is also able to -ExposingApplicationState- to outside).
Translations/__TOCDet/Assembly = ARCQuery
Translations/__TOCDet/Description = Offers a very simple system for keeping track of translation between different ("western") languages.0x000D0x000A0x000D0x000A(this class has, as of Jan 2022, not been tested for other languages than those using an alphabet similar to the Latin alphabet with left to right direction.)0x000D0x000A0x000D0x000AVarious approaches to storing translations are:0x000D0x000A0x000D0x000AApproach 1: Storing translations in the classic -PropertyStream-:0x000D0x000ARecommended prefix is -t-, translations can then be added like this:0x000D0x000A  t/de_DE/_Car = Wagen0x000D0x000A  t/fr_FR/_Car = Auto0x000D0x000A  t/nb_NO/_Car = Bil0x000D0x000ASee -TryGetPS- (but note that it offers a slightly different format).0x000D0x000A0x000D0x000AApproach 2: Storing translation strings directly within C# source code.0x000D0x000AFor instance a class called "Translations_de_DE.cs" could have an adder method "a" working like this:0x000D0x000A  a("Car","Wagen")0x003B0x000D0x000A  a("Bicycle","Fahrrad")0x003B0x000D0x000A(the adder method is then supposed to populate this class).0x000D0x000ASee -TryGetA-0x000D0x000A0x000D0x000AApproach 3: Storing translations as -MacroType-.-Translation-.0x000D0x000A(requires use of -ARCEvent-)0x000D0x000AThis approach makes it possible to choose translation on-the-fly at time of development.0x000D0x000ASee -TryGetMacro-0x000D0x000A0x000D0x000AFor all three approaches, this class can be put into the global data storage,with prefix -t-, making translations available to API clients through ordinary queries.0x000D0x000A0x000D0x000AIn all cases, this class will add untranslated keys (assumed that they start with an underscore ('_'), with -TranslationSingleP-.-Text- set to key (minus the underscore) and -IsMissing- set to TRUE.0x000D0x000A0x000D0x000AThis is accomplished through override of method -TryGetP-.0x000D0x000A0x000D0x000AThese "IsMissing" translations can then be queried, and added either to the property stream or C# source code as suggested above.0x000D0x000A0x000D0x000AThat is, translation keys should always start with an underscore ('_').0x000D0x000AThis makes it possible to use -ARCQuery- against this class, because keys not starting with an underscore can then be attempted parsed as a query like 'All', 'SELECT *' or similar.0x000D0x000A0x000D0x000ANote that if you are using -ARCEvent- with exhaustive unit testing, that is, with all possible translation keys being excercised, then this class can be queried afterwards for any missing translations.0x000D0x000A0x000D0x000AKeeping everything in-memory / in C# code has the advantage of not polluting any database with random translation keys that come and go if code is frequently changed. This is because new keys are ephemeral (the exist only within application lifetime).0x000D0x000AYou then implementing new translation keys only when you know that you have a stabile software configuration, that is, only when you know that the keys that you have are actually permanent.0x000D0x000A0x000D0x000AAlso, you can at any time (assumed exhaustive unit testing) query this class for currently in use translation keys, with their translation, and paste that direct into the C# code (replacing the existing code), thereby removing unused keys from the C# code.0x000D0x000A0x000D0x000ANote how inherits -PConcurrent- in order to work in a multi-threaded context.0x000D0x000A0x000D0x000ANote regarding choice of which AgoRapide library to put this class into:0x000D0x000AAt time of development, no clear natural home was found for this class.0x000D0x000AIt was first put into -ARCDoc-, then -ARCQuery- because it used -QueryExpression-.-TryParse-.0x000D0x000AIt no longer uses QueryExpression.TryParse, but since it does use the concept of -EntityMethodKey-, moving back again to ARCDoc looks unnatural (but is quite possible).0x000D0x000ANote that this class also refers to ARCEvent in the comments.0x000D0x000A0x000D0x000ASee also -TranslationsP-.0x000D0x000A
Translations/__TOCDet/DocFragType = Class
Translations/__TOCDet/Name = Translations
Translations/__TOCDet/Namespace = ARCQuery
Translations/__TOCDet/Type = Translations
Translations/__TOCDet/Attribute/AssemblyName = ARCQuery
Translations/__TOCDet/Attribute/BaseTypes = PConcurrent
Translations/__TOCDet/Attribute/ClassNamespace = ARCQuery
Translations/__TOCDet/Attribute/ClassType = Translations
Translations/__TOCDet/Attribute/Description = Offers a very simple system for keeping track of translation between different ("western") languages.0x000D0x000A0x000D0x000A(this class has, as of Jan 2022, not been tested for other languages than those using an alphabet similar to the Latin alphabet with left to right direction.)0x000D0x000A0x000D0x000AVarious approaches to storing translations are:0x000D0x000A0x000D0x000AApproach 1: Storing translations in the classic -PropertyStream-:0x000D0x000ARecommended prefix is -t-, translations can then be added like this:0x000D0x000A  t/de_DE/_Car = Wagen0x000D0x000A  t/fr_FR/_Car = Auto0x000D0x000A  t/nb_NO/_Car = Bil0x000D0x000ASee -TryGetPS- (but note that it offers a slightly different format).0x000D0x000A0x000D0x000AApproach 2: Storing translation strings directly within C# source code.0x000D0x000AFor instance a class called "Translations_de_DE.cs" could have an adder method "a" working like this:0x000D0x000A  a("Car","Wagen")0x003B0x000D0x000A  a("Bicycle","Fahrrad")0x003B0x000D0x000A(the adder method is then supposed to populate this class).0x000D0x000ASee -TryGetA-0x000D0x000A0x000D0x000AApproach 3: Storing translations as -MacroType-.-Translation-.0x000D0x000A(requires use of -ARCEvent-)0x000D0x000AThis approach makes it possible to choose translation on-the-fly at time of development.0x000D0x000ASee -TryGetMacro-0x000D0x000A0x000D0x000AFor all three approaches, this class can be put into the global data storage,with prefix -t-, making translations available to API clients through ordinary queries.0x000D0x000A0x000D0x000AIn all cases, this class will add untranslated keys (assumed that they start with an underscore ('_'), with -TranslationSingleP-.-Text- set to key (minus the underscore) and -IsMissing- set to TRUE.0x000D0x000A0x000D0x000AThis is accomplished through override of method -TryGetP-.0x000D0x000A0x000D0x000AThese "IsMissing" translations can then be queried, and added either to the property stream or C# source code as suggested above.0x000D0x000A0x000D0x000AThat is, translation keys should always start with an underscore ('_').0x000D0x000AThis makes it possible to use -ARCQuery- against this class, because keys not starting with an underscore can then be attempted parsed as a query like 'All', 'SELECT *' or similar.0x000D0x000A0x000D0x000ANote that if you are using -ARCEvent- with exhaustive unit testing, that is, with all possible translation keys being excercised, then this class can be queried afterwards for any missing translations.0x000D0x000A0x000D0x000AKeeping everything in-memory / in C# code has the advantage of not polluting any database with random translation keys that come and go if code is frequently changed. This is because new keys are ephemeral (the exist only within application lifetime).0x000D0x000AYou then implementing new translation keys only when you know that you have a stabile software configuration, that is, only when you know that the keys that you have are actually permanent.0x000D0x000A0x000D0x000AAlso, you can at any time (assumed exhaustive unit testing) query this class for currently in use translation keys, with their translation, and paste that direct into the C# code (replacing the existing code), thereby removing unused keys from the C# code.0x000D0x000A0x000D0x000ANote how inherits -PConcurrent- in order to work in a multi-threaded context.0x000D0x000A0x000D0x000ANote regarding choice of which AgoRapide library to put this class into:0x000D0x000AAt time of development, no clear natural home was found for this class.0x000D0x000AIt was first put into -ARCDoc-, then -ARCQuery- because it used -QueryExpression-.-TryParse-.0x000D0x000AIt no longer uses QueryExpression.TryParse, but since it does use the concept of -EntityMethodKey-, moving back again to ARCDoc looks unnatural (but is quite possible).0x000D0x000ANote that this class also refers to ARCEvent in the comments.0x000D0x000A0x000D0x000ASee also -TranslationsP-.0x000D0x000A
Translations/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable

Edit single sub keys only: __TOCDet / ActualConnection / BaseController / QueryProgress / SomeAppComponent / StreamProcessor / Translations

Generated 2025-07-28 02:02:53.749 UTC