/ doc / toc / ARCCore / Enum / ARConcepts / ExposingApplicationState

ExposingApplicationState

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 traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.0x000D0x000A0x000D0x000AAgoRapide instead encourages logs and application state to be distributed over the -PropertyStream- by default, thereby making debugging simpler (the information is always available, and not restricted to some local access).0x000D0x000A0x000D0x000AYou are encouraged to expose your internal application state to the -PropertyStream- through the use of -Logger- (and possible also use -PKLogAttribute-) like in -PConcurrent-.0x000D0x000AIt is recommended to prefix these data points by -app-.0x000D0x000A0x000D0x000AThis has two implications (as implemented by -PConcurrent-):0x000D0x000A1) Any call to -Log- / -HandleException- ends up in the property stream.0x000D0x000A2) Any change to internal properties will be reflected in the property stream automatically without even having to make 'manual' calls to -Log- (because all calls to -SetP- will automatically be logged to the property stream).0x000D0x000A0x000D0x000ASome example classes inheriting -PConcurrent- and using this principle in AgoRapide are:0x000D0x000A0x000D0x000A-StreamProcessor- (search for code like 'IP.SetPV(StreamProcessorP.ClientUpdatePositionPath ...)0x000D0x000A-ActualConnection- (search for code like 'IP.Inc(ActualConnectionP.CountReceiveMessage)')0x000D0x000A0x000D0x000AIn summary, much of the inner working of these classes are automatically exposed to the property stream without any special code having to be added.0x000D0x000ANote how manual calls to -Log- are also automatically exposed to the property stream in these classes.0x000D0x000ANote how threads are always given a descriptive name in these classes, making the logging even easier to follow.0x000D0x000A0x000D0x000AAll this makes debugging and understanding the inner workings of your applications much easier reducing the need for external logging and debugging tools.0x000D0x000A0x000D0x000ANote also that by exposing the internal application state to the -PropertyStream- it can be read 'from' wherever convenient. 0x000D0x000AIn other words, you do not have to limit use of -IP- to only data-objects like 'Customer', 'Order' and similar, but you can also use it for internal parts of your application.0x000D0x000A0x000D0x000ANote that calls to -Log- will by default not be exposed to the -PropertyStream-.0x000D0x000ASee also0x000D0x000A-app-.0x000D0x000A-ExceptionText-, -Heartbeat-, 0x000D0x000A-Log-, -HandleException-
__TOCDet/DocFragType = EnumMember
__TOCDet/Name = ExposingApplicationState
__TOCDet/Namespace = ARCCore
__TOCDet/Type = ARConcepts
__TOCDet/Attribute/Description = The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.0x000D0x000A0x000D0x000AAgoRapide instead encourages logs and application state to be distributed over the -PropertyStream- by default, thereby making debugging simpler (the information is always available, and not restricted to some local access).0x000D0x000A0x000D0x000AYou are encouraged to expose your internal application state to the -PropertyStream- through the use of -Logger- (and possible also use -PKLogAttribute-) like in -PConcurrent-.0x000D0x000AIt is recommended to prefix these data points by -app-.0x000D0x000A0x000D0x000AThis has two implications (as implemented by -PConcurrent-):0x000D0x000A1) Any call to -Log- / -HandleException- ends up in the property stream.0x000D0x000A2) Any change to internal properties will be reflected in the property stream automatically without even having to make 'manual' calls to -Log- (because all calls to -SetP- will automatically be logged to the property stream).0x000D0x000A0x000D0x000ASome example classes inheriting -PConcurrent- and using this principle in AgoRapide are:0x000D0x000A0x000D0x000A-StreamProcessor- (search for code like 'IP.SetPV(StreamProcessorP.ClientUpdatePositionPath ...)0x000D0x000A-ActualConnection- (search for code like 'IP.Inc(ActualConnectionP.CountReceiveMessage)')0x000D0x000A0x000D0x000AIn summary, much of the inner working of these classes are automatically exposed to the property stream without any special code having to be added.0x000D0x000ANote how manual calls to -Log- are also automatically exposed to the property stream in these classes.0x000D0x000ANote how threads are always given a descriptive name in these classes, making the logging even easier to follow.0x000D0x000A0x000D0x000AAll this makes debugging and understanding the inner workings of your applications much easier reducing the need for external logging and debugging tools.0x000D0x000A0x000D0x000ANote also that by exposing the internal application state to the -PropertyStream- it can be read 'from' wherever convenient. 0x000D0x000AIn other words, you do not have to limit use of -IP- to only data-objects like 'Customer', 'Order' and similar, but you can also use it for internal parts of your application.0x000D0x000A0x000D0x000ANote that calls to -Log- will by default not be exposed to the -PropertyStream-.0x000D0x000ASee also0x000D0x000A-app-.0x000D0x000A-ExceptionText-, -Heartbeat-, 0x000D0x000A-Log-, -HandleException-
__TOCDet/Attribute/EnumMember = ExposingApplicationState
__TOCDet/Attribute/EnumType = ARConcepts

Edit single sub keys only: __TOCDet

Generated 2024-06-01 21:55:40.474 UTC