[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() SKIP 1007

170 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.AddController	ARCAPI	Class	Parses and stores a -PropertyStreamLine-.
ARCAPI.AddController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.AddController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.AddController.AllowFilter	ARCAPI	ClassMember	Describes what data is allowed to change through a list of -Subscription- instances.
ARCAPI.BaseController	ARCAPI	Class	Contains basic functionality for serving API methods.
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCAPI.BaseController.GetTimestampIsOldWarningHTML	ARCAPI	ClassMember	If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCAPI.BaseController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.EditController	ARCAPI	Class	Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCAPI.EditController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.EditController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.GQController	ARCAPI	Class	Offers GraphQL queries.
ARCAPI.GQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.GQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.RQController	ARCAPI	Class	RQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCAPI.RQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.RQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.DataStorage	ARCAPI	Class	The all-in-memory global application data storage.
ARCAPI.DataStorage.Create	ARCAPI	ClassMember	Creates a -DataStorage- instance with default parameters.
ARCAPI.DataStorage..ctor	ARCAPI	ClassMember	This method will:
ARCAPI.DataStorage.Storage	ARCAPI	ClassMember	The actual storage.
ARCAPI.DataStorage.ControllerStorage	ARCAPI	ClassMember	Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCAPI.DataStorage.DocLinks	ARCAPI	ClassMember	Note that may be null.
ARCAPI.DataStorage.Lock	ARCAPI	ClassMember	Locking object for thread-safe access from simultaneous API requests.
ARCAPI.DataStorage.ExternalReceiver	ARCAPI	ClassMember	Typically used by -AddController-.
ARCAPI.DataStorage.DoNotStoreInternally	ARCAPI	ClassMember	Typically used by -AddController-.
ARCAPI.BaseControllerP	ARCAPI	Enum	Describes class -BaseController-.
ARCAPI.BaseControllerP.CountRequest	ARCAPI	EnumMember	Number of calls to -APIMethod- since application initialization
ARCAPI.BaseControllerP.CountException	ARCAPI	EnumMember	Number of exceptions at call to -APIMethod- since application initialization
ARCAPI.BaseControllerP.LogLevel	ARCAPI	EnumMember
ARCAPI.ResponseFormat	ARCAPI	Enum	The response format, HTML or JSON, for an API request.
ARCAPI.ResponseFormat.JSON	ARCAPI	EnumMember
ARCAPI.ResponseFormat.HTML	ARCAPI	EnumMember
Assembly AgoBrowse		Assembly
AgoBrowse.Program	AgoBrowse	Class
AgoBrowse.Program.InitStreamProcessor	AgoBrowse	ClassMember	Initializes stream processor.
AgoBrowse.Root	AgoBrowse	Class	Contains the user friendly welcome text (front page) for the application.
AgoBrowse.Root.ToHTMLSimpleSingle	AgoBrowse	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
AgoBrowse.Root.TryGetP	AgoBrowse	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
AgoBrowse.Root.TryGetV	AgoBrowse	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).
AgoBrowse.Root.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.CompileController	AgoBrowse	Class	Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
AgoBrowse.Controllers.CompileController.APIMethod	AgoBrowse	ClassMember	The (only) API method that this controller supports.
AgoBrowse.Controllers.CompileController.Compile	AgoBrowse	ClassMember	Compiles a hierarchical 'picture book' from the given parameter.
AgoBrowse.Controllers.CompileController.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.ControllerFacade	AgoBrowse	Class	Facade for entry into the desired -RQController-.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2	AgoBrowse	ClassMember	Catches all HTTP GET requests to this API.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1	AgoBrowse	ClassMember	Catches all HTTP POST requests to this API.
Namespace ARCCore		Namespace	A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
Namespace ARCDoc		Namespace	A library supporting documentation and demonstrating usage of AgoRapide.
Namespace ARCQuery		Namespace	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
Namespace ARCAPI		Namespace	A library providing an API on top of the -PropertyStream-.
Namespace AgoBrowse		Namespace
Namespace AgoBrowse.Controllers		Namespace
ARCCore.ARConcepts.PropertyAccess	ARCCore	EnumMember	The general mechanism for accessing properties of objects in AgoRapide.
ARCCore.ARConcepts.AvoidingRepetition	ARCCore	EnumMember	Avoiding repetition, the overarching philosophy that inspired the rest of AgoRapide.
ARCCore.ARConcepts.AgoRapideHistory	ARCCore	EnumMember	AgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language).
ARCCore.ARConcepts.AdHocQuery	ARCCore	EnumMember	The concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-.
ARCCore.ARConcepts.StandardAgoRapideCode	ARCCore	EnumMember	Code originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code)
ARCCore.ARConcepts.ApplicationSpecificCode	ARCCore	EnumMember	Code specific for an end-application.
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.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.PSPrefix	ARCCore	Enum	Describes some recommended prefixes to use in a -PropertyStreamLine-.
ARCCore.PSPrefix.dt	ARCCore	EnumMember	Data, single key + value.
ARCCore.PSPrefix.dtr	ARCCore	EnumMember	Data, whole records.
ARCCore.PSPrefix.RS	ARCCore	EnumMember	RS = Registration Stream (see -RegStream-).
ARCCore.PSPrefix.ES	ARCCore	EnumMember	ES = Event Stream (see -EventStream-).
ARCCore.PSPrefix.cmd	ARCCore	EnumMember	Command.
ARCCore.PSPrefix.app	ARCCore	EnumMember	Application state, like app/
ARCCore.PSPrefix.doc	ARCCore	EnumMember	Documentation.
ARCCore.PSPrefix.t	ARCCore	EnumMember	Translations.
ARCCore.PKHTMLAttributeP	ARCCore	Enum	Describes class -PKRelAttribute-.
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.PP.Valid	ARCCore	EnumMember	Timestamp when property was last known to be (still) valid
ARCCore.PP.Vid	ARCCore	EnumMember	Validator id, that is entity which set -Valid- for this property.
ARCCore.PP.Invalid	ARCCore	EnumMember	Timestamp when property was invalidated / 'deleted'.
ARCCore.PP.Iid	ARCCore	EnumMember	Invalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01').
ARCCore.PP.ExceptionText	ARCCore	EnumMember	General property for logging of exceptions, usually set through -HandleException-.
ARCCore.PConcurrentP	ARCCore	Enum	Describes class -PConcurrent-.
ARCCore.PConcurrentP.Heartbeat	ARCCore	EnumMember
ARCCore.ActualConnectionP	ARCCore	Enum	Describes class -ActualConnection-.
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.ConnectionInstructionP.Sharding	ARCCore	EnumMember
ARCCore.MultipleConnectionUsage	ARCCore	Enum	Enables fault-tolerance by describing use of multiple connections
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.MultipleConnectionUsage.RoundRobin	ARCCore	EnumMember	This connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCCore.MultipleConnectionUsage.Simultaneous	ARCCore	EnumMember	This connection to be used simultaneously with other connections with -Simultaneous-
ARCCore.StreamProcessorP	ARCCore	Enum	Describes class -StreamProcessor-.
ARCCore.StreamProcessorP.LocalStorageFolder	ARCCore	EnumMember	The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
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.StreamProcessorP.CurrentlyInitializing	ARCCore	EnumMember	Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCCore.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
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.PKTypeAttribute.Cardinality	ARCCore	ClassMember	See -Cardinality-.
ARCCore.PKTypeAttribute.DefaultValue	ARCCore	ClassMember	See -DefaultValue-.
ARCCore.PKTypeAttribute.IsObligatory	ARCCore	ClassMember	See -IsObligatory-.
ARCCore.PKTypeAttribute.IsDefault	ARCCore	ClassMember	Does 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	ARCCore	Class	IP = IProperty.
ARCCore.IP.TryGetV Overload2	ARCCore	ClassMember	The actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.IP.Inc	ARCCore	ClassMember	Increments given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.IP.Dec	ARCCore	ClassMember	Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.IP.Log	ARCCore	ClassMember	The 'final' overload of -Log- that is called by the other overloads.
ARCCore.IP.LogExecuteTime	ARCCore	ClassMember	Times the execution of the given function and logs details about elapsed time.
ARCCore.IP.HandleException	ARCCore	ClassMember	Note that most relevant to use for -PConcurrent-.
ARCCore.IP.TryParseDtr	ARCCore	ClassMember	Parses a PropertyStreamLine- beginning with -dtr-.
ARCCore.IP.Initialize	ARCCore	ClassMember	Note that has a default implementation (doing nothing).
ARCCore.IP.AssertIntegrity	ARCCore	ClassMember	See -TryAssertIntegrity-.
ARCCore.IP.TryAssertIntegrity	ARCCore	ClassMember	Asserts the integrity of this entity.
ARCCore.IP.ToString	ARCCore	ClassMember	The 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.TryGetV Overload1	ARCCore	ClassMember	The actual 'unpacking' of the object.
ARCCore.IP.DeepCopy	ARCCore	ClassMember	Creates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects).
ARCCore.IP.AddPV Overload2	ARCCore	ClassMember	NOTE: The different AddPV / AddP overloads should only be used if you want an assertion against the
ARCCore.IP.AddPV Overload1	ARCCore	ClassMember	Adds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant.
ARCCore.IP.AddP	ARCCore	ClassMember	Adds a property for this object.
ARCCore.IP.AddOrUpdateP	ARCCore	ClassMember	Duplicates functionality of SetP.
ARCCore.IP.GetOrAddPV	ARCCore	ClassMember	Gets value. If not set then value will be added
ARCCore.IP.GetPV	ARCCore	ClassMember	Gets a single property's value for this object. Returns default value if not successful.
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecific	ARCCore	ClassMember	All relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDict	ARCCore	ClassMember	All -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstract	ARCCore	ClassMember	All relevant -IP--derived types (except the interface -IP- itself) known to the application.
ARCCore.IP.AllIPDerivedTypesDict	ARCCore	ClassMember	Provides lookup of a type in -AllIPDerivedTypes- given its string representation.
ARCCore.IP.AllIPDerivedTypesDictIKType	ARCCore	ClassMember	Same as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCCore.P	ARCCore	Class	'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced
ARCCore.P.TryGetP	ARCCore	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.P.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.IGetKeysEqualToValue	ARCCore	Class	Interface stating that implementing class does not use the default implementation of -GetKeysEqualToValue- (which does not use -Indexing-) but has replaced it with a more efficient implementation assumed to utilize -Indexing-.
ARCCore.PConcurrent	ARCCore	Class	A (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-).
ARCCore.PConcurrent.ToString	ARCCore	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.PExact<TEnumType>	ARCCore	Class	Very -MemoryConsumption- efficient alternative to -PRich-.
ARCCore.PExact<TEnumType>.SetPVDirect	ARCCore	ClassMember	High performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCCore.PExact<TEnumType>.GetPVDirect	ARCCore	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.PExact<TEnumType>.TryGetPVDirect	ARCCore	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.PExact<TEnumType>.ToString	ARCCore	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.PValue<T>.TrySetP	ARCCore	ClassMember	NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.PValue<T>.TryGetV	ARCCore	ClassMember	Supports duck typing.
ARCCore.PValue<T>.ConvertObjectToString	ARCCore	ClassMember	Converts object to string.
ARCCore.PValue<T>.ToString	ARCCore	ClassMember	Do no cache this value, because memory consumption would then increase significantly in your applicationj
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.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.PValueEmpty	ARCCore	Class	Represents the 'no value'.
ARCCore.PValueEmpty.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.ActualConnection	ARCCore	Class	The actual connection, its internal state, queue for sending and so on.
ARCCore.ActualConnection.SetMyUpdatePositionGenerator	ARCCore	ClassMember	Set by -StreamProcessor-.
ARCCore.ActualConnection.SetSinglePropertyStreamReceiver	ARCCore	ClassMember	Set by -StreamProcessor-.
ARCCore.ActualConnection.SetUpToDatePositionGenerator	ARCCore	ClassMember	Set by -StreamProcessor-. Not used by -Client-.
ARCCore.ActualConnection.InitializeOutgoingConnection	ARCCore	ClassMember	Relevant for -Outgoing-.
ARCCore.ActualConnection.Communicate	ARCCore	ClassMember	Common for both -Incoming- and -Outgoing-.
ARCCore.ActualConnection.LogAndSendErrorConditionData	ARCCore	ClassMember	Called when a serious error condition has been discovered and connection should be terminated.

Generated 2025-09-16 17:35:47.748 UTC