[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 390 > < TAKE 120 >
120 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.PValue<T>.ToString | ARCCore | ClassMember | Do no cache this value, because memory consumption would then increase significantly in your applicationj |
| 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 |
| Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCCore.PRich | ARCCore | Class | Fully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'. |
| ARCCore.PValue<T>.DeepCopy | ARCCore | ClassMember | Note that if the generic type (T) is not immutable, then what we return will not be a truly deep copy |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
| ARCCore.PRich.TryGetV | ARCCore | 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). |
| ARCCore.PValue<T>..ctor | ARCCore | ClassMember | Note how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide) |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.PRich.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PValueEmpty | ARCCore | Class | Represents the 'no value'. |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.PValue<T> | ARCCore | Class | Single value storage. |
| ARCCore.PValueEmpty.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.PValue<T>.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
| ARCCore.PValueEmpty.ToPropertyStream | ARCCore | ClassMember | Typicall return value could be something like |
| 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-. |
| 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). |
| ARCCore.PValue<T>.TryGetV | ARCCore | ClassMember | Supports duck typing. |
| ARCCore.ActualConnection | ARCCore | Class | The actual connection, its internal state, queue for sending and so on. |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCDoc.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ActualConnection..ctor | ARCCore | ClassMember | Note parameter-less constructor as desired for all classes inheriting -IP-. |
| ARCCore.ActualConnection.SetMyUpdatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. |
| ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
| ARCCore.MonkeyWrench | ARCCore | Class | Describes level of 'spanner-throwing' this connection shall contibute with |
| ARCCore.ActualConnection.SetSinglePropertyStreamReceiver | ARCCore | ClassMember | Set by -StreamProcessor-. |
| ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
| ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
| ARCCore.ClientUpdatePosition | ARCCore | Class | Describes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned. |
| ARCCore.ActualConnection.SetUpToDatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. Not used by -Client-. |
| 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) |
| ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
| ARCCore.ClientUpdatePosition.Filename | ARCCore | ClassMember | Filename like '2020-04-03 08:42:22_R001' |
| ARCCore.ActualConnection.InitializeOutgoingConnection | ARCCore | ClassMember | Relevant for -Outgoing-. |
| 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) |
| ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
| ARCCore.ClientUpdatePosition.Index | ARCCore | ClassMember | Index (zero-based) into file. Value of -1 means blank update status / no data received at all (or no data received for this specific filename) |
| ARCCore.ActualConnection.Communicate | ARCCore | ClassMember | Common for both -Incoming- and -Outgoing-. |
| ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
| ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
| ARCCore.ClientUpdatePosition.ClientDatastoreIsEmpty | ARCCore | ClassMember | Used by the subscribing client to signify that it has no data stored locally, and it therefore needs an update from the beginning of the -PropertyStream-, that is, 'from the beginning of time'. |
| ARCCore.ActualConnection.LogAndSendErrorConditionData | ARCCore | ClassMember | Called when a serious error condition has been discovered and connection should be terminated. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
| ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
| ARCCore.ClientUpdatePosition.OnlyNewDataIsRequested | ARCCore | ClassMember | Used by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data. |
| ARCCore.ActualConnection.Send | ARCCore | ClassMember | Sends all messages in queue. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
| ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
| ARCCore.ClientUpdatePosition.IsGoBack | ARCCore | ClassMember | Has to be translated by -StreamProcessor- into a concrete filename / index. |
| ARCCore.ActualConnection.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
| ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
| ARCCore.PropertyStreamLine | ARCCore | Class | Has two main functions: |
| ARCCore.ClientUpdatePosition.IsAtEndOfStream | ARCCore | ClassMember | Necessary in order to implement -AdHocQuery-. |
| ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCDoc.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCCore.PropertyStreamLine.EncodeKeys | ARCCore | ClassMember | Encodes the key part of a -PropertyStreamLine-. |
| ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstance | ARCCore | ClassMember | See also -ClientDatastoreIsEmpty. |
| ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
| ARCDoc.DocFrag.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). |
| ARCCore.PropertyStreamLine.EncodeValues | ARCCore | ClassMember | Typically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-. |
| ARCCore.ClientUpdatePosition.OnlyNewDataIsRequestedInstance | ARCCore | ClassMember | See also -OnlyNewDataIsRequested. |
| ARCDoc.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
| ARCDoc.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PropertyStreamLine.EncodeKeyPart | ARCCore | ClassMember | Converts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
| ARCCore.ConnectionInstruction | ARCCore | Class | The instruction about what connections to make (host, portnr, data transfer direction and so on). |
| ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
| ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
| ARCCore.PropertyStreamLine.EncodeValuePart | ARCCore | ClassMember | Converts a single value part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-. |
| ARCCore.ConnectionInstruction.Initialize | ARCCore | ClassMember | Initializes to sane values. |
| ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocFragCollection.Create | ARCDoc | ClassMember | Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies. |
| ARCCore.PropertyStreamLine.Decode | ARCCore | ClassMember | Decodes string as encoded by -EncodeKeyPart- or -EncodeValuePart-. |
| ARCCore.ConnectionInstruction.TryGetV | ARCCore | 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.DocFrag | ARCDoc | Class | DocFrag = Document fragment. |
| ARCDoc.DocFragCollection.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). |
| ARCCore.PropertyStreamLine.TryParseDirectToIP | ARCCore | ClassMember | Parses a series of -PropertyStreamLine- directly to the given type of -IP-. |
| ARCCore.ConnectionInstruction.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocFrag.Create Overload1 | ARCDoc | ClassMember | Creates a -DocFrag- object representing an assembly or a namespace. |
| ARCDoc.DocFragCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PropertyStreamLine.TryParseDirectToProperty | ARCCore | ClassMember | Parses direct to a given property value. |
| ARCCore.Sharding | ARCCore | Class | Enables load-balancing by describing what data should be sent over a given connection. |
| ARCDoc.DocFrag.Create Overload2 | ARCDoc | ClassMember | Creates a -DocFrag- object representing a class, class member, enum or enum member. |
| ARCDoc.DocLink | ARCDoc | Class | Describes to where a single HTML link points. |
| ARCCore.PropertyStreamLine.ParseAndStore | ARCCore | ClassMember | Note that throws exception if -TryParseAndStore- fails. |
| ARCQuery.QueryProgress.ToJSONSerializeable | ARCQuery | ClassMember | Override of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-. |
| 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.DocLinkResolution.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). |
| ARCCore.PropertyStreamLine.ParseAndStoreFailSafe | ARCCore | ClassMember | If either parsing or storing fails then this method will call -StoreFailure- in order to keep some track of why parsing or storing failed. |
| ARCQuery.QueryProgress.PreviousQueryJustExecuted | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
| ARCDoc.DocLink.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLinkResolution.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PropertyStreamLine.StoreFailSafe | ARCCore | ClassMember | Stores if possible and fails silently. |
| ARCQuery.QueryProgress.NextQueryToExecute | ARCQuery | ClassMember | TODO: This is somewhat loosely associated. |
| ARCDoc.DocLink.Location | ARCDoc | ClassMember | Copy of -Location-. |
| ARCDoc.DocLinkResolutionCollection | ARCDoc | Class | Contains a collection of -DocLinkResolution- objects. |
| ARCCore.PropertyStreamLine.StoreFailure | ARCCore | ClassMember | Stores a 'ParseOrStoreFailure'-object. |
| ARCQuery.QueryProgress.ToHTMLSimpleSingle | ARCQuery | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.DocLink.Filename | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.DocLinkResolutionCollection.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). |
| ARCCore.PropertyStreamLine.TryStore | ARCCore | ClassMember | Stores the given -PropertyStreamLineParsed- in the given storage object. |
| ARCQuery.QueryProgress.OrderAndReconstructKeys | ARCQuery | ClassMember | Part 1: |
| ARCDoc.DocLink.LinkWordHTML | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.DocLinkResolutionCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PropertyStreamLine.AllowedKeyChars | ARCCore | ClassMember | Allowed characters in the Key-part of a -PropertyStreamLine-. |
| ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryParts | ARCQuery | ClassMember | Is able to generate the following: |
| ARCDoc.DocLink.LinkWordHTMLWithHyphens | ARCDoc | ClassMember | -LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.Documentator | ARCDoc | Class | General class for documenting AgoRapide and also your own -ApplicationSpecificCode-. |
| ARCCore.PropertyStreamLine.AllowedValueChars | ARCCore | ClassMember | Allowed characters in the Value-part of a -PropertyStreamLine-. |
| ARCQuery.QueryProgress.ToString | ARCQuery | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| 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.Documentator.CreateAndInsert | ARCDoc | ClassMember | Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies. |
| ARCCore.PropertyStreamLineParsed | ARCCore | Class | Parses the keys part of a line from -PropertyStream-, like 'Customer/42/FirstName = John. |
Generated 2025-11-06 04:50:34.002 UTC