Fix comments
[mono.git] / mcs / class / corlib / System.Threading / EventWaitHandle.cs
1 //
2 // System.Threading.EventWaitHandle.cs
3 //
4 // Author:
5 //      Dick Porter (dick@ximian.com)
6 //
7 // (C) Ximian, Inc.     (http://www.ximian.com)
8 // Copyright (C) 2005 Novell, Inc (http://www.novell.com)
9 //
10 // Permission is hereby granted, free of charge, to any person obtaining
11 // a copy of this software and associated documentation files (the
12 // "Software"), to deal in the Software without restriction, including
13 // without limitation the rights to use, copy, modify, merge, publish,
14 // distribute, sublicense, and/or sell copies of the Software, and to
15 // permit persons to whom the Software is furnished to do so, subject to
16 // the following conditions:
17 // 
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
20 // 
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 //
29
30 using System.IO;
31 using System.Runtime.InteropServices;
32 #if !NET_2_1
33 using System.Security.AccessControl;
34 #endif
35
36 namespace System.Threading
37 {
38         [ComVisible (true)]
39         public class EventWaitHandle : WaitHandle
40         {
41                 private EventWaitHandle (IntPtr handle)
42                 {
43                         Handle = handle;
44                 }
45
46                 private bool IsManualReset (EventResetMode mode)
47                 {
48                         if ((mode < EventResetMode.AutoReset) || (mode > EventResetMode.ManualReset))
49                                 throw new ArgumentException ("mode");
50                         return (mode == EventResetMode.ManualReset);
51                 }
52                 
53                 public EventWaitHandle (bool initialState, EventResetMode mode)
54                 {
55                         bool created;
56                         bool manual = IsManualReset (mode);
57                         Handle = NativeEventCalls.CreateEvent_internal (manual, initialState, null, out created);
58                 }
59                 
60                 public EventWaitHandle (bool initialState, EventResetMode mode,
61                                         string name)
62                 {
63                         bool created;
64                         bool manual = IsManualReset (mode);
65                         Handle = NativeEventCalls.CreateEvent_internal (manual, initialState, name, out created);
66                 }
67                 
68                 public EventWaitHandle (bool initialState, EventResetMode mode,
69                                         string name, out bool createdNew)
70                 {
71                         bool manual = IsManualReset (mode);
72                         Handle = NativeEventCalls.CreateEvent_internal (manual, initialState, name, out createdNew);
73                 }
74 #if !NET_2_1
75                 [MonoTODO ("Implement access control")]
76                 public EventWaitHandle (bool initialState, EventResetMode mode,
77                                         string name, out bool createdNew,
78                                         EventWaitHandleSecurity eventSecurity)
79                 {
80                         bool manual = IsManualReset (mode);
81                         Handle = NativeEventCalls.CreateEvent_internal (manual, initialState, name, out createdNew);
82                 }
83                 
84                 [MonoTODO]
85                 public EventWaitHandleSecurity GetAccessControl ()
86                 {
87                         throw new NotImplementedException ();
88                 }
89
90                 public static EventWaitHandle OpenExisting (string name)
91                 {
92                         return(OpenExisting (name, EventWaitHandleRights.Synchronize | EventWaitHandleRights.Modify));
93                 }
94
95                 public static EventWaitHandle OpenExisting (string name, EventWaitHandleRights rights)
96                 {
97                         if (name == null) {
98                                 throw new ArgumentNullException ("name");
99                         }
100                         if ((name.Length == 0) ||
101                             (name.Length > 260)) {
102                                 throw new ArgumentException ("name", Locale.GetText ("Invalid length [1-260]."));
103                         }
104                         
105                         MonoIOError error;
106                         IntPtr handle = NativeEventCalls.OpenEvent_internal (name, rights, out error);
107                         if (handle == (IntPtr)null) {
108                                 if (error == MonoIOError.ERROR_FILE_NOT_FOUND) {
109                                         throw new WaitHandleCannotBeOpenedException (Locale.GetText ("Named Event handle does not exist: ") + name);
110                                 } else if (error == MonoIOError.ERROR_ACCESS_DENIED) {
111                                         throw new UnauthorizedAccessException ();
112                                 } else {
113                                         throw new IOException (Locale.GetText ("Win32 IO error: ") + error.ToString ());
114                                 }
115                         }
116                         
117                         return(new EventWaitHandle (handle));
118                 }
119 #endif
120                 public bool Reset ()
121                 {
122                         CheckDisposed ();
123                         
124                         return (NativeEventCalls.ResetEvent_internal (Handle));
125                 }
126                 
127                 public bool Set ()
128                 {
129                         CheckDisposed ();
130                         
131                         return (NativeEventCalls.SetEvent_internal (Handle));
132                 }
133 #if !NET_2_1
134                 [MonoTODO]
135                 public void SetAccessControl (EventWaitHandleSecurity eventSecurity)
136                 {
137                         throw new NotImplementedException ();
138                 }
139 #endif
140         }
141 }