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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
|
<Type Name="IOChannel" FullName="GLib.IOChannel">
<TypeSignature Language="C#" Value="public class IOChannel : GLib.IWrapper, IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IOChannel extends System.Object implements class GLib.IWrapper, class System.IDisposable" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>IO Channel class.</summary>
<remarks>Provides methods to read and write data to an IO channel.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IOChannel (int fd);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 fd) cil managed" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="fd" Type="System.Int32" />
</Parameters>
<Docs>
<param name="fd">A UNIX file descriptor.</param>
<summary>Public constructor.</summary>
<remarks>Constructs a channel for a UNIX file descriptor or pipe.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IOChannel (string filename, string mode);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filename, string mode) cil managed" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="filename" Type="System.String" />
<Parameter Name="mode" Type="System.String" />
</Parameters>
<Docs>
<param name="filename">Path to a file.</param>
<param name="mode">One of "r", "w", "a", "r+", "w+", "a+", with the same meaning as fopen.</param>
<summary>Public constructor.</summary>
<remarks>Constructs a channel for a file with a given mode.</remarks>
</Docs>
</Member>
<Member MemberName="AddWatch">
<MemberSignature Language="C#" Value="public uint AddWatch (int priority, GLib.IOCondition condition, GLib.IOFunc func);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 AddWatch(int32 priority, valuetype GLib.IOCondition condition, class GLib.IOFunc func) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="priority" Type="System.Int32" />
<Parameter Name="condition" Type="GLib.IOCondition" />
<Parameter Name="func" Type="GLib.IOFunc" />
</Parameters>
<Docs>
<param name="priority">Priority level. Default priority is 0. System defined values range from -100 (High priority) to 300 (Low priority).</param>
<param name="condition">Conditions to notify.</param>
<param name="func">Notification callback delegate.</param>
<summary>Adds a notification watch to the mainloop at a given priority.</summary>
<returns>A source ID which can be removed with <see cref="M:GLib.Source.Remove" />.</returns>
<remarks>
<para>The following example spawns a process to run the pwd command and writes the output to the console using an IOChannel watch:</para>
<para>
<example>
<code lang="C#">
using GLib;
using System;
public class SpawnTest {
public static void Main (string[] args)
{
new SpawnTest ();
}
MainLoop main_loop;
IOChannel channel;
public SpawnTest ()
{
main_loop = new MainLoop ();
try {
Process proc;
int stdin = Process.IgnorePipe;
int stdout = Process.RequestPipe;
int stderr = Process.IgnorePipe;
GLib.Process.SpawnAsyncWithPipes (null, new string[] {"pwd"}, null, SpawnFlags.SearchPath, null, out proc, ref stdin, ref stdout, ref stderr);
channel = new IOChannel (stdout);
channel.AddWatch (0, IOCondition.In | IOCondition.Hup, new IOFunc (ReadStdout));
} catch (Exception e) {
Console.WriteLine ("Exception in Spawn: " + e);
}
main_loop.Run ();
}
bool ReadStdout (IOChannel source, IOCondition condition)
{
if ((condition & IOCondition.In) == IOCondition.In) {
string txt;
if (source.ReadToEnd (out txt) == IOStatus.Normal)
Console.WriteLine ("[SpawnTest output] " + txt);
}
if ((condition & IOCondition.Hup) == IOCondition.Hup) {
source.Dispose ();
main_loop.Quit ();
return true;
}
return true;
}
}
</code>
</example>
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="BufferCondition">
<MemberSignature Language="C#" Value="public GLib.IOCondition BufferCondition { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype GLib.IOCondition BufferCondition" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.IOCondition</ReturnType>
</ReturnValue>
<Docs>
<summary>BufferCondition property.</summary>
<value>Indicates if there is data to read or room to output to the channel.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Buffered">
<MemberSignature Language="C#" Value="public bool Buffered { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Buffered" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Buffered property.</summary>
<value>A boolean value indicating if buffering is active.</value>
<remarks>Buffering can only be altered when the <see cref="M:GLib.IOChannel.Encoding" /> is <see langword="null" />. All other encodings must be buffered. It can only be cleared after the buffer has been flushed.</remarks>
</Docs>
</Member>
<Member MemberName="BufferSize">
<MemberSignature Language="C#" Value="public ulong BufferSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int64 BufferSize" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Docs>
<summary>BufferSize property.</summary>
<value>The buffer size, or 0 to pick a reasonable size.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="CloseOnUnref">
<MemberSignature Language="C#" Value="public bool CloseOnUnref { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CloseOnUnref" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>CloseOnUnref property.</summary>
<value>A boolean indicating if the channel should be closed on disposal.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the channel.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Encoding">
<MemberSignature Language="C#" Value="public string Encoding { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Encoding" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Encoding property.</summary>
<value>Specifies the native encoding of the channel. Use <see langword="null" /> for binary channels. The default encoding is UTF8.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="ErrorFromErrno">
<MemberSignature Language="C#" Value="public static GLib.IOChannelError ErrorFromErrno (int en);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype GLib.IOChannelError ErrorFromErrno(int32 en) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOChannelError</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="en" Type="System.Int32" />
</Parameters>
<Docs>
<param name="en">Error number.</param>
<summary>Converts an error number to an Error value.</summary>
<returns>The error.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Flags">
<MemberSignature Language="C#" Value="public GLib.IOFlags Flags { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype GLib.IOFlags Flags" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.IOFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>Flags property.</summary>
<value>The IO Flags for the channel.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="public GLib.IOStatus Flush ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus Flush() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Flushes the write buffer for the channel.</summary>
<returns>Status of the operation.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="FromHandle">
<MemberSignature Language="C#" Value="public static GLib.IOChannel FromHandle (IntPtr handle);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class GLib.IOChannel FromHandle(native int handle) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOChannel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="handle">Native channel pointer.</param>
<summary>Wraps a native channel.</summary>
<returns>A managed channel instance.</returns>
<remarks>Provided for language binding use.</remarks>
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int Handle" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>Handle property.</summary>
<value>A point to the native channel.</value>
<remarks>Provided for language binding use.</remarks>
</Docs>
</Member>
<Member MemberName="Init">
<MemberSignature Language="C#" Value="protected void Init ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void Init() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Init method.</summary>
<remarks>Provided for subclassers to initialize derived channels.</remarks>
</Docs>
</Member>
<Member MemberName="LineTerminator">
<MemberSignature Language="C#" Value="public char[] LineTerminator { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance char[] LineTerminator" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Char[]</ReturnType>
</ReturnValue>
<Docs>
<summary>LineTerminator property.</summary>
<value>The chars representing line termination in the channel.</value>
<remarks>This property is represented as an array of chars to allow for null char terminators.</remarks>
</Docs>
</Member>
<Member MemberName="ReadChars">
<MemberSignature Language="C#" Value="public GLib.IOStatus ReadChars (byte[] buf, out ulong bytes_read);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus ReadChars(unsigned int8[] buf, unsigned int64 bytes_read) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buf" Type="System.Byte[]" />
<Parameter Name="bytes_read" Type="System.UInt64&" RefType="out" />
</Parameters>
<Docs>
<param name="buf">Buffer to store the read data.</param>
<param name="bytes_read">Length of data read.</param>
<summary>Reads data from the channel.</summary>
<returns>An operation status value.</returns>
<remarks>Method fills the buffer with as many complete utf8 characters as possible. Provided primarily for binary data reading in null encodings. Use <see cref="M:GLib.IOChannel.ReadLine" /> for text stream reading to strings.</remarks>
</Docs>
</Member>
<Member MemberName="ReadLine">
<MemberSignature Language="C#" Value="public GLib.IOStatus ReadLine (out string str_return);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus ReadLine(string str_return) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str_return" Type="System.String&" RefType="out" />
</Parameters>
<Docs>
<param name="str_return">Returns the next line in the channel.</param>
<summary>Reads a line from the channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ReadLine">
<MemberSignature Language="C#" Value="public GLib.IOStatus ReadLine (out string str_return, out ulong terminator_pos);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus ReadLine(string str_return, unsigned int64 terminator_pos) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str_return" Type="System.String&" RefType="out" />
<Parameter Name="terminator_pos" Type="System.UInt64&" RefType="out" />
</Parameters>
<Docs>
<param name="str_return">Returns the text read.</param>
<param name="terminator_pos">Location of line terminator.</param>
<summary>Reads the next line in the channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ReadToEnd">
<MemberSignature Language="C#" Value="public GLib.IOStatus ReadToEnd (out string str_return);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus ReadToEnd(string str_return) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str_return" Type="System.String&" RefType="out" />
</Parameters>
<Docs>
<param name="str_return">Returns the text read.</param>
<summary>Reads to the end of the channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ReadUnichar">
<MemberSignature Language="C#" Value="public GLib.IOStatus ReadUnichar (out uint thechar);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus ReadUnichar(unsigned int32 thechar) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="thechar" Type="System.UInt32&" RefType="out" />
</Parameters>
<Docs>
<param name="thechar">Returns the UCS4 character.</param>
<summary>Reads a UCS4 character from the channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="SeekPosition">
<MemberSignature Language="C#" Value="public GLib.IOStatus SeekPosition (long offset, GLib.SeekType type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus SeekPosition(int64 offset, valuetype GLib.SeekType type) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="offset" Type="System.Int64" />
<Parameter Name="type" Type="GLib.SeekType" />
</Parameters>
<Docs>
<param name="offset">Byte offset.</param>
<param name="type">Base position.</param>
<summary>Seeks to a position in the channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Shutdown">
<MemberSignature Language="C#" Value="public GLib.IOStatus Shutdown (bool flush);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus Shutdown(bool flush) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="flush" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="flush">A boolean indicating if buffer should be flushed.</param>
<summary>Shuts down a channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="UnixFd">
<MemberSignature Language="C#" Value="public int UnixFd { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 UnixFd" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>UnixFd property.</summary>
<value>An integer representing the descriptor value.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="WriteChars">
<MemberSignature Language="C#" Value="public GLib.IOStatus WriteChars (byte[] buf, out ulong bytes_written);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus WriteChars(unsigned int8[] buf, unsigned int64 bytes_written) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buf" Type="System.Byte[]" />
<Parameter Name="bytes_written" Type="System.UInt64&" RefType="out" />
</Parameters>
<Docs>
<param name="buf">Data buffer to write.</param>
<param name="bytes_written">Returns the number of bytes written.</param>
<summary>Writes binary data to a channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="WriteChars">
<MemberSignature Language="C#" Value="public GLib.IOStatus WriteChars (string str, out string remainder);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus WriteChars(string str, string remainder) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str" Type="System.String" />
<Parameter Name="remainder" Type="System.String&" RefType="out" />
</Parameters>
<Docs>
<param name="str">Text to write.</param>
<param name="remainder">Returns unwritten text.</param>
<summary>Writes text to the channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="WriteUnichar">
<MemberSignature Language="C#" Value="public GLib.IOStatus WriteUnichar (uint thechar);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype GLib.IOStatus WriteUnichar(unsigned int32 thechar) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="thechar" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="thechar">A UCS4 character.</param>
<summary>Writes a UCS4 character to the channel.</summary>
<returns>An operation status value.</returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>
|
