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

170 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCAPI.BaseController.BuildControllerStorageARCAPIClassMemberBuilds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCAPI.BaseController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCAPI.BaseController.CatchAllARCAPIClassMemberServes the typical single generic API method in an AgoRapide API.
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCAPI.BaseController.TryNavigateToLevelInDataStorageARCAPIClassMemberNavigates to the specified level (usually within -Storage-).
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCAPI.BaseController.GetFormatAndAdjustRequestARCAPIClassMemberDecides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCAPI.BaseController.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCCore.StreamProcessorP.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCAPI.RQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
ARCCore.StreamProcessorP.CountOutgoingConnectionsARCCoreEnumMember 
ARCAPI.DataStorage.CreateARCAPIClassMemberCreates a -DataStorage- instance with default parameters.
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCCore.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
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
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCCore.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCCore.ConnectionDirection.OutgoingARCCoreEnumMemberThere would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCCore.DataTransferDirectionARCCoreEnumDirection for transfer of data.
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCCore.DataTransferDirection.SendARCCoreEnumMemberLike -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCCore.DataTransferDirection.ReceiveARCCoreEnumMemberLike -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCCore.TPropertyKeyEnumARCCoreEnumPlaceholder for any enum type suitable as generic type parameter for -PExact-.
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
Assembly ARCDoc AssemblyA library supporting documentation and demonstrating usage of AgoRapide.
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCDoc.AppleARCDocClassThe most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
Assembly AgoBrowse Assembly 
ARCDoc.Apple.AddNameARCDocClassMemberConvenience method, not obligatory.
AgoBrowse.ProgramAgoBrowseClass 
ARCDoc.Apple.GetNameARCDocClassMemberConvenience method, not obligatory.
AgoBrowse.Program.InitStreamProcessorAgoBrowseClassMemberInitializes stream processor.
ARCDoc.Apple.TryGetNameARCDocClassMemberConvenience method, not obligatory.
AgoBrowse.RootAgoBrowseClassContains the user friendly welcome text (front page) for the application.
ARCDoc.Apple.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
AgoBrowse.Root.ToHTMLSimpleSingleAgoBrowseClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Apple.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).
AgoBrowse.Root.TryGetPAgoBrowseClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Apple.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Root.TryGetVAgoBrowseClassMemberNote 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.NameARCDocClassMemberConvenience method, not obligatory.
AgoBrowse.Root.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.BananaARCDocClassImplements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
AgoBrowse.Controllers.CompileControllerAgoBrowseClassCompiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
ARCDoc.Banana.NameARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
AgoBrowse.Controllers.CompileController.APIMethodAgoBrowseClassMemberThe (only) API method that this controller supports.
ARCDoc.Banana.ColourARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
AgoBrowse.Controllers.CompileController.CompileAgoBrowseClassMemberCompiles a hierarchical 'picture book' from the given parameter.
ARCDoc.DemonstratorARCDocClassDemonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
AgoBrowse.Controllers.CompileController.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Demonstrator.DemonstratePropertyAccessAppleARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Apple- class.
AgoBrowse.Controllers.ControllerFacadeAgoBrowseClassFacade for entry into the desired -RQController-.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrangeARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Orange- class.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2AgoBrowseClassMemberCatches all HTTP GET requests to this API.
ARCDoc.Demonstrator.DemonstratePropertyAccessBananaARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Banana- class.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1AgoBrowseClassMemberCatches all HTTP POST requests to this API.
ARCDoc.Demonstrator.DemonstrateITypeDescriberARCDocClassMemberDemonstrates use of -ITypeDescriber- for describing single-property values.
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorageARCDocClassMemberDemonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCDoc.Demonstrator.DemonstratePropertyStreamARCDocClassMemberDemonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCDoc.Demonstrator.DemonstrateBareBonesClientARCDocClassMemberDemonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCDoc.Demonstrator.DemonstrateLogConsoleARCDocClassMemberDemonstrates a quite simple log console.
Namespace AgoBrowse Namespace 
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClientARCDocClassMemberDemonstrates use of -StreamProcessor- as a general client.
Namespace AgoBrowse.Controllers Namespace 
ARCDoc.OrangeARCDocClassInherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCDoc.Orange.SetPVDirectARCDocClassMemberHigh performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCDoc.Orange.GetPVDirectARCDocClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.Orange.TryGetPVDirectARCDocClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.Orange.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
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()')
ARCDoc.SomeAppComponent.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragARCDocClassDocFrag = Document fragment.
ARCDoc.DocFrag.Create Overload1ARCDocClassMemberCreates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.DocFrag.Create Overload2ARCDocClassMemberCreates a -DocFrag- object representing a class, class member, enum or enum member.
ARCDoc.DocFrag.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocFrag.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFrag.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.DocFrag.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragCollectionARCDocClassContains a collection of -DocFrag- objects.
ARCDoc.DocFragCollection.CreateARCDocClassMemberCreates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.DocFragCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFragCollection.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.DocFragCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkARCDocClassDescribes to where a single HTML link points.
ARCDoc.DocLink.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLink.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.DocLink.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLink.LocationARCDocClassMemberCopy of -Location-.
ARCDoc.DocLink.FilenameARCDocClassMemberCopy of -LinkWordHTML-.
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.DocLink.AHrefEndPartARCDocClassMember'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCDoc.DocLinkCollectionARCDocClassContains a collection of -DocLink- objects.
ARCDoc.DocLinkCollection.CreateARCDocClassMemberNotes all locations and their positions in the hierarchical directory structure.
ARCDoc.DocLinkCollection.InsertLinks Overload1ARCDocClassMemberDoes -LinkInsertionInDocumentation- on the given HTML content.
ARCDoc.DocLinkCollection.InsertLinks Overload2ARCDocClassMemberSee overload with 'contentLocation' as parameter for documentation.
ARCDoc.DocLinkCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkCollection.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.DocLinkCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolutionARCDocClassContains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCDoc.DocLinkResolution.ToHTMLSimpleSingleARCDocClassMemberGives a friendly description about possible targets for LinkWord-.
ARCDoc.DocLinkResolution.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkResolution.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.DocLinkResolution.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolutionCollectionARCDocClassContains a collection of -DocLinkResolution- objects.
ARCDoc.DocLinkResolutionCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkResolutionCollection.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.DocLinkResolutionCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocumentatorARCDocClassGeneral class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.Documentator.CreateAndInsertARCDocClassMemberCreates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.Documentator.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
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.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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)
ARCDoc.DummyEnum.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DummyEnum.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.DummyEnum.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.

Generated 2026-11-17 02:17:32.039 UTC