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

ritchiecarroll committed 12 years ago

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

Unified · Split

3 files

Source/Libraries/GSF.ServiceProcess/ClientHelper.cs +25 −3
Source/Libraries/GSF.ServiceProcess/ServiceHelper.cs +33 −5
Source/Libraries/GSF.TimeSeries/UI/WindowsServiceClient.cs +6 −0

Source/Libraries/GSF.ServiceProcess/ClientHelper.cs+25−3

         private ClientBase m_remotingClient;
         private string m_username;
         private string m_password;
+        private SerializationFormat m_serializationFormat;
         private bool m_persistSettings;
         private string m_settingsCategory;
         private bool m_attemptReconnection;
             }
         }
+        /// <summary>
+        /// Gets or sets a value that indicates the desired message <see cref="GSF.SerializationFormat"/> for interaction with <see cref="ServiceHelper"/>.
+        /// </summary>
+        [Category("Settings"),
+        DefaultValue(ServiceHelper.DefaultSerializationFormat),
+        Description("Indicates messaging serialization format for interactions with ServiceHelper.")]
+        public SerializationFormat SerializationFormat
+        {
+            get
+            {
+                return m_serializationFormat;
+            }
+            set
+            {
+                m_serializationFormat = value;
+            }
+        }
         /// <summary>
         /// Gets or sets a boolean value that indicates whether the settings of <see cref="ClientHelper"/> are to be saved to the config file.
         /// </summary>
                 settings["Username", true].Update(m_username);
                 settings["Password", true].Update(m_password);
+                settings["SerializationFormat", true].Update(m_serializationFormat);
                 settings["Username"].Scope = SettingScope.User;
                 settings["Password"].Scope = SettingScope.User;
                 settings.Add("Username", m_username, "Username to be used for authentication with the service.", false, SettingScope.User);
                 settings.Add("Password", m_password, "Password to be used for authentication with the service.", true, SettingScope.User);
+                settings.Add("SerializationFormat", m_password, "Message serialization format for interactions with service, one of: Xml, Json or Binary. Default is Binary.");
                 Username = settings["Username"].ValueAs(m_username);
                 Password = settings["Password"].ValueAs(m_password);
+                SerializationFormat = settings["SerializationFormat"].ValueAs(m_serializationFormat);
             }
         }
         {
             ServiceResponse response;
-            Serialization.TryDeserialize(e.Argument1.BlockCopy(0, e.Argument2), SerializationFormat.Binary, out response);
+            Serialization.TryDeserialize(e.Argument1.BlockCopy(0, e.Argument2), m_serializationFormat, out response);
             if ((object)response != null)
             {
         }
         /// <summary>
-        /// Attempts to parse an actionable reponse sent from the service.
+        /// Attempts to parse an actionable response sent from the service.
         /// </summary>
         /// <param name="serviceResponse"><see cref="ServiceResponse"/> to test for actionable response.</param>
         /// <param name="sourceCommand">Command that invoked <paramref name="serviceResponse"/>.</param>
                 // Attempt to parse response message
                 if (!string.IsNullOrWhiteSpace(response))
                 {
-                    // Reponse types are formatted as "Command:Success" or "Command:Failure"
+                    // Response types are formatted as "Command:Success" or "Command:Failure"
                     string[] parts = response.Split(':');
                     if (parts.Length > 1)

Source/Libraries/GSF.ServiceProcess/ServiceHelper.cs+33−5

         /// </summary>
         public const bool DefaultSecureRemoteInteractions = false;
+        /// <summary>
+        /// Specifies the default value for the <see cref="ServiceHelper.SerializationFormat"/> property.
+        /// </summary>
+        public const SerializationFormat DefaultSerializationFormat = SerializationFormat.Binary;
         /// <summary>
         /// Specifies the default value for the <see cref="PersistSettings"/> property.
         /// </summary>
         private bool m_supportTelnetSessions;
         private bool m_supportSystemCommands;
         private bool m_secureRemoteInteractions;
+        private SerializationFormat m_serializationFormat;
         private bool m_persistSettings;
         private string m_settingsCategory;
         private string m_telnetSessionPassword;
         private readonly Dictionary<ISupportLifecycle, bool> m_componentEnabledStates;
         private TryGetClientPrincipalFunctionSignature m_tryGetClientPrincipalFunction;
         private readonly ProcessQueue<StatusUpdate> m_statusUpdateQueue;
-        private bool m_enabled;
-        private bool m_disposed;
-        private bool m_initialized;
         private bool m_suppressUpdates;
         private Guid m_remoteCommandClientID;
         private Process m_remoteCommandProcess;
         private Ticks m_lastStatusUpdateTime;
         private long m_statusUpdateCount;
         private bool m_supressStatusUpdates;
+        private bool m_enabled;
+        private bool m_initialized;
+        private bool m_disposed;
         #endregion
             m_supportTelnetSessions = DefaultSupportTelnetSessions;
             m_supportSystemCommands = DefaultSupportSystemCommands;
             m_secureRemoteInteractions = DefaultSecureRemoteInteractions;
+            m_serializationFormat = DefaultSerializationFormat;
             m_persistSettings = DefaultPersistSettings;
             m_settingsCategory = DefaultSettingsCategory;
             m_processes = new List<ServiceProcess>();
             }
         }
+        /// <summary>
+        /// Gets or sets a value that indicates the desired message <see cref="GSF.SerializationFormat"/> for interaction with <see cref="ClientHelper"/>.
+        /// </summary>
+        [Category("Settings"),
+        DefaultValue(DefaultSerializationFormat),
+        Description("Indicates messaging serialization format for interactions with ClientHelper.")]
+        public SerializationFormat SerializationFormat
+        {
+            get
+            {
+                return m_serializationFormat;
+            }
+            set
+            {
+                m_serializationFormat = value;
+            }
+        }
         /// <summary>
         /// Gets or sets a boolean value that indicates whether the settings of <see cref="ServiceHelper"/> are to be saved to the config file.
         /// </summary>
             settings["SupportTelnetSessions", true].Update(m_supportTelnetSessions);
             settings["SupportSystemCommands", true].Update(m_supportSystemCommands);
             settings["SecureRemoteInteractions", true].Update(m_secureRemoteInteractions);
+            settings["SerializationFormat", true].Update(m_serializationFormat);
             config.Save();
         }
             settings.Add("SupportTelnetSessions", m_supportTelnetSessions, "True to enable the support for remote telnet-like sessions; otherwise False.");
             settings.Add("SupportSystemCommands", m_supportSystemCommands, "True to enable system-level access (-system switch) via the build-in commands; otherwise False.");
             settings.Add("SecureRemoteInteractions", m_secureRemoteInteractions, "True to enable security of remote client interactions; otherwise False.");
+            settings.Add("SerializationFormat", m_serializationFormat, "Message serialization format for interactions with clients, one of: Xml, Json or Binary. Default is Binary.");
             if ((object)settings["TelnetSessionPassword"] != null)
                 m_telnetSessionPassword = settings["TelnetSessionPassword"].ValueAs(m_telnetSessionPassword);
             SupportTelnetSessions = settings["SupportTelnetSessions"].ValueAs(m_supportTelnetSessions);
             SupportSystemCommands = settings["SupportSystemCommands"].ValueAs(m_supportSystemCommands);
             SecureRemoteInteractions = settings["SecureRemoteInteractions"].ValueAs(m_secureRemoteInteractions);
+            SerializationFormat = settings["SerializationFormat"].ValueAs(m_serializationFormat);
         }
         /// <summary>
             if ((object)client == null)
             {
                 // First message from a remote client should be its info.
-                Serialization.TryDeserialize(e.Argument2.BlockCopy(0, e.Argument3), SerializationFormat.Binary, out client);
+                Serialization.TryDeserialize(e.Argument2.BlockCopy(0, e.Argument3), m_serializationFormat, out client);
                 try
                 {
                 ClientRequest request;
                 ClientRequestInfo requestInfo = null;
-                Serialization.TryDeserialize(e.Argument2.BlockCopy(0, e.Argument3), SerializationFormat.Binary, out request);
+                Serialization.TryDeserialize(e.Argument2.BlockCopy(0, e.Argument3), m_serializationFormat, out request);
                 if ((object)request != null)
                 {

Source/Libraries/GSF.TimeSeries/UI/WindowsServiceClient.cs+6−0

         {
             // Initialize status cache members.
             Dictionary<string, string> settings = connectionString.ParseKeyValuePairs();
+            SerializationFormat serializationFormat;
             string setting;
             if (settings.TryGetValue("statusBufferSize", out setting) && !string.IsNullOrWhiteSpace(setting))
             else
                 m_remotingClient = InitializeTcpClient(connectionString);
+            // Parse out desired message serialization format, if specified
+            if (!settings.TryGetValue("serializationFormat", out setting) || !Enum.TryParse(setting, true, out serializationFormat))
+                serializationFormat = SerializationFormat.Binary;
             // Initialize windows service client.
             m_clientHelper = new ClientHelper();
+            m_clientHelper.SerializationFormat = serializationFormat;
             m_clientHelper.RemotingClient = m_remotingClient;
             m_clientHelper.ReceivedServiceUpdate += ClientHelper_ReceivedServiceUpdate;
         }

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

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code