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

192 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.PKTypeAttribute.DefaultValueARCCoreClassMemberSee -DefaultValue-.
ARCCore.IP.HandleExceptionARCCoreClassMemberNote that most relevant to use for -PConcurrent-.
ARCCore.ARConcepts.PropertyStreamARCCoreEnumMemberAgoRapide, the 'streams-of-water' database".
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCCore.PKTypeAttribute.IsObligatoryARCCoreClassMemberSee -IsObligatory-.
ARCCore.IP.InitializeARCCoreClassMemberNote that has a default implementation (doing nothing).
ARCCore.ARConcepts.TaggingOfPropertyKeysARCCoreEnumMemberThe concept of specifying in a single place all relevant information about a given property (data field).
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCCore.PKTypeAttribute.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.AssertIntegrityARCCoreClassMemberSee -TryAssertIntegrity-.
ARCCore.ARConcepts.PropertyAccessARCCoreEnumMemberThe general mechanism for accessing properties of objects in AgoRapide.
ARCAPI.RQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.IPARCCoreClassIP = IProperty.
ARCCore.IP.TryAssertIntegrityARCCoreClassMemberAsserts the integrity of this entity.
ARCCore.ARConcepts.AvoidingRepetitionARCCoreEnumMemberAvoiding repetition, the overarching philosophy that inspired the rest of AgoRapide.
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
ARCCore.IP.TryGetV Overload2ARCCoreClassMemberThe actual value of the property. Mostly relevant for single-value properties like -PValue-.
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.ARConcepts.AgoRapideHistoryARCCoreEnumMemberAgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language).
ARCAPI.DataStorage.CreateARCAPIClassMemberCreates a -DataStorage- instance with default parameters.
ARCCore.IP.IncARCCoreClassMemberIncrements given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.IP.TrySetPPARCCoreClassMemberSetPP = set property of property. Sets property of entity contained within this class.
ARCCore.ARConcepts.AdHocQueryARCCoreEnumMemberThe concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-.
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
ARCCore.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.IP.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.ARConcepts.StandardAgoRapideCodeARCCoreEnumMemberCode originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code)
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
ARCCore.IP.LogARCCoreClassMemberThe 'final' overload of -Log- that is called by the other overloads.
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.ARConcepts.ApplicationSpecificCodeARCCoreEnumMemberCode specific for an end-application.
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCCore.IP.LogExecuteTimeARCCoreClassMemberTimes the execution of the given function and logs details about elapsed time.
ARCCore.IP.AddPARCCoreClassMemberAdds a property for this object.
ARCCore.ARConcepts.MemoryConsumptionARCCoreEnumMemberA naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption.
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCCore.IP.TryGetP Overload1ARCCoreClassMemberGets a single property for this object
ARCCore.IP.AddOrUpdatePARCCoreClassMemberDuplicates functionality of SetP.
ARCCore.ARConcepts.IndexingARCCoreEnumMemberIn-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-.
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCCore.IP.GetOrAddPVARCCoreClassMemberGets value. If not set then value will be added
ARCCore.ARConcepts.CoreDBSynchronizationARCCoreEnumMemberThe concept of how multiple -CoreDB- instances synchronizes their data.
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.IP.GetPARCCoreClassMemberGets a single property for this object.
ARCCore.ARConcepts.SingleThreadedCodeARCCoreEnumMemberSome practical choices have been made in AgoRapide which requires object access to be done in a single-threaded manner, or within a locking context (using for instance -ReaderWriterLockSlim-).
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberMakes the following modifications to the data:
ARCCore.IP.TryGetP Overload2ARCCoreClassMemberNote that not relevant for single-value properties like -PValue-.
ARCCore.ARConcepts.DataRetentionARCCoreEnumMemberThe concept of when to delete old data (if deemed necessary).
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCCore.IP.TrySetPARCCoreClassMemberSet property regardless of whether exists or not.
ARCCore.IP.GetPVARCCoreClassMemberGets a single property's value for this object. Returns default value if not successful.
ARCCore.ARConcepts.NoRealDeletionARCCoreEnumMemberAgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data).
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCCore.IP.TryGetV Overload1ARCCoreClassMemberThe actual 'unpacking' of the object.
ARCCore.IP.TryGetPVARCCoreClassMemberGets a single property's value for the given property key.
ARCCore.ARConcepts.ManyToManyRelationsARCCoreEnumMember-ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table).
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCCore.IP.DeepCopyARCCoreClassMemberCreates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects).
ARCCore.IP.EnumeratorReturnsEmptyCollectionARCCoreClassMemberHint for how to avoid calling enumerator.Count() when all you need is to decide if collection is empty or not.
ARCCore.ARConcepts.DocumentationARCCoreEnumMemberThanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible.
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCCore.IP.AddPVARCCoreClassMemberAdds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDictARCCoreClassMemberAll -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCCore.PSPrefixARCCoreEnumDescribes some recommended prefixed to use in a -PropertyStreamLine-.
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCCore.IP.IsValidARCCoreClassMemberNote that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'.
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstractARCCoreClassMemberAll relevant -IP--derived types (except the interface -IP- itself) known to the application.
ARCCore.PSPrefix.dtARCCoreEnumMemberData, like dt/
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCCore.IP.ItemARCCoreClassMemberOffers string-based direct indexing.
ARCCore.IP.AllIPDerivedTypesDictARCCoreClassMemberOffers for lookup of a type given its string representation.
ARCCore.PSPrefix.cmdARCCoreEnumMemberCommand, like cmd/
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCCore.IP.KeysARCCoreClassMemberReturns all the keys for this instance.
ARCCore.IP.AllIPDerivedTypesDictIKTypeARCCoreClassMemberSame as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCCore.PSPrefix.appARCCoreEnumMemberApplication state, like app/
Assembly AgoMail Assembly 
ARCCore.IP.ValuesARCCoreClassMemberReturns all the values (all the properties) for this instance.
ARCCore.PARCCoreClass'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced
ARCCore.PSPrefix.docARCCoreEnumMemberDocumentation, like doc/.
AgoMail.CleanerAgoMailClass 
ARCCore.IP.LoggerARCCoreClassMemberDescribes a logger.
ARCCore.P.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.PKHTMLAttributePARCCoreEnumDescribes class -PKRelAttribute-.
AgoMail.Cleaner.CleanAgoMailClassMemberRemoves emails with often seen values for Subject, To or From.
ARCCore.IP.AllIPDerivedTypesARCCoreClassMemberAll relevant -IP--derived types for the whole application.
ARCCore.P.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PKHTMLAttributeP.EncoderARCCoreEnumMemberThe class doing the HTML-encoding.
AgoMail.EmailAgoMailClass 
ARCCore.IP.AllIPDerivedTypesWithPKEnumARCCoreClassMemberAll relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.ICreatedARCCoreClassA dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created-
ARCCore.PKLogAttributePARCCoreEnumDescribes class -PKLogAttribute.
AgoMail.Email.TryGetVAgoMailClassMemberNote 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.IP.AllIPDerivedTypesWithPKEnumApplicationSpecificARCCoreClassMemberAll relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCCore.PExact<EnumType>ARCCoreClassVery -MemoryConsumption- efficient alternative to -PRich-.
ARCCore.PKLogAttributeP.DoNotLogAtAllARCCoreEnumMemberOriginates from -DoNotLogAtAll-.
AgoMail.EmailP.TextBodyAgoMailEnumMember 
ARCCore.PCollectionARCCoreClassA class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.
ARCCore.PExact<EnumType>..ctorARCCoreClassMemberSet capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value)
ARCCore.PKLogAttributeP.CountIntervalARCCoreEnumMemberFor a value of n, log only every n'th time the property is changed.
AgoMail.EmailP.HTMLBodyAgoMailEnumMember 
ARCCore.PCollection.TrySetPPARCCoreClassMemberReplaces default interface method -TrySetPP-.
ARCCore.PExact<EnumType>.StorageARCCoreClassMemberUses int-value of -__enum- minus 1 as index.
ARCCore.PKLogAttributeP.TimeIntervalARCCoreEnumMemberSpecifies a certain time interval for which the property's value shall be sent over the -PropertyStream-.
AgoMail.EmailP.HeadersAgoMailEnumMember 
ARCCore.PCollection.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.PIIARCCoreClassPII = property for storing individual items.
ARCCore.PKRelAttributePARCCoreEnumDescribes class -PKRelAttribute-.
AgoMail.EmailP.AttachmentsAgoMailEnumMember 
ARCCore.PCollection.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.PII.TryGetVARCCoreClassMemberSince value is stored in keys, we need to override this method.
ARCCore.PKRelAttributeP.ForeignEntityARCCoreEnumMemberThe type of foreign entity that this property points to.
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCCore.PCollection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PII.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PKRelAttributeP.EnforceReferentialIntegrityARCCoreEnumMemberIf TRUE then referential integrity will be enforced by -TryStore-.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.IGetKeysEqualToValueARCCoreClassInterface 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.IPIIARCCoreClassFuture expansion, using different classes for storing, not only -PII-.
ARCCore.PKTypeAttributePARCCoreEnumDescribes class -PKTypeAttribute-.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCCore.PConcurrentARCCoreClassA (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-).
ARCCore.IIKIIARCCoreClassRelated to -PII-, property for storing individual items
ARCCore.PKTypeAttributeP.TypeARCCoreEnumMemberThe type of this Property.
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCCore.PConcurrent.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PValue<T>.ConvertObjectToStringARCCoreClassMemberConverts object to string.
ARCCore.ActualConnectionP.IdARCCoreEnumMemberWhen connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection.
Namespace AgoMail Namespace 
ARCCore.IIKII.PackParseResultForStorageInIKIIARCCoreClassMemberThis method corresponds to -PackParseResultForStorageInEntityObject-.
ARCCore.PValue<T>.ToStringARCCoreClassMemberDo no cache this value, because memory consumption would then increase significantly in your applicationj
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
Namespace AgoMail.Controllers Namespace 
ARCCore.IIKII.PackObjectForStorageInIKIIARCCoreClassMemberThis method corresponds to -PackObjectForStorageInEntityObject-.
ARCCore.PValue<T>.DeepCopyARCCoreClassMemberNote that if the generic type (T) is not immutable, then what we return will not be a truly deep copy
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCCore.PRichARCCoreClassFully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'.
ARCCore.PValue<T>..ctorARCCoreClassMemberNote how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide)
ARCCore.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCCore.PRich.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.PValueEmptyARCCoreClassRepresents the 'no value'.
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCCore.PRich.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PValueEmpty.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.PValue<T>ARCCoreClassSingle value storage.
ARCCore.PValueEmpty.ToPropertyStreamARCCoreClassMemberTypicall return value could be something like
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCCore.PValue<T>.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.ActualConnectionARCCoreClassThe actual connection, its internal state, queue for sending and so on.
ARCCore.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCCore.PValue<T>.TryGetVARCCoreClassMemberSupports duck typing.
ARCQuery.FunctionKeyAggregateCountARCQueryClassCounts the number of properties found.
ARCCore.ActualConnectionP.IsErrorConditionARCCoreEnumMemberSome kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCCore.ActualConnection.SetSinglePropertyStreamReceiverARCCoreClassMemberSet by -StreamProcessor-.
ARCQuery.FunctionKeyAggregateCount.SyntaxHelpARCQueryClassMember'Count()'
ARCCore.ActualConnectionP.ErrorConditionDataARCCoreEnumMemberDetailed explanation about -IsErrorCondition-
ARCCore.ActualConnection.SetUpToDatePositionGeneratorARCCoreClassMemberSet by -StreamProcessor-. Not used by -Client-.
ARCQuery.FunctionKeyAggregateDistinctARCQueryClassReturns a list of the distinct values of the given properties.
ARCCore.ActualConnectionP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed and reinitialized.
ARCCore.ActualConnection.InitializeOutgoingConnectionARCCoreClassMemberRelevant for -Outgoing-.
ARCQuery.FunctionKeyAggregateDistinct.SyntaxHelpARCQueryClassMember'Distinct()'
ARCCore.ActualConnectionP.MonkeyWrenchARCCoreEnumMember 
ARCCore.ActualConnection.CommunicateARCCoreClassMemberCommon for both -Incoming- and -Outgoing-.
ARCQuery.FunctionKeyAggregateJoinARCQueryClassJoins the given list of properties into a single property.
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCCore.ActualConnection.LogAndSendErrorConditionDataARCCoreClassMemberCalled when a serious error condition has been discovered and connection should be terminated.
ARCQuery.FunctionKeyAggregateJoin.SyntaxHelpARCQueryClassMember'Join()'
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCCore.ActualConnection.SendARCCoreClassMemberSends all messages in queue.
ARCQuery.FunctionKeyAggregateMaxARCQueryClassCalculates the maximum value of the given properties.
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.ActualConnection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.FunctionKeyAggregateMax.SyntaxHelpARCQueryClassMember'Max()'
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCCore.ActualConnection..ctorARCCoreClassMemberNote parameter-less constructor as desired for all classes inheriting -IP-.
ARCQuery.EntityMethodKey+MethodType.ComplexARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCCore.ClientUpdatePosition.IsGoBackARCCoreClassMemberHas to be translated by -StreamProcessor- into a concrete filename / index.
ARCQuery.QueryExpressionWhere+ValueEnumARCQueryEnumHelper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL).
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCCore.ClientUpdatePosition.IsAtEndOfStreamARCCoreClassMemberNecessary in order to implement -AdHocQuery-.
ARCQuery.QueryExpressionWhere+ValueEnum.NULLARCQueryEnumMember 
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstanceARCCoreClassMemberSee also -ClientDatastoreIsEmpty.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULLARCQueryEnumMemberPractical value enabling suggestions from -GetPrevious- and -GetNext-.
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.ClientUpdatePosition.OnlyNewDataIsRequestedInstanceARCCoreClassMemberSee also -OnlyNewDataIsRequested.
ARCQuery.QueryExpressionWhere+ValueEnum.ALLARCQueryEnumMemberEquivalent to query like WHERE Name = *

Generated 2025-11-07 07:52:17.690 UTC