[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 398 > < TAKE 124 >
124 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.ARComponents.ARCCore | ARCCore | EnumMember | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. |
| ARCCore.ARComponents.ARADB | ARCCore | EnumMember | An application constituting the full functionality of a -CoreDB- (linking to -ARCCore-). |
| ARCCore.ARComponents.ARAClient | ARCCore | EnumMember | A template application for a -Client- (linking to -ARCCore-). |
| ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages | ARCCore | EnumMember | The abstraction level in AgoRapide is very high. |
| ARCCore.ARConcepts.ExposingApplicationState | ARCCore | EnumMember | The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool. |
| ARCCore.ARConcepts.LinkInsertionInDocumentation | ARCCore | EnumMember | Documentation with links is much easier to read. |
| ARCCore.ARConcepts.TryPatternAndNull | ARCCore | EnumMember | AgoRapide uses non-nullable reference types as default throughout the system |
| ARCCore.AREnumType | ARCCore | Enum | Categories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-. |
| ARCCore.AREnumType.PropertyKeyEnum | |||
| ARCCore.AREnumType.OrdinaryEnum | ARCCore | EnumMember | Designates "Ordinary" enums used for indicating range of valid values for a given key |
| ARCCore.AREnumType.DocumentationOnlyEnum | ARCCore | EnumMember | Designates enums that provide a central repository of explanation of terms that are not present in the C# code. |
| ARCCore.ARNodeType | ARCCore | Enum | Describes what function a node in an AgoRapide system serves. A given node may constitute of only -StandardAgoRapideCode- or a combination of -StandardAgoRapideCode- and -ApplicationSpecificCode-. |
| ARCCore.ARNodeType.CoreDB | ARCCore | EnumMember | A node containing the core or central database. |
| ARCCore.ARNodeType.ArmDB | ARCCore | EnumMember | A node with a 'client -Subscription-' towards -CoreDB- to a (usually) subset of the entire database (acting as a cache and filtering mechanism), or with a 'client -Subscription-' towards -CoreDB- to the whole database (acting as a cache mechanism only) |
| ARCCore.ARNodeType.Client | ARCCore | EnumMember | An outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-. |
| ARCCore.Cardinality | ARCCore | Enum | Describes how multiple instances of a property is supposed to be handled. |
| ARCCore.Cardinality.HistoryOnly | ARCCore | EnumMember | The default value. |
| ARCCore.Cardinality.WholeCollection | ARCCore | EnumMember | Values are always set as a whole (there is no need or no meaning in setting or deleting individual items) |
| ARCCore.Cardinality.IndividualItems | ARCCore | EnumMember | Values are supposed to be set and 'deleted' individually. |
| ARCCore.PKLogAttributeP.DoNotLogAtAll | ARCCore | EnumMember | Originates from -DoNotLogAtAll-. |
| ARCCore.PKLogAttributeP.CountInterval | ARCCore | EnumMember | For a value of n, log only every n'th time the property is changed. |
| ARCCore.PKLogAttributeP.TimeInterval | ARCCore | EnumMember | Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-. |
| ARCCore.PKRelAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.PKRelAttributeP.ForeignEntity | ARCCore | EnumMember | The type of foreign entity that this property points to. |
| ARCCore.PKRelAttributeP.EnforceReferentialIntegrity | ARCCore | EnumMember | If TRUE then referential integrity will be enforced by -TryStore-. |
| ARCCore.PKTypeAttributeP | ARCCore | Enum | Describes class -PKTypeAttribute-. |
| ARCCore.PKTypeAttributeP.Type | ARCCore | EnumMember | The type of this Property. |
| ARCCore.ActualConnectionP.Id | ARCCore | EnumMember | When connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection. |
| ARCCore.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
| ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
| ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
| ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
| ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
| ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
| ARCCore.StreamProcessorP.IncomingConnectionsPortNo | ARCCore | EnumMember | If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-). |
| ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
| ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
| ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
| ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
| ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
| ARCCore.StreamProcessorP.DoNotStoreLocally | ARCCore | EnumMember | For -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-. |
| ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
| ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
| ARCCore.StorageFileP.Hash | ARCCore | EnumMember | Hash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCCore.DataTransferDirection.Send | ARCCore | EnumMember | Like -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-. |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCCore.ARComponents.ARCDoc | ARCCore | EnumMember | A library supporting documentation and demonstrating usage of AgoRapide. |
| ARCCore.ARComponents.ARCQuery | ARCCore | EnumMember | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. |
| ARCCore.ARComponents.ARCSync | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.ARComponents.ARCSec | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.ARComponents.ARCAPI | ARCCore | EnumMember | A library providing an API on top of the -PropertyStream-. |
| ARCCore.ARComponents.ARAAPI | ARCCore | EnumMember | The corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc. |
| ARCCore.ARConcepts | ARCCore | Enum | The overarching concepts upon which AgoRapide is built. |
| ARCCore.ARConcepts.GettingStarted | ARCCore | EnumMember | AgoRapide 2020 is an open source library for building data-oriented backend applications using .NET Standard 2.1. |
| ARCCore.ARConcepts.MemoryConsumption | ARCCore | EnumMember | A naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption. |
| ARCCore.ARConcepts.Indexing | ARCCore | EnumMember | In-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-. |
| ARCCore.ARConcepts.CoreDBSynchronization | ARCCore | EnumMember | The concept of how multiple -CoreDB- instances synchronizes their data. |
| ARCCore.ARConcepts.SingleThreadedCode | ARCCore | EnumMember | Some practical choices have been made in AgoRapide which requires object access to be done in a single-threaded manner, or within a locking context (using for instance -ReaderWriterLockSlim-). |
| ARCCore.ARConcepts.DataRetention | ARCCore | EnumMember | The concept of when to delete old data (if deemed necessary). |
| ARCCore.ARConcepts.NoRealDeletion | ARCCore | EnumMember | AgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data). |
| ARCCore.ARConcepts.ManyToManyRelations | ARCCore | EnumMember | -ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table). |
| ARCCore.ARConcepts.Documentation | ARCCore | EnumMember | Thanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible. |
| ARCCore.PSPrefix | ARCCore | Enum | Describes some recommended prefixed to use in a -PropertyStreamLine-. |
| ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, like dt/ |
| ARCCore.PSPrefix.cmd | ARCCore | EnumMember | Command, like cmd/ |
| ARCCore.PSPrefix.app | ARCCore | EnumMember | Application state, like app/ |
| ARCCore.PSPrefix.doc | ARCCore | EnumMember | Documentation, like doc/. |
| ARCCore.PKHTMLAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.PKHTMLAttributeP.Encoder | ARCCore | EnumMember | The class doing the HTML-encoding. |
| ARCCore.PKLogAttributeP | ARCCore | Enum | Describes class -PKLogAttribute. |
| ARCCore.PKTypeAttributeP.DefaultValue | ARCCore | EnumMember | The default value. |
| ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
| ARCCore.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
| ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
| ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
| ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
| ARCCore.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
| ARCCore.PP.Value | ARCCore | EnumMember | The actual value. |
| ARCCore.ActualConnectionP.IsErrorCondition | ARCCore | EnumMember | Some kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound. |
| ARCCore.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
| ARCCore.ActualConnectionP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed and reinitialized. |
| ARCCore.ActualConnectionP.MonkeyWrench | ARCCore | EnumMember | |
| ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
| ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
| ARCCore.ConnectionInstructionP.ClientId | ARCCore | EnumMember | The AgoRapide node-id for which this connection is relevant. Used for distributing over the -PropertyStream- information to the clients about which possible nodes they can connect to. |
| ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
| ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
| ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
| ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
| ARCCore.StreamProcessorP.CountOutgoingConnections | |||
| ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
| ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
| ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
| ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
| ARCDoc.UtilDoc | ARCDoc | Class | Utility methods for -ARCDoc-. |
| ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTML | ARCDoc | ClassMember | Returns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy. |
| ARCDoc.UtilDoc.GenerateHTMLPage | ARCDoc | ClassMember | Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS. |
| ARCDoc.HTOC+ParentChain | ARCDoc | Class | Used by -FilterNode- in order to keep track of node's parents. |
| ARCDoc.AppleP | ARCDoc | Enum | Describes class -Apple-. |
| ARCDoc.AppleP.Name | ARCDoc | EnumMember | The name of the apple |
| ARCDoc.AppleP.Colour | ARCDoc | EnumMember | |
| ARCDoc.BananaP | ARCDoc | Enum | Describes class -Banana-. |
| ARCDoc.DocFragP.IsInheritedDoc | ARCDoc | EnumMember | Relevant for class members (methods). |
| ARCDoc.DocFragP.Lines | ARCDoc | EnumMember | Number of lines of text in -Description- and -LongDescription- for this fragment. |
| ARCDoc.DocFragP.Attribute | ARCDoc | EnumMember | The -BaseAttribute- or -PK- from which this -DocFrag- originates. |
| ARCDoc.DocFragType | ARCDoc | Enum | Type of documentation fragment, like -Assembly-, -Class- or -ClassMember-. |
| ARCDoc.DocFragType.Assembly | ARCDoc | EnumMember | |
| ARCDoc.DocFragType.Namespace | ARCDoc | EnumMember | |
| ARCDoc.DocFragType.Class | ARCDoc | EnumMember | Does also include interfaces. |
| ARCDoc.DocFragType.ClassMember | ARCDoc | EnumMember | |
| ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
| Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
| ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCDoc.Apple.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DummyEnum.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
Generated 2026-11-04 14:07:47.692 UTC