[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 346 > < TAKE 112 >
112 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.ARComponents | ARCCore | Enum | Contains short descriptions of the different 'official' AgoRapide components. |
| ARCCore.AREnumType.PropertyKeyEnum | ARCCore | EnumMember | Designates enums that describe relevant values for an 'entity' object like 'Customer'. |
| ARCCore.ARComponents.ARCCore | ARCCore | EnumMember | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. |
| ARCCore.AREnumType.OrdinaryEnum | ARCCore | EnumMember | Designates "Ordinary" enums used for indicating range of valid values for a given key |
| ARCCore.ARComponents.ARADB | ARCCore | EnumMember | An application constituting the full functionality of a -CoreDB- (linking to -ARCCore-). |
| 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.ARComponents.ARAClient | ARCCore | EnumMember | A template application for a -Client- (linking to -ARCCore-). |
| ARCCore.PKTypeAttributeP.DefaultValue | ARCCore | EnumMember | The default value. |
| ARCCore.ARComponents.ARCDoc | ARCCore | EnumMember | A library supporting documentation and demonstrating usage of AgoRapide. |
| ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
| ARCCore.ARComponents.ARCQuery | ARCCore | EnumMember | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. |
| ARCCore.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
| ARCCore.ARComponents.ARCSync | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
| ARCCore.ARComponents.ARCSec | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
| ARCCore.ARComponents.ARCAPI | ARCCore | EnumMember | A library providing an API on top of the -PropertyStream-. |
| ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
| 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.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
| ARCCore.ARConcepts | ARCCore | Enum | The overarching concepts upon which AgoRapide is built. |
| ARCCore.PP.Value | ARCCore | EnumMember | The actual value. |
| ARCCore.ARConcepts.GettingStarted | ARCCore | EnumMember | AgoRapide 2020 is an open source library for building data-oriented backend applications using .NET Standard 2.1. |
| 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.PSPrefix | ARCCore | Enum | Describes some recommended prefixed to use in a -PropertyStreamLine-. |
| ARCCore.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
| ARCCore.PSPrefix.dt | ARCCore | EnumMember | Data, like dt/ |
| ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
| ARCCore.PSPrefix.cmd | ARCCore | EnumMember | Command, like cmd/ |
| ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
| ARCCore.PSPrefix.app | ARCCore | EnumMember | Application state, like app/ |
| ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
| ARCCore.PSPrefix.doc | ARCCore | EnumMember | Documentation, like doc/. |
| ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCCore.PKHTMLAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
| ARCCore.PKHTMLAttributeP.Encoder | ARCCore | EnumMember | The class doing the HTML-encoding. |
| ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
| ARCCore.PKLogAttributeP | ARCCore | Enum | Describes class -PKLogAttribute. |
| ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
| ARCCore.PKLogAttributeP.DoNotLogAtAll | ARCCore | EnumMember | Originates from -DoNotLogAtAll-. |
| ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
| ARCCore.PKLogAttributeP.CountInterval | ARCCore | EnumMember | For a value of n, log only every n'th time the property is changed. |
| ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
| ARCCore.PKLogAttributeP.TimeInterval | ARCCore | EnumMember | Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-. |
| ARCCore.ConnectionInstructionP.Subscription | ARCCore | EnumMember | The actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server. |
| ARCCore.PKRelAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
| ARCCore.PKRelAttributeP.ForeignEntity | ARCCore | EnumMember | The type of foreign entity that this property points to. |
| ARCCore.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
| ARCCore.PKRelAttributeP.EnforceReferentialIntegrity | ARCCore | EnumMember | If TRUE then referential integrity will be enforced by -TryStore-. |
| ARCCore.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
| ARCCore.PKTypeAttributeP | ARCCore | Enum | Describes class -PKTypeAttribute-. |
| ARCCore.MultipleConnectionUsage.Admin | ARCCore | EnumMember | Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make. |
| ARCCore.PKTypeAttributeP.Type | ARCCore | EnumMember | The type of this Property. |
| ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
| ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
| 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.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCCore.StreamProcessorP.IndividualStorageFileSize | ARCCore | EnumMember | Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-. |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCCore.StreamProcessorP.CurrentlyInitializing | ARCCore | EnumMember | Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them). |
| 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.StreamProcessorP.ClientUpdatePositionPath | ARCCore | EnumMember | Complete path to file containing -ClientUpdatePosition-. |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCCore.StreamProcessorP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.StreamProcessorP.IncomingConnectionsPortNo | ARCCore | EnumMember | If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-). |
| ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
| ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
| ARCDoc.Banana.Name | ARCDoc | ClassMember | Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc) |
| ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
| ARCDoc.Banana.Colour | ARCDoc | ClassMember | Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc) |
| ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
| ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
| ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
| ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
| 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-. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
| ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
| ARCDoc.DocLink.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.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
| ARCDoc.DocLink.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
| ARCDoc.DocLink.Location | ARCDoc | ClassMember | Copy of -Location-. |
| ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
| ARCDoc.DocLink.Filename | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
| ARCDoc.DocLink.LinkWordHTML | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
| ARCDoc.DocLink.LinkWordHTMLWithHyphens | ARCDoc | ClassMember | -LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
| ARCDoc.DocLink.LinkWordHTMLBeforeLt | ARCDoc | ClassMember | If -LinkWordHTML contains '<' (really '<') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'. |
| ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
| ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens | ARCDoc | ClassMember | -LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
| ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCCore.ClassAttributeP.ClassType | ARCCore | EnumMember | The actual type that we are a -ClassAttribute- for |
| ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
| ARCCore.ClassAttributeP.BaseTypes | ARCCore | EnumMember | The inheritance hierarchy for this class, starting with base type (excluding 'object').r Not set if class does not inherit any class except 'object' |
| ARCDoc.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
| ARCCore.ClassAttributeP.SubTypes | ARCCore | EnumMember | Direct and indirect sub types of this class. |
| ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
| ARCCore.ClassAttributeP.Interfaces | ARCCore | EnumMember | All interfaces that this class and its base classes implement |
| ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
Generated 2025-11-06 12:21:33.537 UTC