Merge pull request #409 from Alkarex/patch-1
[mono.git] / mcs / class / Mono.Posix / Documentation / en / Mono.Unix.Native / SignalHandler.xml
1 <Type Name="SignalHandler" FullName="Mono.Unix.Native.SignalHandler">
2   <TypeSignature Language="C#" Value="public delegate void SignalHandler(int signal);" />
3   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SignalHandler extends System.MulticastDelegate" />
4   <AssemblyInfo>
5     <AssemblyName>Mono.Posix</AssemblyName>
6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
8     <AssemblyVersion>4.0.0.0</AssemblyVersion>
9   </AssemblyInfo>
10   <Base>
11     <BaseTypeName>System.Delegate</BaseTypeName>
12   </Base>
13   <Parameters>
14     <Parameter Name="signal" Type="System.Int32" />
15   </Parameters>
16   <ReturnValue>
17     <ReturnType>System.Void</ReturnType>
18   </ReturnValue>
19   <Docs>
20     <param name="signal">The signal to handle.</param>
21     <summary>A delegate to handle POSIX signals.</summary>
22     <remarks>
23       <para>
24 When this delegate is invoked from signal context (that is, the operating system invokes the delegate), the delegate must be very careful, as processing elsewhere was interrupted at some arbitrary point.  This is similar, yet different to multi-threading issues.</para>
25       <para>In particular, from managed code the only safe thing to do is modify a variable.  Calling any function, even POSIX reentrant functions, will not be safe (as Mono's P/Invoke marshaller isn't reentrant).
26 </para>
27       <para>See also: http://www-106.ibm.com/developerworks/linux/library/l-reent.html.</para>
28       <para>The POSIX 1003.1-2003 list of reentrant functions is:
29 <see cref="M:Mono.Unix.Native.Syscall._Exit" />, 
30 <see cref="M:Mono.Unix.Native.Syscall._exit" />, 
31 <see cref="M:Mono.Unix.Native.Syscall.abort" />, 
32 <see cref="M:Mono.Unix.Native.Syscall.accept" />, 
33 <see cref="M:Mono.Unix.Native.Syscall.access" />, 
34 <see cref="M:Mono.Unix.Native.Syscall.aio_error" />, 
35 <see cref="M:Mono.Unix.Native.Syscall.aio_return" />, 
36 <see cref="M:Mono.Unix.Native.Syscall.aio_suspend" />, 
37 <see cref="M:Mono.Unix.Native.Syscall.alarm" />, 
38 <see cref="M:Mono.Unix.Native.Syscall.bind" />, 
39 <see cref="M:Mono.Unix.Native.Syscall.cfgetispeed" />, 
40 <see cref="M:Mono.Unix.Native.Syscall.cfgetospeed" />, 
41 <see cref="M:Mono.Unix.Native.Syscall.cfsetispeed" />, 
42 <see cref="M:Mono.Unix.Native.Syscall.cfsetospeed" />, 
43 <see cref="M:Mono.Unix.Native.Syscall.chdir" />, 
44 <see cref="M:Mono.Unix.Native.Syscall.chmod" />, 
45 <see cref="M:Mono.Unix.Native.Syscall.chown" />, 
46 <see cref="M:Mono.Unix.Native.Syscall.clock_gettime" />, 
47 <see cref="M:Mono.Unix.Native.Syscall.close" />, 
48 <see cref="M:Mono.Unix.Native.Syscall.connect" />, 
49 <see cref="M:Mono.Unix.Native.Syscall.creat" />, 
50 <see cref="M:Mono.Unix.Native.Syscall.dup" />, 
51 <see cref="M:Mono.Unix.Native.Syscall.dup2" />, 
52 <see cref="M:Mono.Unix.Native.Syscall.execle" />, 
53 <see cref="M:Mono.Unix.Native.Syscall.execve" />, 
54 <see cref="M:Mono.Unix.Native.Syscall.fchmod" />, 
55 <see cref="M:Mono.Unix.Native.Syscall.fchown" />, 
56 <see cref="M:Mono.Unix.Native.Syscall.fcntl" />, 
57 <see cref="M:Mono.Unix.Native.Syscall.fdatasync" />, 
58 <see cref="M:Mono.Unix.Native.Syscall.fork" />, 
59 <see cref="M:Mono.Unix.Native.Syscall.fpathconf" />, 
60 <see cref="M:Mono.Unix.Native.Syscall.fstat" />, 
61 <see cref="M:Mono.Unix.Native.Syscall.fsync" />, 
62 <see cref="M:Mono.Unix.Native.Syscall.ftruncate" />, 
63 <see cref="M:Mono.Unix.Native.Syscall.getegid" />, 
64 <see cref="M:Mono.Unix.Native.Syscall.geteuid" />, 
65 <see cref="M:Mono.Unix.Native.Syscall.getgid" />, 
66 <see cref="M:Mono.Unix.Native.Syscall.getgroups" />, 
67 <see cref="M:Mono.Unix.Native.Syscall.getpeername" />, 
68 <see cref="M:Mono.Unix.Native.Syscall.getpgrp" />, 
69 <see cref="M:Mono.Unix.Native.Syscall.getpid" />, 
70 <see cref="M:Mono.Unix.Native.Syscall.getppid" />, 
71 <see cref="M:Mono.Unix.Native.Syscall.getsockname" />, 
72 <see cref="M:Mono.Unix.Native.Syscall.getsockopt" />, 
73 <see cref="M:Mono.Unix.Native.Syscall.getuid" />, 
74 <see cref="M:Mono.Unix.Native.Syscall.kill" />, 
75 <see cref="M:Mono.Unix.Native.Syscall.link" />, 
76 <see cref="M:Mono.Unix.Native.Syscall.listen" />, 
77 <see cref="M:Mono.Unix.Native.Syscall.lseek" />, 
78 <see cref="M:Mono.Unix.Native.Syscall.lstat" />, 
79 <see cref="M:Mono.Unix.Native.Syscall.mkdir" />, 
80 <see cref="M:Mono.Unix.Native.Syscall.mkfifo" />, 
81 <see cref="M:Mono.Unix.Native.Syscall.open" />, 
82 <see cref="M:Mono.Unix.Native.Syscall.pathconf" />, 
83 <see cref="M:Mono.Unix.Native.Syscall.pause" />, 
84 <see cref="M:Mono.Unix.Native.Syscall.pipe" />, 
85 <see cref="M:Mono.Unix.Native.Syscall.poll" />, 
86 <see cref="M:Mono.Unix.Native.Syscall.posix_trace_event" />, 
87 <see cref="M:Mono.Unix.Native.Syscall.pselect" />, 
88 <see cref="M:Mono.Unix.Native.Syscall.raise" />, 
89 <see cref="M:Mono.Unix.Native.Syscall.read" />, 
90 <see cref="M:Mono.Unix.Native.Syscall.readlink" />, 
91 <see cref="M:Mono.Unix.Native.Syscall.recv" />, 
92 <see cref="M:Mono.Unix.Native.Syscall.recvfrom" />, 
93 <see cref="M:Mono.Unix.Native.Syscall.recvmsg" />, 
94 <see cref="M:Mono.Unix.Native.Syscall.rename" />, 
95 <see cref="M:Mono.Unix.Native.Syscall.rmdir" />, 
96 <see cref="M:Mono.Unix.Native.Syscall.select" />, 
97 <see cref="M:Mono.Unix.Native.Syscall.sem_post" />, 
98 <see cref="M:Mono.Unix.Native.Syscall.send" />, 
99 <see cref="M:Mono.Unix.Native.Syscall.sendmsg" />, 
100 <see cref="M:Mono.Unix.Native.Syscall.sendto" />, 
101 <see cref="M:Mono.Unix.Native.Syscall.setgid" />, 
102 <see cref="M:Mono.Unix.Native.Syscall.setpgid" />, 
103 <see cref="M:Mono.Unix.Native.Syscall.setsid" />, 
104 <see cref="M:Mono.Unix.Native.Syscall.setsockopt" />, 
105 <see cref="M:Mono.Unix.Native.Syscall.setuid" />, 
106 <see cref="M:Mono.Unix.Native.Syscall.shutdown" />, 
107 <see cref="M:Mono.Unix.Native.Syscall.sigaction" />, 
108 <see cref="M:Mono.Unix.Native.Syscall.sigaddset" />, 
109 <see cref="M:Mono.Unix.Native.Syscall.sigdelset" />, 
110 <see cref="M:Mono.Unix.Native.Syscall.sigemptyset" />, 
111 <see cref="M:Mono.Unix.Native.Syscall.sigfillset" />, 
112 <see cref="M:Mono.Unix.Native.Syscall.sigismember" />, 
113 <see cref="M:Mono.Unix.Native.Syscall.signal" />, 
114 <see cref="M:Mono.Unix.Native.Syscall.sigpause" />, 
115 <see cref="M:Mono.Unix.Native.Syscall.sigpending" />, 
116 <see cref="M:Mono.Unix.Native.Syscall.sigprocmask" />, 
117 <see cref="M:Mono.Unix.Native.Syscall.sigqueue" />, 
118 <see cref="M:Mono.Unix.Native.Syscall.sigset" />, 
119 <see cref="M:Mono.Unix.Native.Syscall.sigsuspend" />, 
120 <see cref="M:Mono.Unix.Native.Syscall.sleep" />, 
121 <see cref="M:Mono.Unix.Native.Syscall.socket" />, 
122 <see cref="M:Mono.Unix.Native.Syscall.socketpair" />, 
123 <see cref="M:Mono.Unix.Native.Syscall.stat" />, 
124 <see cref="M:Mono.Unix.Native.Syscall.symlink" />, 
125 <see cref="M:Mono.Unix.Native.Syscall.sysconf" />, 
126 <see cref="M:Mono.Unix.Native.Syscall.tcdrain" />, 
127 <see cref="M:Mono.Unix.Native.Syscall.tcflow" />, 
128 <see cref="M:Mono.Unix.Native.Syscall.tcflush" />, 
129 <see cref="M:Mono.Unix.Native.Syscall.tcgetattr" />, 
130 <see cref="M:Mono.Unix.Native.Syscall.tcgetpgrp" />, 
131 <see cref="M:Mono.Unix.Native.Syscall.tcsendbreak" />, 
132 <see cref="M:Mono.Unix.Native.Syscall.tcsetattr" />, 
133 <see cref="M:Mono.Unix.Native.Syscall.tcsetpgrp" />, 
134 <see cref="M:Mono.Unix.Native.Syscall.time" />, 
135 <see cref="M:Mono.Unix.Native.Syscall.timer_getoverrun" />, 
136 <see cref="M:Mono.Unix.Native.Syscall.timer_gettime" />, 
137 <see cref="M:Mono.Unix.Native.Syscall.timer_settime" />, 
138 <see cref="M:Mono.Unix.Native.Syscall.times" />, 
139 <see cref="M:Mono.Unix.Native.Syscall.umask" />, 
140 <see cref="M:Mono.Unix.Native.Syscall.uname" />, 
141 <see cref="M:Mono.Unix.Native.Syscall.unlink" />, 
142 <see cref="M:Mono.Unix.Native.Syscall.utime" />, 
143 <see cref="M:Mono.Unix.Native.Syscall.wait" />, 
144 <see cref="M:Mono.Unix.Native.Syscall.waitpid" />, 
145 <see cref="M:Mono.Unix.Native.Syscall.write" />.
146 </para>
147     </remarks>
148     <altmember cref="M:Mono.Unix.Native.Stdlib.signal" />
149   </Docs>
150 </Type>