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

120 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.PKTypeAttributeP.TypeARCCoreEnumMemberThe type of this Property.
ARCCore.EnumMemberAttribute.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.PKTypeAttributeP.DefaultValueARCCoreEnumMemberThe default value.
ARCCore.EnumMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKTypeAttributeP.CardinalityARCCoreEnumMemberDescribes how multiple instances of a property is supposed to be handled.
ARCCore.EnumMemberAttribute.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.PKTypeAttributeP.IsObligatoryARCCoreEnumMemberTrue means value is obligatory.
ARCCore.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
ARCCore.PKTypeAttributeP.BoilerplateCodePropertiesARCCoreEnumMemberAutomatically generated boilerplate code that implements traditional setters and getters for this key.
ARCCore.CardinalityExtensionsARCCoreClass 
ARCCore.PPARCCoreEnumDescribes meta data for any class (property) implementing -IP-.
ARCCore.CardinalityExtensions.IsMultipleARCCoreClassMemberReturns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.PP.CreatedARCCoreEnumMemberTimestamp when property was created in database.
ARCCore.ExtensionsARCCoreClassContains a few general nice to have extensions methods.
ARCCore.PP.CidARCCoreEnumMemberCreator id (entity which created this property).
ARCCore.Extensions.ToStringShortARCCoreClassMemberReturns a shorter representation than -ToStringDB-.
ARCCore.PP.ValueARCCoreEnumMemberThe actual value.
ARCCore.Extensions.ToStringVeryShortARCCoreClassMemberReturns same as -ToStringShort- but without any generics information at all.
ARCCore.PP.ValidARCCoreEnumMemberTimestamp when property was last known to be (still) valid
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.PP.VidARCCoreEnumMemberValidator id, that is entity which set -Valid- for this property.
ARCCore.Extensions.ForEachARCCoreClassMemberUseful when we want to write collection.ForEach( ... ) instead of
ARCCore.PP.InvalidARCCoreEnumMemberTimestamp when property was invalidated / 'deleted'.
ARCCore.Extensions.UseARCCoreClassMemberConvenience method that shortens down code in cases where an instance of an object must be created first in order to use that same variable multiple times
ARCCore.PP.IidARCCoreEnumMemberInvalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01').
ARCCore.Extensions.AddValueARCCoreClassMemberGives better error messages compared to 'original' Add when adding a value to a directory if key already exists
ARCCore.PP.ExceptionTextARCCoreEnumMemberGeneral property for logging of exceptions, usually set through -HandleException-.
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.PConcurrentPARCCoreEnumDescribes class -PConcurrent-.
ARCCore.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.PConcurrentP.HeartbeatARCCoreEnumMember 
ARCCore.Extensions.SingleARCCoreClassMemberSame as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.ActualConnectionPARCCoreEnumDescribes class -ActualConnection-.
ARCCore.Extensions.SingleOrDefaultARCCoreClassMemberSame as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
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.
ARCCore.Extensions.ResultARCCoreClassMemberReturns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
ARCCore.Extensions.ToStringDateAndTimeARCCoreClassMemberUses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCCore.Extensions.ToStringWithMSARCCoreClassMemberUses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not.
ARCCore.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCCore.IKIPARCCoreClassContainer class for key (-IK-), and value (-IP-).
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCCore.IKIP.AssertTypeIntegrityARCCoreClassMemberSee -TryAssertTypeIntegrity- for documentation.
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCCore.IKARCCoreClassIK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCCore.IKCodedARCCoreClassUnderstands coded and unencoded variants of -IK-.
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.IKCoded.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.ActualConnectionP.ErrorConditionDataARCCoreEnumMemberDetailed explanation about -IsErrorCondition-
ARCCore.IKCoded.TryCheckValidEncodedValueARCCoreClassMemberChecks if encoded value is valid.
ARCCore.ActualConnectionP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed and reinitialized.
ARCCore.IKCoded.FromCacheEncodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.ActualConnectionP.MonkeyWrenchARCCoreEnumMember 
ARCCore.IKCoded.FromCacheUnencodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCCore.IKCoded.FromEncodedARCCoreClassMemberNote how uses instance cache if already exists there.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCCore.IKCoded.TryEncodeARCCoreClassMemberReturns a string containing only characters in -AllowedEncodedCharacters-.
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.IKCoded.ToStringARCCoreClassMemberReturns -Encoded-'s string representation.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCCore.IKCoded.EncodedARCCoreClassMemberThis string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCCore.IKCoded.AllowedEncodedCharactersARCCoreClassMemberThe character set 'A...Za...z0...9-_().,='.
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCCore.IKDateARCCoreClassA more memory efficient alternative to -IKString- (together with -IKLong-).
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCCore.IKDate.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
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.IKDate.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.ConnectionInstructionP.MultipleConnectionUsageARCCoreEnumMember 
ARCCore.IKDate.ValidDateTimeFormatsARCCoreClassMemberNote: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK.
ARCCore.ConnectionInstructionP.ShardingARCCoreEnumMember 
ARCCore.IKLongARCCoreClassA more memory efficient alternative to -IKString-.
ARCCore.MultipleConnectionUsageARCCoreEnumEnables fault-tolerance by describing use of multiple connections
ARCCore.IKLong.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.MultipleConnectionUsage.AdminARCCoreEnumMemberConnection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCCore.IKLong.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.MultipleConnectionUsage.RoundRobinARCCoreEnumMemberThis connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCCore.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
ARCCore.MultipleConnectionUsage.SimultaneousARCCoreEnumMemberThis connection to be used simultaneously with other connections with -Simultaneous-
ARCCore.IKString.FromCacheARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.StreamProcessorPARCCoreEnumDescribes class -StreamProcessor-.
ARCCore.IKString.FromStringARCCoreClassMemberNote how uses instance cache if already exists there
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCCore.IKString.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCCore.IKString.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.IKTypeARCCoreClassIndex key used when storing a collection of a given type, like 'Customer'.
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCCore.IKType.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.ITypeDescriberARCCoreClassProvides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.StreamProcessorP.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCCore.ParseResult.ResultARCCoreClassMemberWill be null if ErrorResponse is set.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.ParseResult.ErrorResponseARCCoreClassMemberWill be null if Result is set
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCCore.PK.TryGetEnumARCCoreClassMemberNote that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key.
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCCore.PK.TryGetVARCCoreClassMemberOnly type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.PK.TryGetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute-.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinalityARCCoreClassMemberCalled from -Initialize- after _cleaner and _validatorAndParser have been set.
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCCore.PK.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.

Generated 2025-12-05 23:29:49.077 UTC