MockPlugin.SampleList.RemotePluginService Class Reference

Example for communication with external programs. More...

Inheritance diagram for MockPlugin.SampleList.RemotePluginService:

Collaboration diagram for MockPlugin.SampleList.RemotePluginService:

Public Member Functions
bool	DoSomething (string someParameter)
	Just uses a messagebox to show the external request.

Static Public Member Functions
static void	StopService ()

Static Private Member Functions
static void	HostFaultedHandler (object sender, EventArgs e)

Private Attributes
System.Windows.Forms.Form	mMainWindow

Static Private Attributes
static ServiceHost	mHost

Detailed Description

Example for communication with external programs.

This example uses WCF to show how you can trigger actions within the plugin from external programs. See RemoteAccessTester.MessageTesterForm for the client side. Please note that WCF will be discontinued by Microsoft, the server components will not be part of .Net Core in the future. So, while this is a working example for current Chronos releases, you should maybe not base a new project on this method of interprocess communication, but switch to something else like gRPC or an ASP.net WebAPI. Attention: This example service does not use any kind of access control. Do not do this for real applications, as it allows access from unauthorized sources and is a security problem. Access control is not addressed here to put the focus on the core issue: How to make plugin provided functionality available to external software.

Definition at line 22 of file RemoteServiceImplementation.cs.

Member Function Documentation

DoSomething()

bool MockPlugin.SampleList.RemotePluginService.DoSomething

(

string

someParameter

)

Just uses a messagebox to show the external request.

Parameters

someParameter

Returns

Implements MockPlugin.RemoteAccessTester.IMockPlugin.

Definition at line 30 of file RemoteServiceImplementation.cs.

        {
            if (mMainWindow == null)
            {
                mMainWindow = System.Windows.Forms.Control.FromHandle(System.Diagnostics.Process.GetCurrentProcess().MainWindowHandle) as System.Windows.Forms.Form;
            }
            // Just a few manipulations of the main window
            if (mMainWindow != null)
            {
                someParameter = someParameter.ToLowerInvariant();
                switch(someParameter)
                {
                    case "hide":
                        mMainWindow.Hide();
                        break;
                    case "show":
                        mMainWindow.Show();
                        break;
                    case "min":
                        mMainWindow.WindowState = System.Windows.Forms.FormWindowState.Minimized;
                        break;
                    case "max":
                        mMainWindow.WindowState = System.Windows.Forms.FormWindowState.Maximized;
                        break;
                }
            }
            else
            {
                System.Windows.Forms.MessageBox.Show("Could not get main window");
            }
            return System.Windows.Forms.MessageBox.Show(
                       $"Plugin does something on remote request: {someParameter}\nSucceeded?", 
                       "Remote request to plugin", 
                       System.Windows.Forms.MessageBoxButtons.YesNo) == System.Windows.Forms.DialogResult.Yes;
        }

References mMainWindow.

HostFaultedHandler()

void MockPlugin.SampleList.RemotePluginService.HostFaultedHandler ( object sender, EventArgs e )

staticprivate

Definition at line 66 of file RemoteServiceImplementation.cs.

        {
            System.Diagnostics.Trace.WriteLine("Remote plugin service failed.");
        }

StopService()

void MockPlugin.SampleList.RemotePluginService.StopService ( )

static

Definition at line 81 of file RemoteServiceImplementation.cs.

        {
            try
            {
                if (mHost?.State == CommunicationState.Opened)
                {
                    mHost?.Close();
                }
            }
            catch 
            {
                // nothing
            }
        }

References mHost.

Referenced by MockPlugin.SampleList.MockSampleListWorker.Dispose().

Member Data Documentation

mHost

ServiceHost MockPlugin.SampleList.RemotePluginService.mHost

staticprivate

Definition at line 65 of file RemoteServiceImplementation.cs.

Referenced by StopService().

mMainWindow

System.Windows.Forms.Form MockPlugin.SampleList.RemotePluginService.mMainWindow

private

Definition at line 24 of file RemoteServiceImplementation.cs.

Referenced by DoSomething().

---

The documentation for this class was generated from the following file:

• RemoteServiceImplementation.cs