-
Notifications
You must be signed in to change notification settings - Fork 42
/
DispatchSource+WriteMonitor.xml
180 lines (174 loc) · 8.39 KB
/
DispatchSource+WriteMonitor.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<Type Name="DispatchSource+WriteMonitor" FullName="CoreFoundation.DispatchSource+WriteMonitor">
<TypeSignature Language="C#" Value="public class DispatchSource.WriteMonitor : CoreFoundation.DispatchSource" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi beforefieldinit DispatchSource/WriteMonitor extends CoreFoundation.DispatchSource" />
<TypeSignature Language="DocId" Value="T:CoreFoundation.DispatchSource.WriteMonitor" />
<TypeSignature Language="F#" Value="type DispatchSource.WriteMonitor = class
 inherit DispatchSource" />
<AssemblyInfo>
<AssemblyName>Xamarin.iOS</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>CoreFoundation.DispatchSource</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Sources of this type monitor file descriptors for available write buffer space.</summary>
<remarks>
<para>Users of this source type are strongly encouraged to perform non-blocking I/O and handle any truncated reads or error conditions that may occur.</para>
<example>
<code lang="c#"><![CDATA[
var stream = File.Create ("Demo.txt");
// The the unix file handle
var safeHandle = stream.SafeFileHandle;
IntPtr descriptor = safeHandle.DangerousGetHandle ();
int fileDescriptor = descriptor.ToInt32 ();
dispatchSource = new DispatchSource.WriteMonitor (fileDescriptor, DispatchQueue.MainQueue);
dispatchSource.SetRegistrationHandler (() => {
Console.WriteLine ("Write monitor registered");
});
dispatchSource.SetEventHandler (() => {
Console.WriteLine ("Write monitor: was opened in write mode")
dispatchSource.Cancel ();
stream.Close ();
});
dispatchSource.SetCancelHandler (() => {
Console.WriteLine ("Write monitor cancelled");
});
dispatchSource.Resume ();]]></code>
</example>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WriteMonitor (IntPtr handle);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.DispatchSource.WriteMonitor.#ctor(System.IntPtr)" />
<MemberSignature Language="F#" Value="new CoreFoundation.DispatchSource.WriteMonitor : nativeint -> CoreFoundation.DispatchSource.WriteMonitor" Usage="new CoreFoundation.DispatchSource.WriteMonitor handle" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="handle">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WriteMonitor (int fileDescriptor, CoreFoundation.DispatchQueue queue = null);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 fileDescriptor, class CoreFoundation.DispatchQueue queue) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.DispatchSource.WriteMonitor.#ctor(System.Int32,CoreFoundation.DispatchQueue)" />
<MemberSignature Language="F#" Value="new CoreFoundation.DispatchSource.WriteMonitor : int * CoreFoundation.DispatchQueue -> CoreFoundation.DispatchSource.WriteMonitor" Usage="new CoreFoundation.DispatchSource.WriteMonitor (fileDescriptor, queue)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="fileDescriptor" Type="System.Int32" />
<Parameter Name="queue" Type="CoreFoundation.DispatchQueue" />
</Parameters>
<Docs>
<param name="fileDescriptor">To be added.</param>
<param name="queue">The target queue for this dispatch source object. Pass null to use the default target queue (the default priority global concurrent queue).</param>
<summary>Creates a file descriptor monitor that invokes the event handler when writing to the file descriptor wont block.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WriteMonitor (IntPtr handle, bool owns);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle, bool owns) cil managed" />
<MemberSignature Language="DocId" Value="M:CoreFoundation.DispatchSource.WriteMonitor.#ctor(System.IntPtr,System.Boolean)" />
<MemberSignature Language="F#" Value="new CoreFoundation.DispatchSource.WriteMonitor : nativeint * bool -> CoreFoundation.DispatchSource.WriteMonitor" Usage="new CoreFoundation.DispatchSource.WriteMonitor (handle, owns)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
<Parameter Name="owns" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="handle">To be added.</param>
<param name="owns">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BufferSpaceAvailable">
<MemberSignature Language="C#" Value="public int BufferSpaceAvailable { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 BufferSpaceAvailable" />
<MemberSignature Language="DocId" Value="P:CoreFoundation.DispatchSource.WriteMonitor.BufferSpaceAvailable" />
<MemberSignature Language="F#" Value="member this.BufferSpaceAvailable : int" Usage="CoreFoundation.DispatchSource.WriteMonitor.BufferSpaceAvailable" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Buffer space available to write on the file descriptor being monitored.</summary>
<value>
<para />
</value>
<remarks>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="FileDescriptor">
<MemberSignature Language="C#" Value="public int FileDescriptor { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 FileDescriptor" />
<MemberSignature Language="DocId" Value="P:CoreFoundation.DispatchSource.WriteMonitor.FileDescriptor" />
<MemberSignature Language="F#" Value="member this.FileDescriptor : int" Usage="CoreFoundation.DispatchSource.WriteMonitor.FileDescriptor" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyName>Xamarin.iOS</AssemblyName>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Xamarin.Mac</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The file descriptor being monitored.</summary>
<value>
<para />
</value>
<remarks>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>