Add new apis for getting information of remoteport 24/145324/11 preview1-00163
authorInkyun Kil <inkyun.kil@samsung.com>
Wed, 16 Aug 2017 11:15:38 +0000 (20:15 +0900)
committerInkyun Kil <inkyun.kil@samsung.com>
Thu, 7 Sep 2017 01:01:22 +0000 (01:01 +0000)
Change-Id: Ieaed48ac0e39db7d70ab8424b44c059a59a353b7
Signed-off-by: Inkyun Kil <inkyun.kil@samsung.com>
src/Tizen.Applications.MessagePort/Interop/Interop.MessagePort.cs
src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs
src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs [new file with mode: 0755]
src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePortStateChangedEventArgs.cs [new file with mode: 0755]

index bcbbc634437a57e18abc4fea2e2f5c119f468f79..564e7ba83e1c5ff32b43f2664abd37a00dd07fe4 100755 (executable)
@@ -41,7 +41,25 @@ internal static partial class Interop
         [DllImport(Libraries.MessagePort, EntryPoint = "message_port_send_trusted_message_with_local_port", CallingConvention = CallingConvention.Cdecl)]
         internal static extern int SendTrustedMessageWithLocalPort(string remote_app_id, string remote_port, SafeBundleHandle message, int local_port_id);
 
+        [DllImport(Libraries.MessagePort, EntryPoint = "message_port_check_remote_port", CallingConvention = CallingConvention.Cdecl)]
+        internal static extern int CheckRemotePort(string remote_app_id, string remote_port, out bool exist);
+
+        [DllImport(Libraries.MessagePort, EntryPoint = "message_port_check_trusted_remote_port", CallingConvention = CallingConvention.Cdecl)]
+        internal static extern int CheckTrustedRemotePort(string remote_app_id, string remote_port, out bool exist);
+
+        [DllImport(Libraries.MessagePort, EntryPoint = "message_port_add_registered_cb", CallingConvention = CallingConvention.Cdecl)]
+        internal static extern int AddRegisteredCallback(string remote_app_id, string remote_port, bool trusted_remote_port, message_port_registration_event_cb callback, IntPtr userData, out int watcher_id);
+
+        [DllImport(Libraries.MessagePort, EntryPoint = "message_port_add_unregistered_cb", CallingConvention = CallingConvention.Cdecl)]
+        internal static extern int AddUnregisteredCallback(string remote_app_id, string remote_port, bool trusted_remote_port, message_port_registration_event_cb callback, IntPtr userData, out int watcher_id);
+
+        [DllImport(Libraries.MessagePort, EntryPoint = "message_port_remove_registration_event_cb", CallingConvention = CallingConvention.Cdecl)]
+        internal static extern int RemoveRegistrationCallback(int watcher_id);
+
         [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
         internal delegate void message_port_message_cb(int local_port_id, string remote_app_id, string remote_port, bool trusted_remote_port, IntPtr message, IntPtr userData);
+
+        [UnmanagedFunctionPointer(CallingConvention.Cdecl)]
+        internal delegate void message_port_registration_event_cb(string remote_app_id, string remote_port, bool trusted_remote_port, IntPtr userData);
     }
 }
index c92362a4ac65a4a4be13c905acac77ba4fe6a96c..b429a88b43bf9cad0ee318746fa43ca9c46b8d29 100755 (executable)
@@ -183,7 +183,7 @@ namespace Tizen.Applications.Messages
         ///     message.AddItem("message", "a_string");
         ///     messagePort.Send(message, "ReceiverAppID", "ReceiverPort");
         /// }
-        /// messageProt.StopListening();
+        /// messagePort.StopListening();
         /// </code>
         public void StopListening()
         {
@@ -276,7 +276,7 @@ namespace Tizen.Applications.Messages
         }
 
         /// <summary>
-        /// Releases the unmanaged resource used by the MessagePort class specifying whether to perform a normal dispose operation.
+        /// Releases the unmanaged resources used by the MessagePort class specifying whether to perform a normal dispose operation.
         /// </summary>
         /// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
         protected virtual void Dispose(bool disposing)
diff --git a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs
new file mode 100755 (executable)
index 0000000..1d6d0d4
--- /dev/null
@@ -0,0 +1,313 @@
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.\
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Tizen.Applications.Messages
+{
+    using System;
+
+    /// <summary>
+    /// The RemotePort Class provides functions to get if the remote port is running and to get whether the remote port is registered or unregistered.
+    /// </summary>
+    /// <since_tizen> 4 </since_tizen>
+    public class RemotePort : IDisposable
+    {
+        private int _watcherIdForRegistered = -1;
+        private int _watcherIdForUnRegistered = -1;
+        private bool _disposed = false;
+
+        private Interop.MessagePort.message_port_registration_event_cb _registeredCallBack;
+        private Interop.MessagePort.message_port_registration_event_cb _unregisteredCallBack;
+
+        private EventHandler<RemotePortStateChangedEventArgs> _remotePortRegistered;
+        private EventHandler<RemotePortStateChangedEventArgs> _remotePortUnregistered;
+
+        private readonly string _portName = null;
+        private readonly string _appId = null;
+        private readonly bool _trusted = false;
+
+        private bool _isRunning = false;
+
+        /// <summary>
+        /// Constructor of the RemotePort class.
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        /// <param name="appId">The Id of the remote application</param>
+        /// <param name="portName">The name of the remote message port</param>
+        /// <param name="trusted">If true is the trusted message port of application, otherwise false</param>
+        /// <exception cref="System.InvalidOperationException">Thrown when appId is null or empty, when portName is null or empty</exception>
+        /// <code>
+        /// RemotePort remotePort = new RemotePort("org.tizen.example.messageport", "SenderPort", false);
+        /// </code>
+        public RemotePort(String appId, string portName, bool trusted)
+        {
+            if (String.IsNullOrEmpty(appId) || String.IsNullOrEmpty(portName))
+            {
+                MessagePortErrorFactory.ThrowException((int)MessagePortError.InvalidParameter, "Remote Port", "AppId or PortName");
+            }
+
+            _appId = appId;
+            _portName = portName;
+            _trusted = trusted;
+
+            _registeredCallBack = (string remoteAppId, string remotePortName, bool remoteTrusted, IntPtr userData) =>
+            {
+                RemotePortStateChangedEventArgs args = new RemotePortStateChangedEventArgs()
+                {
+                    Status = State.Registered
+                };
+
+                _remotePortRegistered?.Invoke(this, args);
+            };
+
+            _unregisteredCallBack = (string remoteAppId, string remotePortName, bool remoteTrusted, IntPtr userData) =>
+            {
+                RemotePortStateChangedEventArgs args = new RemotePortStateChangedEventArgs()
+                {
+                    Status = State.Unregistered
+                };
+
+                _remotePortUnregistered?.Invoke(this, args);
+            };
+        }
+
+        /// <summary>
+        /// Destructor of the RemotePort class.
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        ~RemotePort()
+        {
+            Dispose(false);
+        }
+
+        /// <summary>
+        /// The AppId of the remote port
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        /// <returns> Return appid of RemotePort </returns>
+        public string AppId
+        {
+            get
+            {
+                return _appId;
+            }
+        }
+
+        /// <summary>
+        /// The name of the remote message port
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        /// <returns> Return name of RemotePort </returns>
+        public string PortName
+        {
+            get
+            {
+                return _portName;
+            }
+        }
+
+        /// <summary>
+        /// If true the remote port is a trusted port, otherwise if false it is not
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        ///  <returns> Return true if RemotePort is trusted </returns>
+        public bool Trusted
+        {
+            get
+            {
+                return _trusted;
+            }
+        }
+
+        /// <summary>
+        /// Check if the remote message port is running.
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        /// <exception cref="System.InvalidOperationException">Thrown when out of memory, when there is an I/O error</exception>
+        /// <code>
+        /// Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);
+        /// bool isRunning = remotePort.isRunning();
+        /// </code>
+        /// <returns> Return true if Remote Port is running </returns>
+        public bool IsRunning()
+        {
+            int ret;
+
+            ret = _trusted ?
+                Interop.MessagePort.CheckTrustedRemotePort(_appId, _portName, out _isRunning) :
+                Interop.MessagePort.CheckRemotePort(_appId, _portName, out _isRunning);
+
+            if (ret != (int)MessagePortError.None)
+            {
+                MessagePortErrorFactory.ThrowException(ret);
+            }
+
+            return _isRunning;
+        }
+
+        /// <summary>
+        /// Called when the remote port is registered or unregistered.
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        /// <exception cref="System.InvalidOperationException">Thrown when out of memory, when there is an I/O error</exception>
+        /// <code>
+        /// Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);
+        /// remotePort.RemotePortStateChanged += RemotePortStateChangedCallback;
+        /// static void RemotePortStateChangedCallback(object sender, MessageReceivedEventArgs e)
+        /// {
+        ///     switch (e.Status)
+        ///     {
+        ///     case State.Registered :
+        ///         Console.WriteLine("Remote Port Registered ");
+        ///         break;
+        ///     case State.Unregistered :
+        ///         Console.WriteLine("Remote Port Unregistered ");
+        ///         break;
+        ///     default :
+        ///         break;
+        ///     }
+        /// }
+        /// </code>
+        public event EventHandler<RemotePortStateChangedEventArgs> RemotePortStateChanged
+        {
+            add
+            {
+                if (_remotePortRegistered == null)
+                {
+                    int ret = AddRegistrationCallback();
+
+                    if (ret != (int)MessagePortError.None)
+                    {
+                        MessagePortErrorFactory.ThrowException(ret);
+                    }
+                }
+
+                _remotePortRegistered += value;
+                _remotePortUnregistered += value;
+            }
+
+            remove
+            {
+                if (_remotePortRegistered?.GetInvocationList()?.Length > 0)
+                {
+                    _remotePortRegistered -= value;
+                    _remotePortUnregistered -= value;
+
+                    if (_remotePortRegistered == null)
+                    {
+                        RemoveRegistrationCallback();
+                    }
+                }
+            }
+        }
+
+        private int AddRegistrationCallback()
+        {
+            if (_watcherIdForRegistered != -1)
+            {
+                Interop.MessagePort.RemoveRegistrationCallback(_watcherIdForRegistered);
+                _watcherIdForRegistered = -1;
+            }
+
+            int ret = Interop.MessagePort.AddRegisteredCallback(_appId, _portName, _trusted, _registeredCallBack, IntPtr.Zero, out _watcherIdForRegistered);
+
+            if (ret != (int)MessagePortError.None)
+            {
+                return ret;
+            }
+
+            if (_watcherIdForUnRegistered != -1)
+            {
+                Interop.MessagePort.RemoveRegistrationCallback(_watcherIdForUnRegistered);
+                _watcherIdForUnRegistered = -1;
+            }
+
+            ret = Interop.MessagePort.AddUnregisteredCallback(_appId, _portName, _trusted, _unregisteredCallBack, IntPtr.Zero, out _watcherIdForUnRegistered);
+
+            if (ret != (int)MessagePortError.None)
+            {
+                return ret;
+            }
+
+            return ret;
+        }
+
+        private void RemoveRegistrationCallback()
+        {
+            if (_watcherIdForRegistered != -1 && _watcherIdForUnRegistered != -1)
+            {
+                int ret = Interop.MessagePort.RemoveRegistrationCallback(_watcherIdForRegistered);
+
+                if (ret != (int)MessagePortError.None)
+                {
+                    MessagePortErrorFactory.ThrowException(ret);
+                }
+
+                _watcherIdForRegistered = -1;
+
+                ret = Interop.MessagePort.RemoveRegistrationCallback(_watcherIdForUnRegistered);
+
+                if (ret != (int)MessagePortError.None)
+                {
+                    MessagePortErrorFactory.ThrowException(ret);
+                }
+
+                _watcherIdForUnRegistered = -1;
+            }
+        }
+
+        /// <summary>
+        /// Releases the unmanaged resources used by the RemotePort class specifying whether to perform a normal dispose operation.
+        /// </summary>
+        /// <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>
+        protected virtual void Dispose(bool disposing)
+        {
+            if (_disposed)
+            {
+                return;
+            }
+
+            RemoveRegistrationCallback();
+
+            _disposed = true;
+        }
+
+        /// <summary>
+        /// Releases all resources used by the RemotePort class.
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+    }
+
+    /// <summary>
+    /// Enumeration for Remote Message Port state type
+    /// </summary>
+    /// <since_tizen> 4 </since_tizen>
+    public enum State : Byte
+    {
+        /// <summary>
+        /// Value representing Remote Port state is unregistered
+        /// </summary>
+        Unregistered = 0,
+        /// <summary>
+        /// Value representing Remote Port state is registered
+        /// </summary>
+        Registered = 1
+    }
+}
diff --git a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePortStateChangedEventArgs.cs b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePortStateChangedEventArgs.cs
new file mode 100755 (executable)
index 0000000..b679eb8
--- /dev/null
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.\
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Tizen.Applications.Messages
+{
+    using System;
+
+    /// <summary>
+    /// An extended EventArgs class which contains state of remote message port
+    /// </summary>
+    /// <since_tizen> 4 </since_tizen>
+    public class RemotePortStateChangedEventArgs : EventArgs
+    {
+        /// <summary>
+        /// The State of remote port
+        /// </summary>
+        /// <since_tizen> 4 </since_tizen>
+        public State Status { get; internal set; }
+    }
+}