History

GSF.ServiceProcess: Added customizable message serialization format to ServiceHelper and ClientHelper.

ritchiecarroll committed 12 years ago

Commit bcb45dd1 parent 1b7f0693 files · +64 −8Browse files

Showing the changes to Source/Libraries/GSF.ServiceProcess/ServiceHelper.cs (1 of 3 files). Show all

Unified · Split

Source/Libraries/GSF.ServiceProcess/ServiceHelper.cs+33−5
@@ -225,6 +225,11 @@ namespace GSF.ServiceProcess · 224 unmodified lines
225225 /// </summary>
226226 public const bool DefaultSecureRemoteInteractions = false;
227227
228+ /// <summary>
229+ /// Specifies the default value for the <see cref="ServiceHelper.SerializationFormat"/> property.
230+ /// </summary>
231+ public const SerializationFormat DefaultSerializationFormat = SerializationFormat.Binary;
232+
228233 /// <summary>
229234 /// Specifies the default value for the <see cref="PersistSettings"/> property.
230235 /// </summary>
@@ -353,6 +358,7 @@ namespace GSF.ServiceProcess · 122 unmodified lines
353358 private bool m_supportTelnetSessions;
354359 private bool m_supportSystemCommands;
355360 private bool m_secureRemoteInteractions;
361+ private SerializationFormat m_serializationFormat;
356362 private bool m_persistSettings;
357363 private string m_settingsCategory;
358364 private string m_telnetSessionPassword;
@@ -370,15 +376,15 @@ namespace GSF.ServiceProcess · 11 unmodified lines
370376 private readonly Dictionary<ISupportLifecycle, bool> m_componentEnabledStates;
371377 private TryGetClientPrincipalFunctionSignature m_tryGetClientPrincipalFunction;
372378 private readonly ProcessQueue<StatusUpdate> m_statusUpdateQueue;
373− private bool m_enabled;
374− private bool m_disposed;
375− private bool m_initialized;
376379 private bool m_suppressUpdates;
377380 private Guid m_remoteCommandClientID;
378381 private Process m_remoteCommandProcess;
379382 private Ticks m_lastStatusUpdateTime;
380383 private long m_statusUpdateCount;
381384 private bool m_supressStatusUpdates;
385+ private bool m_enabled;
386+ private bool m_initialized;
387+ private bool m_disposed;
382388
383389 #endregion
384390
@@ -399,6 +405,7 @@ namespace GSF.ServiceProcess · 14 unmodified lines
399405 m_supportTelnetSessions = DefaultSupportTelnetSessions;
400406 m_supportSystemCommands = DefaultSupportSystemCommands;
401407 m_secureRemoteInteractions = DefaultSecureRemoteInteractions;
408+ m_serializationFormat = DefaultSerializationFormat;
402409 m_persistSettings = DefaultPersistSettings;
403410 m_settingsCategory = DefaultSettingsCategory;
404411 m_processes = new List<ServiceProcess>();
@@ -622,6 +629,24 @@ namespace GSF.ServiceProcess · 217 unmodified lines
622629 }
623630 }
624631
632+ /// <summary>
633+ /// Gets or sets a value that indicates the desired message <see cref="GSF.SerializationFormat"/> for interaction with <see cref="ClientHelper"/>.
634+ /// </summary>
635+ [Category("Settings"),
636+ DefaultValue(DefaultSerializationFormat),
637+ Description("Indicates messaging serialization format for interactions with ClientHelper.")]
638+ public SerializationFormat SerializationFormat
639+ {
640+ get
641+ {
642+ return m_serializationFormat;
643+ }
644+ set
645+ {
646+ m_serializationFormat = value;
647+ }
648+ }
649+
625650 /// <summary>
626651 /// Gets or sets a boolean value that indicates whether the settings of <see cref="ServiceHelper"/> are to be saved to the config file.
627652 /// </summary>
@@ -1049,6 +1074,7 @@ namespace GSF.ServiceProcess · 421 unmodified lines
10491074 settings["SupportTelnetSessions", true].Update(m_supportTelnetSessions);
10501075 settings["SupportSystemCommands", true].Update(m_supportSystemCommands);
10511076 settings["SecureRemoteInteractions", true].Update(m_secureRemoteInteractions);
1077+ settings["SerializationFormat", true].Update(m_serializationFormat);
10521078 config.Save();
10531079 }
10541080
@@ -1103,6 +1129,7 @@ namespace GSF.ServiceProcess · 48 unmodified lines
11031129 settings.Add("SupportTelnetSessions", m_supportTelnetSessions, "True to enable the support for remote telnet-like sessions; otherwise False.");
11041130 settings.Add("SupportSystemCommands", m_supportSystemCommands, "True to enable system-level access (-system switch) via the build-in commands; otherwise False.");
11051131 settings.Add("SecureRemoteInteractions", m_secureRemoteInteractions, "True to enable security of remote client interactions; otherwise False.");
1132+ settings.Add("SerializationFormat", m_serializationFormat, "Message serialization format for interactions with clients, one of: Xml, Json or Binary. Default is Binary.");
11061133
11071134 if ((object)settings["TelnetSessionPassword"] != null)
11081135 m_telnetSessionPassword = settings["TelnetSessionPassword"].ValueAs(m_telnetSessionPassword);
@@ -1116,6 +1143,7 @@ namespace GSF.ServiceProcess · 7 unmodified lines
11161143 SupportTelnetSessions = settings["SupportTelnetSessions"].ValueAs(m_supportTelnetSessions);
11171144 SupportSystemCommands = settings["SupportSystemCommands"].ValueAs(m_supportSystemCommands);
11181145 SecureRemoteInteractions = settings["SecureRemoteInteractions"].ValueAs(m_secureRemoteInteractions);
1146+ SerializationFormat = settings["SerializationFormat"].ValueAs(m_serializationFormat);
11191147 }
11201148
11211149 /// <summary>
@@ -2146,7 +2174,7 @@ namespace GSF.ServiceProcess · 1024 unmodified lines
21462174 if ((object)client == null)
21472175 {
21482176 // First message from a remote client should be its info.
2149− Serialization.TryDeserialize(e.Argument2.BlockCopy(0, e.Argument3), SerializationFormat.Binary, out client);
2177+ Serialization.TryDeserialize(e.Argument2.BlockCopy(0, e.Argument3), m_serializationFormat, out client);
21502178
21512179 try
21522180 {
@@ -2210,7 +2238,7 @@ namespace GSF.ServiceProcess · 57 unmodified lines
22102238 ClientRequest request;
22112239 ClientRequestInfo requestInfo = null;
22122240
2213− Serialization.TryDeserialize(e.Argument2.BlockCopy(0, e.Argument3), SerializationFormat.Binary, out request);
2241+ Serialization.TryDeserialize(e.Argument2.BlockCopy(0, e.Argument3), m_serializationFormat, out request);
22142242
22152243 if ((object)request != null)
22162244 {

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t