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/ClientHelper.cs (1 of 3 files). Show all

Unified · Split

Source/Libraries/GSF.ServiceProcess/ClientHelper.cs+25−3
@@ -156,6 +156,7 @@ namespace GSF.ServiceProcess · 155 unmodified lines
156156 private ClientBase m_remotingClient;
157157 private string m_username;
158158 private string m_password;
159+ private SerializationFormat m_serializationFormat;
159160 private bool m_persistSettings;
160161 private string m_settingsCategory;
161162 private bool m_attemptReconnection;
@@ -274,6 +275,24 @@ namespace GSF.ServiceProcess · 112 unmodified lines
274275 }
275276 }
276277
278+ /// <summary>
279+ /// Gets or sets a value that indicates the desired message <see cref="GSF.SerializationFormat"/> for interaction with <see cref="ServiceHelper"/>.
280+ /// </summary>
281+ [Category("Settings"),
282+ DefaultValue(ServiceHelper.DefaultSerializationFormat),
283+ Description("Indicates messaging serialization format for interactions with ServiceHelper.")]
284+ public SerializationFormat SerializationFormat
285+ {
286+ get
287+ {
288+ return m_serializationFormat;
289+ }
290+ set
291+ {
292+ m_serializationFormat = value;
293+ }
294+ }
295+
277296 /// <summary>
278297 /// Gets or sets a boolean value that indicates whether the settings of <see cref="ClientHelper"/> are to be saved to the config file.
279298 /// </summary>
@@ -423,6 +442,7 @@ namespace GSF.ServiceProcess · 143 unmodified lines
423442
424443 settings["Username", true].Update(m_username);
425444 settings["Password", true].Update(m_password);
445+ settings["SerializationFormat", true].Update(m_serializationFormat);
426446
427447 settings["Username"].Scope = SettingScope.User;
428448 settings["Password"].Scope = SettingScope.User;
@@ -450,9 +470,11 @@ namespace GSF.ServiceProcess · 21 unmodified lines
450470
451471 settings.Add("Username", m_username, "Username to be used for authentication with the service.", false, SettingScope.User);
452472 settings.Add("Password", m_password, "Password to be used for authentication with the service.", true, SettingScope.User);
473+ settings.Add("SerializationFormat", m_password, "Message serialization format for interactions with service, one of: Xml, Json or Binary. Default is Binary.");
453474
454475 Username = settings["Username"].ValueAs(m_username);
455476 Password = settings["Password"].ValueAs(m_password);
477+ SerializationFormat = settings["SerializationFormat"].ValueAs(m_serializationFormat);
456478 }
457479 }
458480
@@ -686,7 +708,7 @@ namespace GSF.ServiceProcess · 227 unmodified lines
686708 {
687709 ServiceResponse response;
688710
689− Serialization.TryDeserialize(e.Argument1.BlockCopy(0, e.Argument2), SerializationFormat.Binary, out response);
711+ Serialization.TryDeserialize(e.Argument1.BlockCopy(0, e.Argument2), m_serializationFormat, out response);
690712
691713 if ((object)response != null)
692714 {
@@ -792,7 +814,7 @@ namespace GSF.ServiceProcess · 99 unmodified lines
792814 }
793815
794816 /// <summary>
795− /// Attempts to parse an actionable reponse sent from the service.
817+ /// Attempts to parse an actionable response sent from the service.
796818 /// </summary>
797819 /// <param name="serviceResponse"><see cref="ServiceResponse"/> to test for actionable response.</param>
798820 /// <param name="sourceCommand">Command that invoked <paramref name="serviceResponse"/>.</param>
@@ -812,7 +834,7 @@ namespace GSF.ServiceProcess · 13 unmodified lines
812834 // Attempt to parse response message
813835 if (!string.IsNullOrWhiteSpace(response))
814836 {
815− // Reponse types are formatted as "Command:Success" or "Command:Failure"
837+ // Response types are formatted as "Command:Success" or "Command:Failure"
816838 string[] parts = response.Split(':');
817839
818840 if (parts.Length > 1)

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