/ doc / toc / ARCCore / Class / ActualConnection

ActualConnection

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/Assembly = ARCCore
__TOCDet/Description = The actual connection, its internal state, queue for sending and so on.0x000D0x000A
__TOCDet/DocFragType = Class
__TOCDet/LongDescription = TODO: May 2020: The code in this class should be tidied up a bit before any more functionality is added.0x000D0x000A0x000D0x000ANote how this class inherits -PConcurrent- which offers thread-safe access to properties (and is also able to -ExposingApplicationState- to outside).
__TOCDet/Name = ActualConnection
__TOCDet/Namespace = ARCCore
__TOCDet/Type = ActualConnection
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/BaseTypes = PConcurrent
__TOCDet/Attribute/ClassNamespace = ARCCore
__TOCDet/Attribute/ClassType = ActualConnection
__TOCDet/Attribute/CorrespondingEnumType = ActualConnectionP
__TOCDet/Attribute/Description = The actual connection, its internal state, queue for sending and so on.0x000D0x000A
__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
__TOCDet/Attribute/LongDescription = TODO: May 2020: The code in this class should be tidied up a bit before any more functionality is added.0x000D0x000A0x000D0x000ANote how this class inherits -PConcurrent- which offers thread-safe access to properties (and is also able to -ExposingApplicationState- to outside).
.ctor/__TOCDet/Assembly = ARCCore
.ctor/__TOCDet/Description = Note parameter-less constructor as desired for all classes inheriting -IP-.
.ctor/__TOCDet/DocFragType = ClassMember
.ctor/__TOCDet/IsInherited = False
.ctor/__TOCDet/IsInheritedDoc = False
.ctor/__TOCDet/Lines = 1
.ctor/__TOCDet/Name = .ctor
.ctor/__TOCDet/Namespace = ARCCore
.ctor/__TOCDet/Type = ActualConnection
.ctor/__TOCDet/Attribute/DeclaringType = ActualConnection
.ctor/__TOCDet/Attribute/Description = Note parameter-less constructor as desired for all classes inheriting -IP-.
.ctor/__TOCDet/Attribute/MethodName = .ctor
.ctor/__TOCDet/Attribute/MethodSignature = Void .ctor()
Communicate/__TOCDet/Assembly = ARCCore
Communicate/__TOCDet/Description = Common for both -Incoming- and -Outgoing-.0x000D0x000A-Client- must be set.0x000D0x000ASets -Writer- in order for -Send- to work.
Communicate/__TOCDet/DocFragType = ClassMember
Communicate/__TOCDet/IsInherited = False
Communicate/__TOCDet/IsInheritedDoc = False
Communicate/__TOCDet/Lines = 3
Communicate/__TOCDet/Name = Communicate
Communicate/__TOCDet/Namespace = ARCCore
Communicate/__TOCDet/Type = ActualConnection
Communicate/__TOCDet/Attribute/DeclaringType = ActualConnection
Communicate/__TOCDet/Attribute/Description = Common for both -Incoming- and -Outgoing-.0x000D0x000A-Client- must be set.0x000D0x000ASets -Writer- in order for -Send- to work.
Communicate/__TOCDet/Attribute/MethodName = Communicate
Communicate/__TOCDet/Attribute/MethodSignature = System.Threading.Tasks.Task Communicate()
InitializeOutgoingConnection/__TOCDet/Assembly = ARCCore
InitializeOutgoingConnection/__TOCDet/Description = Relevant for -Outgoing-.
InitializeOutgoingConnection/__TOCDet/DocFragType = ClassMember
InitializeOutgoingConnection/__TOCDet/IsInherited = False
InitializeOutgoingConnection/__TOCDet/IsInheritedDoc = False
InitializeOutgoingConnection/__TOCDet/Lines = 1
InitializeOutgoingConnection/__TOCDet/Name = InitializeOutgoingConnection
InitializeOutgoingConnection/__TOCDet/Namespace = ARCCore
InitializeOutgoingConnection/__TOCDet/Type = ActualConnection
InitializeOutgoingConnection/__TOCDet/Attribute/DeclaringType = ActualConnection
InitializeOutgoingConnection/__TOCDet/Attribute/Description = Relevant for -Outgoing-.
InitializeOutgoingConnection/__TOCDet/Attribute/MethodName = InitializeOutgoingConnection
InitializeOutgoingConnection/__TOCDet/Attribute/MethodSignature = Void InitializeOutgoingConnection()
LogAndSendErrorConditionData/__TOCDet/Assembly = ARCCore
LogAndSendErrorConditionData/__TOCDet/Description = Called when a serious error condition has been discovered and connection should be terminated.0x000D0x000APerforms the following functions:0x000D0x000A1) Logs to the given log object parameter.0x000D0x000A2) Informs client over TCP/IP connection about -IsErrorCondition- by sending several -PropertyStreamLine-.0x000D0x000A3) Marks connection with -IsErrorCondition-. 
LogAndSendErrorConditionData/__TOCDet/DocFragType = ClassMember
LogAndSendErrorConditionData/__TOCDet/IsInherited = False
LogAndSendErrorConditionData/__TOCDet/IsInheritedDoc = False
LogAndSendErrorConditionData/__TOCDet/Lines = 5
LogAndSendErrorConditionData/__TOCDet/Name = LogAndSendErrorConditionData
LogAndSendErrorConditionData/__TOCDet/Namespace = ARCCore
LogAndSendErrorConditionData/__TOCDet/Type = ActualConnection
LogAndSendErrorConditionData/__TOCDet/Attribute/DeclaringType = ActualConnection
LogAndSendErrorConditionData/__TOCDet/Attribute/Description = Called when a serious error condition has been discovered and connection should be terminated.0x000D0x000APerforms the following functions:0x000D0x000A1) Logs to the given log object parameter.0x000D0x000A2) Informs client over TCP/IP connection about -IsErrorCondition- by sending several -PropertyStreamLine-.0x000D0x000A3) Marks connection with -IsErrorCondition-. 
LogAndSendErrorConditionData/__TOCDet/Attribute/MethodName = LogAndSendErrorConditionData
LogAndSendErrorConditionData/__TOCDet/Attribute/MethodSignature = Void LogAndSendErrorConditionData(ARCCore.IP, System.Collections.Generic.IEnumerable0x006010x005BARCCore.IK0x005D, System.Collections.Generic.IEnumerable0x006010x005BSystem.ValueTuple0x006020x005BSystem.String,System.String0x005D0x005D, System.String)
Send/__TOCDet/Assembly = ARCCore
Send/__TOCDet/Description = Sends all messages in queue.0x000D0x000A1) Adds the given message to the queue and 0x000D0x000A2) Empties the queue asynchronously.0x000D0x000AEmptying is done by ensuring that there is a thead running that continously send messages until the queue is empty (not how this thread exists as soon as the queue is empty)0x000D0x000ATODO: If we are -Outgoing-, queue messages to disk also if many elements in queue.TODO: At application startup, put those messages into the queue again, before accepting new messages.TODO: This should all be managed autonomusly within this class.
Send/__TOCDet/DocFragType = ClassMember
Send/__TOCDet/IsInherited = False
Send/__TOCDet/IsInheritedDoc = False
Send/__TOCDet/Lines = 5
Send/__TOCDet/Name = Send
Send/__TOCDet/Namespace = ARCCore
Send/__TOCDet/Type = ActualConnection
Send/__TOCDet/Attribute/DeclaringType = ActualConnection
Send/__TOCDet/Attribute/Description = Sends all messages in queue.0x000D0x000A1) Adds the given message to the queue and 0x000D0x000A2) Empties the queue asynchronously.0x000D0x000AEmptying is done by ensuring that there is a thead running that continously send messages until the queue is empty (not how this thread exists as soon as the queue is empty)0x000D0x000ATODO: If we are -Outgoing-, queue messages to disk also if many elements in queue.TODO: At application startup, put those messages into the queue again, before accepting new messages.TODO: This should all be managed autonomusly within this class.
Send/__TOCDet/Attribute/MethodName = Send
Send/__TOCDet/Attribute/MethodSignature = Void Send(System.String)
SetMyUpdatePositionGenerator/__TOCDet/Assembly = ARCCore
SetMyUpdatePositionGenerator/__TOCDet/Description = Set by -StreamProcessor-.0x000D0x000ANot relevant for -Incoming-.
SetMyUpdatePositionGenerator/__TOCDet/DocFragType = ClassMember
SetMyUpdatePositionGenerator/__TOCDet/IsInherited = False
SetMyUpdatePositionGenerator/__TOCDet/IsInheritedDoc = False
SetMyUpdatePositionGenerator/__TOCDet/Lines = 2
SetMyUpdatePositionGenerator/__TOCDet/Name = SetMyUpdatePositionGenerator
SetMyUpdatePositionGenerator/__TOCDet/Namespace = ARCCore
SetMyUpdatePositionGenerator/__TOCDet/Type = ActualConnection
SetMyUpdatePositionGenerator/__TOCDet/Attribute/DeclaringType = ActualConnection
SetMyUpdatePositionGenerator/__TOCDet/Attribute/Description = Set by -StreamProcessor-.0x000D0x000ANot relevant for -Incoming-.
SetMyUpdatePositionGenerator/__TOCDet/Attribute/MethodName = SetMyUpdatePositionGenerator
SetMyUpdatePositionGenerator/__TOCDet/Attribute/MethodSignature = Void SetMyUpdatePositionGenerator(System.Func0x006010x005BARCCore.ClientUpdatePosition0x005D)
SetSinglePropertyStreamReceiver/__TOCDet/Assembly = ARCCore
SetSinglePropertyStreamReceiver/__TOCDet/Description = Set by -StreamProcessor-.0x000D0x000ARelevant for both -Incoming- and -Outgoing-.
SetSinglePropertyStreamReceiver/__TOCDet/DocFragType = ClassMember
SetSinglePropertyStreamReceiver/__TOCDet/IsInherited = False
SetSinglePropertyStreamReceiver/__TOCDet/IsInheritedDoc = False
SetSinglePropertyStreamReceiver/__TOCDet/Lines = 2
SetSinglePropertyStreamReceiver/__TOCDet/Name = SetSinglePropertyStreamReceiver
SetSinglePropertyStreamReceiver/__TOCDet/Namespace = ARCCore
SetSinglePropertyStreamReceiver/__TOCDet/Type = ActualConnection
SetSinglePropertyStreamReceiver/__TOCDet/Attribute/DeclaringType = ActualConnection
SetSinglePropertyStreamReceiver/__TOCDet/Attribute/Description = Set by -StreamProcessor-.0x000D0x000ARelevant for both -Incoming- and -Outgoing-.
SetSinglePropertyStreamReceiver/__TOCDet/Attribute/MethodName = SetSinglePropertyStreamReceiver
SetSinglePropertyStreamReceiver/__TOCDet/Attribute/MethodSignature = Void SetSinglePropertyStreamReceiver(System.Action0x006010x005BSystem.String0x005D)
SetUpToDatePositionGenerator/__TOCDet/Assembly = ARCCore
SetUpToDatePositionGenerator/__TOCDet/Description = Set by -StreamProcessor-. Not used by -Client-.0x000D0x000ANot relevant for -Outgoing-.0x000D0x000AWill generate the up-to-date position for the property stream.0x000D0x000A0x000D0x000ANecessary in order for the server to turn -OnlyNewDataIsRequested- into correct position as soon as it is receive by client (it would for instance be too late if -StreamProcessor- tried to do it by itself when updating clients, because new data may have been received in the meantime, meaning position would have been set 'too-far' into the property stream).
SetUpToDatePositionGenerator/__TOCDet/DocFragType = ClassMember
SetUpToDatePositionGenerator/__TOCDet/IsInherited = False
SetUpToDatePositionGenerator/__TOCDet/IsInheritedDoc = False
SetUpToDatePositionGenerator/__TOCDet/Lines = 5
SetUpToDatePositionGenerator/__TOCDet/Name = SetUpToDatePositionGenerator
SetUpToDatePositionGenerator/__TOCDet/Namespace = ARCCore
SetUpToDatePositionGenerator/__TOCDet/Type = ActualConnection
SetUpToDatePositionGenerator/__TOCDet/Attribute/DeclaringType = ActualConnection
SetUpToDatePositionGenerator/__TOCDet/Attribute/Description = Set by -StreamProcessor-. Not used by -Client-.0x000D0x000ANot relevant for -Outgoing-.0x000D0x000AWill generate the up-to-date position for the property stream.0x000D0x000A0x000D0x000ANecessary in order for the server to turn -OnlyNewDataIsRequested- into correct position as soon as it is receive by client (it would for instance be too late if -StreamProcessor- tried to do it by itself when updating clients, because new data may have been received in the meantime, meaning position would have been set 'too-far' into the property stream).
SetUpToDatePositionGenerator/__TOCDet/Attribute/MethodName = SetUpToDatePositionGenerator
SetUpToDatePositionGenerator/__TOCDet/Attribute/MethodSignature = Void SetUpToDatePositionGenerator(System.Func0x006010x005BARCCore.ClientUpdatePosition0x005D)
ToString/__TOCDet/Assembly = ARCCore
ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
ToString/__TOCDet/DocFragType = ClassMember
ToString/__TOCDet/IsInherited = True
ToString/__TOCDet/IsInheritedDoc = True
ToString/__TOCDet/Name = ToString
ToString/__TOCDet/Namespace = ARCCore
ToString/__TOCDet/Type = ActualConnection
ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
ToString/__TOCDet/Attribute/MethodName = ToString
ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()

Edit single sub keys only: __TOCDet / .ctor / Communicate / InitializeOutgoingConnection / LogAndSendErrorConditionData / Send / SetMyUpdatePositionGenerator / SetSinglePropertyStreamReceiver / SetUpToDatePositionGenerator / ToString

Generated 2025-05-24 05:14:42.630 UTC