[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   <  SKIP 328  >   <  TAKE 128  >   

128 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.EnumMemberAttributeP.EnumMemberARCCoreEnumMemberThe actual enum member / enum value (like 'Firstname' in CustomerP.FirstName) that we are an attribute for
ARCCore.AREnumTypeARCCoreEnumCategories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-.
ARCCore.AREnumType.PropertyKeyEnum   
ARCCore.AREnumType.OrdinaryEnumARCCoreEnumMemberDesignates "Ordinary" enums used for indicating range of valid values for a given key
ARCCore.AREnumType.DocumentationOnlyEnumARCCoreEnumMemberDesignates enums that provide a central repository of explanation of terms that are not present in the C# code.
ARCCore.ARNodeTypeARCCoreEnumDescribes 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.CoreDBARCCoreEnumMemberA node containing the core or central database.
ARCCore.ARNodeType.ArmDBARCCoreEnumMemberA 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.ClientARCCoreEnumMemberAn outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-.
ARCCore.CardinalityARCCoreEnumDescribes how multiple instances of a property is supposed to be handled.
ARCCore.Cardinality.HistoryOnlyARCCoreEnumMemberThe default value.
ARCCore.Cardinality.WholeCollectionARCCoreEnumMemberValues are always set as a whole (there is no need or no meaning in setting or deleting individual items)
ARCCore.Cardinality.IndividualItemsARCCoreEnumMemberValues are supposed to be set and 'deleted' individually.
ARCCore.PSPrefixARCCoreEnumDescribes some recommended prefixed to use in a -PropertyStreamLine-.
ARCCore.PSPrefix.dtARCCoreEnumMemberData, like dt/
ARCCore.PSPrefix.cmdARCCoreEnumMemberCommand, like cmd/
ARCCore.PSPrefix.appARCCoreEnumMemberApplication state, like app/
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCCore.ConnectionInstructionP.ClientIdARCCoreEnumMemberThe 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.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCCore.ConnectionInstructionP.SubscriptionARCCoreEnumMemberThe actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server.
ARCCore.ConnectionInstructionP.MultipleConnectionUsageARCCoreEnumMember 
ARCCore.ConnectionInstructionP.ShardingARCCoreEnumMember 
ARCCore.MultipleConnectionUsageARCCoreEnumEnables fault-tolerance by describing use of multiple connections
ARCCore.MultipleConnectionUsage.AdminARCCoreEnumMemberConnection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCCore.MultipleConnectionUsage.RoundRobinARCCoreEnumMemberThis connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCCore.MultipleConnectionUsage.SimultaneousARCCoreEnumMemberThis connection to be used simultaneously with other connections with -Simultaneous-
ARCCore.StreamProcessorPARCCoreEnumDescribes class -StreamProcessor-.
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCCore.StreamProcessorP.CountOutgoingConnections   
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCCore.StorageFileP.HashARCCoreEnumMemberHash 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.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCDoc.Demonstrator.DemonstrateLogConsoleARCDocClassMemberDemonstrates a quite simple log console.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClientARCDocClassMemberDemonstrates use of -StreamProcessor- as a general client.
ARCDoc.OrangeARCDocClassInherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCDoc.Orange.NameARCDocClassMemberSee -Name- for more information.
ARCDoc.Orange.StorageARCDocClassMemberUses int-value of -__enum- minus 1 as index.
ARCDoc.SomeAppComponentARCDocClassDemonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.SomeAppComponent.MethodCARCDocClassMemberNote structured format in logging.
ARCDoc.SomeAppComponent.MethodDARCDocClassMemberSame as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCCore.BaseAttributeARCCoreClassInstances of this class are used as source of documentation and data for the API.
ARCCore.BasePKAttribute.GetAttributesARCCoreClassMemberNote that illegal to call for other than -PropertyKeyEnum-.
ARCCore.ClassAttribute.GetAttributeARCCoreClassMemberThrows exception if type implements -IP- and no corresponding enum found (enum ending with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance)
ARCCore.ClassAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.ClassMemberAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.IKType   
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.PK.TryGetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute-.
ARCCore.PK.TryValidateAndParseARCCoreClassMemberParses the value according to specifications for this property key.
ARCCore.PK.TryCleanValidateAndParseARCCoreClassMemberCleans and parses the value according to specifications for this property key.
ARCCore.PK.GetObligatoryValuesForEntityTypeARCCoreClassMemberReturns all obligatory values (based on -IsObligatory-)
ARCCore.PK.EqualsARCCoreClassMemberNote that ToString is only based on __enum, meaning that two enum members / enum values with same name but different type, like CustomerP.Name and OrderP.Name, will be considered equal.
ARCCore.PK.TryGetVARCCoreClassMemberNote 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.PK..ctorARCCoreClassMemberConstructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PKHTMLAttributeARCCoreClassContains pointer to HTML encoder for a property.
ARCCore.PKHTMLAttribute.EncodeARCCoreClassMemberEncodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PKHTMLAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.PKHTMLAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKLogAttribute.DoNotLogAtAllARCCoreClassMemberSee -DoNotLogAtAll-.
ARCCore.PKLogAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.PKRelAttribute.EnforceReferentialIntegrityARCCoreClassMemberSee -EnforceReferentialIntegrity-.
ARCCore.PKRelAttribute.IsDefaultARCCoreClassMemberDoes not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.)
ARCCore.IP.ToStringARCCoreClassMemberThe ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on
ARCCore.IP.TrySetPPARCCoreClassMemberSetPP = set property of property. Sets property of entity contained within this class.
ARCCore.IP.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.IP.OnTrySetPARCCoreClassMemberEvent handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done).
ARCCore.StreamProcessor.ReadStorageFileARCCoreClassMemberReads one storage file from disk
ARCCore.StreamProcessor.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessor.OutsideLocalReceiverARCCoreClassMemberThe outside (in the sense outside of this class) local mechanism which receives all -PropertyStreamLine- registered by this class.
ARCCore.PropertyStreamLineWithOriginARCCoreClassThe rationale for this class is that -ReceiveAndDistribute- needs to distingush origin of data when routing it (in general, in order to avoid sending it back to its source).
ARCCore.Subscription.FromTimeARCCoreClassMemberTODO: Implement concept of specifying starting-point in TIME (often for an -AdHocQuery-?).
ARCCore.Subscription.ToTimeARCCoreClassMemberTODO: Implement concept of specifying ending-point in TIME (often for an -AdHocQuery-?).
ARCCore.Subscription.IsMatch Overload1ARCCoreClassMemberEvaluates a query consisting of multiple instances of -Subscription- against a single property stream line.
ARCCore.Subscription.IsMatch Overload2ARCCoreClassMemberEvaluates this instance of -Subscription- against a single property stream line (which has been split up into its constituent elements).
ARCCore.UtilCore.TryGetTypeFromStringFromCacheARCCoreClassMemberCorresponding method for creating string-representation of type is -ToStringDB-.
ARCCore.UtilCore.GetExceptionChainAsStringARCCoreClassMemberFollows the chain of InnerException and returns types as comma-separated string
ARCCore.UtilCore.GetExeptionDetailsARCCoreClassMemberGives as much information about exception as possible.
ARCCore.UtilCore.DateTimeTryParseARCCoreClassMemberAccepts on of the formats specified in -ValidDateTimeFormats-.
ARCCore.UtilCore.TimeSpanTryParseARCCoreClassMemberAccepts on of the formats specified in -ValidDateTimeFormats-.
ARCCore.UtilCore.UseLocalTimeInsteadOfUTCARCCoreClassMemberBy default AgoRapide operates only with UTC time.
ARCCore.UtilCore.DateTimeNowARCCoreClassMemberReturns DateTime.UtcNow unless -UseLocalTimeInsteadOfUTC- has been set to TRUE in which case DateTime.Now is returned.
ARCCore.UtilCore.CurrentlyStartingUpARCCoreClassMemberCalled once at application startup after all Attribute instances in the C# code has been processed.
ARCCore.UtilCore.AssembliesARCCoreClassMemberAll relevant assemblies for application.
ARCCore.UtilCore.CultureARCCoreClassMemberThe general culture used for parsing.
ARCCore.UtilCore.Culture_en_USARCCoreClassMemberUsed by -DoubleTryParse-.
ARCCore.UtilCore.DefaultAgoRapideEncodingARCCoreClassMemberThe standard encoding used for text (UTF8).
ARCCore.StreamProcessor+StorageFile.LengthARCCoreClassMemberWrongly placed. Belongs to each individual revision file.
ARCCore.StreamProcessor+StorageFile.PropertiesARCCoreClassMemberKey = revision number of file (due to compression / -DataRetention-), like R00001, R00002 and so on.
ARCCore.BaseAttributePARCCoreEnumDescribes class -BaseAttribute-.
ARCCore.BaseAttributeP.DescriptionARCCoreEnumMemberThe description for the attribute, like this description
ARCDoc.DocLink.LinkWordHTMLARCDocClassMemberCopy of -LinkWordHTML-.
ARCDoc.DocLink.LinkWordHTMLWithHyphensARCDocClassMember-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocLink.LinkWordHTMLBeforeLtARCDocClassMemberIf -LinkWordHTML contains '<' (really '&lt;') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphensARCDocClassMember-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.Documentator.CreateHTOCStandardARCDocClassMemberCreates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCDoc.Documentator.CreateHTOCNamespaceARCDocClassMemberCreates a table of contents structured by namespace
ARCDoc.Documentator.CreateHTOCInheritanceARCDocClassMemberCreates a table of contents structured by inheritance (classes and interfaces only, not members).
ARCDoc.Documentator.TryGetVARCDocClassMemberNote 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.Documentator.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Documentator.DocLinksARCDocClassMemberSet by -CreateAndInsert-.
ARCDoc.Documentator.DocLinkResolutionLocationARCDocClassMemberDefault position within the global storage context of doc link resolution pages.
ARCDoc.DummyEnumARCDocClassTODO: Document better what this is for (and change name)
ARCCore.ARComponents.ARCAPIARCCoreEnumMemberA library providing an API on top of the -PropertyStream-.
ARCCore.ARComponents.ARAAPIARCCoreEnumMemberThe corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc.
ARCCore.ARConceptsARCCoreEnumThe overarching concepts upon which AgoRapide is built.
ARCCore.ARConcepts.GettingStartedARCCoreEnumMemberAgoRapide 2020 is an open source library for building data-oriented backend applications using .NET Standard 2.1.
ARCCore.ARConcepts.PropertyStreamARCCoreEnumMemberAgoRapide, the 'streams-of-water' database".
ARCCore.ARConcepts.TaggingOfPropertyKeysARCCoreEnumMemberThe concept of specifying in a single place all relevant information about a given property (data field).
ARCCore.ARConcepts.PropertyAccessARCCoreEnumMemberThe general mechanism for accessing properties of objects in AgoRapide.

Generated 2026-11-05 08:18:07.465 UTC