source: branches/eraser6/Manager/RemoteExecutor.cs @ 748

Revision 748, 12.7 KB checked in by lowjoel, 6 years ago (diff)

Implement a proper asynchronous wait handler for connections.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
Line 
1/*
2 * $Id$
3 * Copyright 2008 The Eraser Project
4 * Original Author: Kasra Nassiri <cjax@users.sourceforge.net>
5 * Modified By: Joel Low <lowjoel@users.sourceforge.net>
6 * Modified By:
7 *
8 * This file is part of Eraser.
9 *
10 * Eraser is free software: you can redistribute it and/or modify it under the
11 * terms of the GNU General Public License as published by the Free Software
12 * Foundation, either version 3 of the License, or (at your option) any later
13 * version.
14 *
15 * Eraser is distributed in the hope that it will be useful, but WITHOUT ANY
16 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 *
19 * A copy of the GNU General Public License can be found at
20 * <http://www.gnu.org/licenses/>.
21 */
22
23using System;
24using System.IO;
25using System.Text;
26using System.IO.Pipes;
27using System.Threading;
28using System.Collections.Generic;
29
30using System.Runtime.Serialization;
31using System.Runtime.Remoting.Messaging;
32using System.Runtime.Serialization.Formatters.Binary;
33
34namespace Eraser.Manager
35{
36    /// <summary>
37    /// Represents a request to the RemoteExecutorServer instance
38    /// </summary>
39    [Serializable]
40    internal class RemoteRequest
41    {
42        /// <summary>
43        /// List of supported functions
44        /// </summary>
45        public enum Function : uint
46        {
47            ADD_TASK = 0,
48            GET_TASK,
49            GET_TASKS,
50            CANCEL_TASK,
51            DELETE_TASK,
52            QUEUE_TASK,
53            REPLACE_TASK,
54            SCHEDULE_TASK,
55            SAVE_TASK_LIST,
56            LOAD_TASK_LIST,
57            QUEUE_RESTART_TASK,
58        }
59
60        /// <summary>
61        /// Constructor.
62        /// </summary>
63        /// <param name="func">The function this command is wanting to execute.</param>
64        /// <param name="data">The parameters for the command, serialised using a
65        /// BinaryFormatter</param>
66        public RemoteRequest(Function func, byte[] data)
67        {
68            Func = func;
69            Data = data;
70        }
71
72        /// <summary>
73        /// The function that this request is meant to call.
74        /// </summary>
75        public Function Func;
76
77        /// <summary>
78        /// The parameters associated with the function call.
79        /// </summary>
80        public byte[] Data;
81    };
82
83    /// <summary>
84    /// The RemoteExecutorServer class is the server half required for remote execution
85    /// of tasks.
86    /// </summary>
87    public class RemoteExecutorServer : DirectExecutor
88    {
89        /// <summary>
90        /// Our Remote Server name, prevent collisions!
91        /// </summary>
92        public static readonly string ServerName =
93            "Eraser-FB6C5A7D-E47F-475f-ABA4-58F4D24BB67E-RemoteExecutor-" +
94            System.Security.Principal.WindowsIdentity.GetCurrent().User.ToString();
95
96        /// <summary>
97        /// The thread which will answer pipe connections
98        /// </summary>
99        private Thread thread = null;
100
101        /// <summary>
102        /// Our pipe instance which handles connections.
103        /// </summary>
104        private NamedPipeServerStream server;
105
106        /// <summary>
107        /// Constructor.
108        /// </summary>
109        public RemoteExecutorServer()
110        {
111            server = new NamedPipeServerStream(ServerName, PipeDirection.InOut, 4,
112                PipeTransmissionMode.Byte, PipeOptions.Asynchronous);
113
114            thread = new Thread(Main);
115            thread.Start();
116            Thread.Sleep(0);
117        }
118
119        public override void Dispose()
120        {
121            thread.Abort();
122            base.Dispose();
123        }
124
125        /// <summary>
126        /// The polling loop dealing with every server connection.
127        /// </summary>
128        private void Main()
129        {
130            while (Thread.CurrentThread.ThreadState != ThreadState.AbortRequested)
131            {
132                //Wait for a connection to be established
133                if (!server.IsConnected)
134                {
135                    IAsyncResult asyncWait = server.BeginWaitForConnection(
136                        EndWaitForConnection, null);
137                    while (!server.IsConnected && !asyncWait.AsyncWaitHandle.WaitOne(15))
138                        if (Thread.CurrentThread.ThreadState == ThreadState.AbortRequested)
139                            break;
140                }
141
142                //If we still aren't connected that means the connection failed to establish.
143                if (!server.IsConnected)
144                    continue;
145
146                //Read the request into the buffer.
147                RemoteRequest request = null;
148                using (MemoryStream mstream = new MemoryStream())
149                {
150                    byte[] buffer = new byte[65536];
151                    server.Read(buffer, 0, sizeof(int));
152                    int messageSize = BitConverter.ToInt32(buffer, 0);
153                    while (messageSize > 0)
154                    {
155                        int lastRead = server.Read(buffer, 0, Math.Min(messageSize, buffer.Length));
156                        messageSize -= lastRead;
157                        mstream.Write(buffer, 0, lastRead);
158                    }
159
160                    //Ignore the request if the client disconnected from us.
161                    if (!server.IsConnected)
162                        continue;
163
164                    //Deserialise the header of the request.
165                    mstream.Position = 0;
166                    try
167                    {
168                        request = (RemoteRequest)new BinaryFormatter().Deserialize(
169                            new MemoryStream(buffer));
170                    }
171                    catch (SerializationException)
172                    {
173                        //We got a unserialisation issue but we can't do anything about it.
174                        continue;
175                    }
176                }
177
178                #region Deserialise
179                object parameter = null;
180                switch (request.Func)
181                {
182                    // void \+ task
183                    case RemoteRequest.Function.CANCEL_TASK:
184                    case RemoteRequest.Function.QUEUE_TASK:
185                    case RemoteRequest.Function.REPLACE_TASK:
186                    case RemoteRequest.Function.SCHEDULE_TASK:
187                    case RemoteRequest.Function.ADD_TASK:
188                        using (MemoryStream mStream = new MemoryStream(request.Data))
189                            parameter = new BinaryFormatter().Deserialize(mStream);
190                        break;
191
192                    // bool \+ taskid
193                    case RemoteRequest.Function.DELETE_TASK:
194                    // task \+ taskid
195                    case RemoteRequest.Function.GET_TASK:
196                        using (MemoryStream mStream = new MemoryStream(request.Data))
197                            parameter = new BinaryFormatter().Deserialize(mStream);
198                        break;
199
200                    // void \+ stream
201                    case RemoteRequest.Function.LOAD_TASK_LIST:
202                    case RemoteRequest.Function.SAVE_TASK_LIST:
203                        using (MemoryStream mStream = new MemoryStream(request.Data))
204                            parameter = new BinaryFormatter().Deserialize(mStream);
205                        break;
206
207                    // list<task> \+ void
208                    case RemoteRequest.Function.GET_TASKS:
209                    // void \+ void
210                    case RemoteRequest.Function.QUEUE_RESTART_TASK:
211                        break;
212
213                    default:
214                        throw new FatalException("Unknown RemoteExecutorClient.Function");
215                }
216                #endregion
217
218                #region Invoke
219                object returnValue = null;
220                switch (request.Func)
221                {
222                    // void \+ task
223                    case RemoteRequest.Function.CANCEL_TASK:
224                        CancelTask((Task)parameter);
225                        break;
226
227                    // void \+ task
228                    case RemoteRequest.Function.QUEUE_TASK:
229                        QueueTask((Task)parameter);
230                        break;
231
232                    // void \+ task
233                    case RemoteRequest.Function.REPLACE_TASK:
234                        ReplaceTask((Task)parameter);
235                        break;
236
237                    // void \+ task
238                    case RemoteRequest.Function.SCHEDULE_TASK:
239                        ScheduleTask((Task)parameter);
240                        break;
241
242                    // void \+ ref task
243                    case RemoteRequest.Function.ADD_TASK:
244                    {
245                        Task task = (Task)parameter;
246                        AddTask(ref task);
247                        break;
248                    }
249
250                    // bool \+ taskid
251                    case RemoteRequest.Function.DELETE_TASK:
252                        returnValue = DeleteTask((uint)parameter);
253                        break;
254
255                    // task \+ taskid
256                    case RemoteRequest.Function.GET_TASK:
257                        returnValue = GetTask((uint)parameter);
258                        break;
259
260                    // void \+ stream
261                    case RemoteRequest.Function.LOAD_TASK_LIST:
262                        LoadTaskList((Stream)parameter);
263                        break;
264
265                    // void \+ stream
266                    case RemoteRequest.Function.SAVE_TASK_LIST:
267                        SaveTaskList((Stream)parameter);
268                        break;
269
270                    // list<task> \+ void
271                    case RemoteRequest.Function.GET_TASKS:
272                        returnValue = GetTasks();
273                        break;
274
275                    // void \+ void
276                    case RemoteRequest.Function.QUEUE_RESTART_TASK:
277                        QueueRestartTasks();
278                        break;
279
280                    default:
281                        throw new FatalException("Unknown RemoteExecutorClient.Function");
282                #endregion
283                }
284
285                //Return the result of the invoked function, if any.
286                if (returnValue != null)
287                    using (MemoryStream mStream = new MemoryStream())
288                    {
289                        new BinaryFormatter().Serialize(mStream, returnValue);
290                        byte[] buffer = mStream.ToArray();
291                        byte[] bufferLength = BitConverter.GetBytes(buffer.Length);
292                        server.Write(bufferLength, 0, sizeof(int));
293                        server.Write(buffer, 0, buffer.Length);
294                    }
295                else
296                {
297                    byte[] buffer = BitConverter.GetBytes(0);
298                    server.Write(buffer, 0, sizeof(int));
299                }
300
301                //We are done, disconnect
302                server.Disconnect();
303            }
304        }
305
306        /// <summary>
307        /// Waits for a connection from a client.
308        /// </summary>
309        /// <param name="result">The AsyncResult object associated with this asynchronous
310        /// operation.</param>
311        private void EndWaitForConnection(IAsyncResult result)
312        {
313            server.WaitForConnection();
314            if (server.IsConnected)
315                server.EndWaitForConnection(result);
316        }
317    }
318
319    public class RemoteExecutorClient : Executor
320    {
321        private NamedPipeClientStream client;
322
323        public RemoteExecutorClient()
324        {
325            client = new NamedPipeClientStream(".", RemoteExecutorServer.ServerName,
326                PipeDirection.InOut);
327        }
328
329        public override void Dispose()
330        {
331            client.Close();
332            client.Dispose();
333        }
334
335        /// <summary>
336        /// Connects to the remote server.
337        /// </summary>
338        /// <returns>True if the connection to the remote server was established.</returns>
339        public bool Connect()
340        {
341            try
342            {
343                client.Connect(3000);
344            }
345            catch (TimeoutException)
346            {
347            }
348
349            return client.IsConnected;
350        }
351
352        private object SendRequest(RemoteRequest header)
353        {
354            //Connect to the server
355            object result = null;
356
357            using (MemoryStream mStream = new MemoryStream())
358            {
359                //Serialise the request
360                new BinaryFormatter().Serialize(mStream, header);
361
362                //Write the request to the pipe
363                byte[] buffer = mStream.ToArray();
364                byte[] bufferLength = BitConverter.GetBytes(buffer.Length);
365                client.Write(bufferLength, 0, sizeof(int));
366                client.Write(buffer, 0, buffer.Length);
367
368                //Read the response from the pipe
369                mStream.Position = 0;
370                buffer = new byte[32768];
371                client.Read(buffer, 0, sizeof(int));
372                int responseLength = BitConverter.ToInt32(buffer, 0);
373                while (responseLength > 0)
374                    responseLength -= client.Read(buffer, 0, Math.Min(buffer.Length, responseLength));
375
376                //Deserialise the response
377                mStream.Position = 0;
378                if (mStream.Length > 0)
379                    result = new BinaryFormatter().Deserialize(mStream);
380            }
381
382            return result;
383        }
384
385        public override bool DeleteTask(uint taskId)
386        {
387            MemoryStream mStream = new MemoryStream();
388            new BinaryFormatter().Serialize(mStream, taskId);
389            return (bool)SendRequest(new RemoteRequest(RemoteRequest.Function.DELETE_TASK,
390                mStream.GetBuffer()));
391        }
392
393        public override List<Task> GetTasks()
394        {
395            MemoryStream mStream = new MemoryStream();
396            new BinaryFormatter().Serialize(mStream, null);
397            return (List<Task>)SendRequest(new RemoteRequest(RemoteRequest.Function.GET_TASKS,
398                mStream.GetBuffer()));
399        }
400
401        public override Task GetTask(uint taskId)
402        {
403            MemoryStream mStream = new MemoryStream();
404            new BinaryFormatter().Serialize(mStream, taskId);
405            return (Task)SendRequest(new RemoteRequest(RemoteRequest.Function.GET_TASK,
406                mStream.GetBuffer()));
407        }
408
409        public override void LoadTaskList(Stream stream)
410        {
411            MemoryStream mStream = new MemoryStream();
412            new BinaryFormatter().Serialize(mStream, stream);
413            SendRequest(new RemoteRequest(RemoteRequest.Function.LOAD_TASK_LIST,
414                mStream.GetBuffer()));
415        }
416
417        public override void AddTask(ref Task task)
418        {
419            MemoryStream mStream = new MemoryStream();
420            new BinaryFormatter().Serialize(mStream, task);
421            SendRequest(new RemoteRequest(RemoteRequest.Function.ADD_TASK,
422                mStream.GetBuffer()));
423        }
424
425        public override void CancelTask(Task task)
426        {
427            MemoryStream mStream = new MemoryStream();
428            new BinaryFormatter().Serialize(mStream, task);
429            SendRequest(new RemoteRequest(RemoteRequest.Function.CANCEL_TASK,
430                mStream.GetBuffer()));
431        }
432
433        public override void QueueRestartTasks()
434        {
435            MemoryStream mStream = new MemoryStream();
436            new BinaryFormatter().Serialize(mStream, null);
437            SendRequest(new RemoteRequest(RemoteRequest.Function.QUEUE_RESTART_TASK,
438                mStream.GetBuffer()));
439        }
440
441        public override void QueueTask(Task task)
442        {
443            MemoryStream mStream = new MemoryStream();
444            new BinaryFormatter().Serialize(mStream, task);
445            SendRequest(new RemoteRequest(RemoteRequest.Function.QUEUE_TASK,
446                mStream.GetBuffer()));
447        }
448
449        public override void ReplaceTask(Task task)
450        {
451            MemoryStream mStream = new MemoryStream();
452            new BinaryFormatter().Serialize(mStream, task);
453            SendRequest(new RemoteRequest(RemoteRequest.Function.REPLACE_TASK,
454                mStream.GetBuffer()));
455        }
456
457        public override void Run()
458        {
459        }
460
461        public override void ScheduleTask(Task task)
462        {
463            MemoryStream mStream = new MemoryStream();
464            new BinaryFormatter().Serialize(mStream, task);
465            SendRequest(new RemoteRequest(RemoteRequest.Function.SCHEDULE_TASK,
466                mStream.GetBuffer()));
467        }
468
469        public override void SaveTaskList(Stream stream)
470        {
471            MemoryStream mStream = new MemoryStream();
472            new BinaryFormatter().Serialize(mStream, stream);
473            SendRequest(new RemoteRequest(RemoteRequest.Function.SAVE_TASK_LIST,
474                mStream.GetBuffer()));
475        }
476    }
477}
Note: See TracBrowser for help on using the repository browser.