/ doc / toc / ARCCore / Class / StreamProcessor / OutsideLocalReceiver

OutsideLocalReceiver

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 outside (in the sense outside of this class) local mechanism which receives all -PropertyStreamLine- registered by this class.0x000D0x000A(except changes with -HasLocalOrigin-.)0x000D0x000A0x000D0x000AThe 'outside' implementation will typically store data to a -PRich- instance through -ParseAndStore-.0x000D0x000A0x000D0x000ASet this method when you want an always-up-to-date in-memory object collection of your data.0x000D0x000AMost relevant for -Client-.0x000D0x000AAlso relevant for -ArmDB- (see -AdHocQuery-).0x000D0x000A0x000D0x000AIf this method is set, then incoming data will be stored both to disk (unless -DoNotStoreLocally- is TRUE) and sent to this method.0x000D0x000AAlso, at application startup (-StartTCPIPCommunication-), all data from disk will be sent to this method.0x000D0x000A0x000D0x000ARationale for not distributing -HasLocalOrigin- via this method:0x000D0x000AIf local originated content also was sent to this method, it would most probably have been sent twice, after a round-trip to -CoreDB- and back, resulting in duplicate updates to the (presumed -PRich-) outside's storage. The 'outside' can instead choose whether to update its presumed -PRich- storage immediately or not, by just calling this method itself whenever it also calls -ReceiveAndDistribute-
__TOCDet/DocFragType = ClassMember
__TOCDet/IsInherited = False
__TOCDet/IsInheritedDoc = False
__TOCDet/Lines = 58
__TOCDet/LongDescription = Remember thread-safety regarding use of this method.0x000D0x000A0x000D0x000APossible implementions on outside could be:0x000D0x000A0x000D0x000A1) Approach suitable for a processor, running in a continous loop:0x000D0x000A0x000D0x000A   var queue = new System.Collections.Concurrent.ConcurrentQueue0x003Cstring0x003E()0x003B0x000D0x000A   myStreamProcessorInstance.OutsideLocalReceiver = s =0x003E queue.Enqueue(s)0x003B0x000D0x000A0x000D0x000AYou can then pick up from the queue inside your continous processing loop in a thread-safe manner, for instance like this:0x000D0x000A0x000D0x000A   var dataStorage = new PRich()0x003B0x000D0x000A   while (true) 0x007B // Your continous processing loop0x000D0x000A      DoTask1(dataStorage)0x003B  // Task1 may freely access dataStorage (within calling thread)0x000D0x000A      DoTask2(dataStorage)0x003B  // Task2 may freely access dataStorage (within calling thread)0x000D0x000A      while (queue.TryDequeue(out var s)) PropertyStreamLine.ParseAndStore(dataStorage, s)0x003B0x000D0x000A   0x007D0x000D0x000A0x000D0x000A0x000D0x000A2) Approach suitable for an API with incoming requests occuring on multiple threads:0x000D0x000A(simplified code)0x000D0x000A0x000D0x000A    var lock = new System.Threading.ReaderWriterLockSlim()0x003B0x000D0x000A   var dataStorage = new PRich()0x003B0x000D0x000A   myStreamProcessorInstance.OutsideLocalReceiver = s =0x003E 0x007B0x000D0x000A      try 0x007B0x000D0x000A         lock.EnterWriteLock()0x003B0x000D0x000A         PropertyStreamLine.ParseAndStore(_storage, s)0x003B0x000D0x000A      0x007D finally 0x007B0x000D0x000A         lock.ExitWriteLock()0x003B0x000D0x000A      0x007D0x000D0x000A   0x007D0x003B0x000D0x000A0x000D0x000AYou must also remember to acquire the corresponding lock (lock.EnterReadLock or lock.EnterWriteLock) when processing API methods, for instance like this:0x000D0x000A   public APIResponse ServeAPIMethod(APIRequest request) 0x007B0x000D0x000A       try 0x007B0x000D0x000A           lock.EnterReadLock()0x003B0x000D0x000A           return dataStorage.Query(request)0x003B0x000D0x000A       0x007D finally 0x007B0x000D0x000A           lock.ExitReadLock()0x003B0x000D0x000A       0x007D0x000D0x000A   0x007D0x000D0x000A0x000D0x000A
__TOCDet/Name = OutsideLocalReceiver
__TOCDet/Namespace = ARCCore
__TOCDet/Type = StreamProcessor
__TOCDet/Attribute/DeclaringType = StreamProcessor
__TOCDet/Attribute/Description = The outside (in the sense outside of this class) local mechanism which receives all -PropertyStreamLine- registered by this class.0x000D0x000A(except changes with -HasLocalOrigin-.)0x000D0x000A0x000D0x000AThe 'outside' implementation will typically store data to a -PRich- instance through -ParseAndStore-.0x000D0x000A0x000D0x000ASet this method when you want an always-up-to-date in-memory object collection of your data.0x000D0x000AMost relevant for -Client-.0x000D0x000AAlso relevant for -ArmDB- (see -AdHocQuery-).0x000D0x000A0x000D0x000AIf this method is set, then incoming data will be stored both to disk (unless -DoNotStoreLocally- is TRUE) and sent to this method.0x000D0x000AAlso, at application startup (-StartTCPIPCommunication-), all data from disk will be sent to this method.0x000D0x000A0x000D0x000ARationale for not distributing -HasLocalOrigin- via this method:0x000D0x000AIf local originated content also was sent to this method, it would most probably have been sent twice, after a round-trip to -CoreDB- and back, resulting in duplicate updates to the (presumed -PRich-) outside's storage. The 'outside' can instead choose whether to update its presumed -PRich- storage immediately or not, by just calling this method itself whenever it also calls -ReceiveAndDistribute-
__TOCDet/Attribute/LongDescription = Remember thread-safety regarding use of this method.0x000D0x000A0x000D0x000APossible implementions on outside could be:0x000D0x000A0x000D0x000A1) Approach suitable for a processor, running in a continous loop:0x000D0x000A0x000D0x000A   var queue = new System.Collections.Concurrent.ConcurrentQueue0x003Cstring0x003E()0x003B0x000D0x000A   myStreamProcessorInstance.OutsideLocalReceiver = s =0x003E queue.Enqueue(s)0x003B0x000D0x000A0x000D0x000AYou can then pick up from the queue inside your continous processing loop in a thread-safe manner, for instance like this:0x000D0x000A0x000D0x000A   var dataStorage = new PRich()0x003B0x000D0x000A   while (true) 0x007B // Your continous processing loop0x000D0x000A      DoTask1(dataStorage)0x003B  // Task1 may freely access dataStorage (within calling thread)0x000D0x000A      DoTask2(dataStorage)0x003B  // Task2 may freely access dataStorage (within calling thread)0x000D0x000A      while (queue.TryDequeue(out var s)) PropertyStreamLine.ParseAndStore(dataStorage, s)0x003B0x000D0x000A   0x007D0x000D0x000A0x000D0x000A0x000D0x000A2) Approach suitable for an API with incoming requests occuring on multiple threads:0x000D0x000A(simplified code)0x000D0x000A0x000D0x000A    var lock = new System.Threading.ReaderWriterLockSlim()0x003B0x000D0x000A   var dataStorage = new PRich()0x003B0x000D0x000A   myStreamProcessorInstance.OutsideLocalReceiver = s =0x003E 0x007B0x000D0x000A      try 0x007B0x000D0x000A         lock.EnterWriteLock()0x003B0x000D0x000A         PropertyStreamLine.ParseAndStore(_storage, s)0x003B0x000D0x000A      0x007D finally 0x007B0x000D0x000A         lock.ExitWriteLock()0x003B0x000D0x000A      0x007D0x000D0x000A   0x007D0x003B0x000D0x000A0x000D0x000AYou must also remember to acquire the corresponding lock (lock.EnterReadLock or lock.EnterWriteLock) when processing API methods, for instance like this:0x000D0x000A   public APIResponse ServeAPIMethod(APIRequest request) 0x007B0x000D0x000A       try 0x007B0x000D0x000A           lock.EnterReadLock()0x003B0x000D0x000A           return dataStorage.Query(request)0x003B0x000D0x000A       0x007D finally 0x007B0x000D0x000A           lock.ExitReadLock()0x003B0x000D0x000A       0x007D0x000D0x000A   0x007D0x000D0x000A0x000D0x000A
__TOCDet/Attribute/MethodName = OutsideLocalReceiver
__TOCDet/Attribute/MethodSignature = System.Action0x006010x005BSystem.String0x005D OutsideLocalReceiver

Edit single sub keys only: __TOCDet

Generated 2025-11-03 15:39:14.388 UTC