-
Notifications
You must be signed in to change notification settings - Fork 0
/
SharedMemory.xml
719 lines (715 loc) · 46 KB
/
SharedMemory.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
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
<Type Name="SharedMemory" FullName="Android.OS.SharedMemory">
<TypeSignature Language="C#" Value="public sealed class SharedMemory : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable, Java.IO.ICloseable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SharedMemory extends Java.Lang.Object implements class Android.OS.IParcelable, class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class Java.IO.ICloseable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Android.OS.SharedMemory" />
<TypeSignature Language="F#" Value="type SharedMemory = class
 inherit Object
 interface IParcelable
 interface IJavaObject
 interface IDisposable
 interface IJavaPeerable
 interface ICloseable" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Java.Lang.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Android.OS.IParcelable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.IO.ICloseable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("android/os/SharedMemory", ApiSince=27, DoNotGenerateAcw=true)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("android/os/SharedMemory", ApiSince=27, DoNotGenerateAcw=true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>SharedMemory enables the creation, mapping, and protection control over anonymous shared memory.</summary>
<remarks>
<para>SharedMemory enables the creation, mapping, and protection control over anonymous shared memory.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory" title="Reference documentation">Java documentation for <code>android.os.SharedMemory</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
<Members>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public void Close ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Close() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.Close" />
<MemberSignature Language="F#" Value="abstract member Close : unit -> unit
override this.Close : unit -> unit" Usage="sharedMemory.Close " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Java.IO.ICloseable.Close</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("close", "()V", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("close", "()V", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Close the backing <c>FileDescriptor</c> of this SharedMemory instance.</summary>
<remarks>
<para>Close the backing <c>FileDescriptor</c> of this SharedMemory instance. Note that all
open mappings of the shared memory will remain valid and may continue to be used. The
shared memory will not be freed until all file descriptor handles are closed and all
memory mappings are unmapped.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#close()" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.close()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Android.OS.SharedMemory Create (string? name, int size);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Android.OS.SharedMemory Create(string name, int32 size) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.Create(System.String,System.Int32)" />
<MemberSignature Language="F#" Value="static member Create : string * int -> Android.OS.SharedMemory" Usage="Android.OS.SharedMemory.Create (name, size)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("create", "(Ljava/lang/String;I)Landroid/os/SharedMemory;", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("create", "(Ljava/lang/String;I)Landroid/os/SharedMemory;", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.OS.SharedMemory</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="size" Type="System.Int32" />
</Parameters>
<Docs>
<param name="name">The debug name to use for this SharedMemory instance. This can be null, however
a debug name is recommended to help identify memory usage when using tools
such as lsof or examining /proc/[pid]/maps</param>
<param name="size">The size of the shared memory to create. Must be greater than 0.</param>
<summary>Creates an anonymous SharedMemory instance with the provided debug name and size.</summary>
<returns>A SharedMemory instance of the requested size</returns>
<remarks>
<para>Creates an anonymous SharedMemory instance with the provided debug name and size. The name
is only used for debugging purposes and can help identify what the shared memory is used
for when inspecting memory maps for the processes that have mapped this SharedMemory
instance.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#create(java.lang.String,%20int)" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.create(java.lang.String, int)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Creator">
<MemberSignature Language="C#" Value="public static Android.OS.IParcelableCreator? Creator { get; }" />
<MemberSignature Language="ILAsm" Value=".property class Android.OS.IParcelableCreator Creator" />
<MemberSignature Language="DocId" Value="P:Android.OS.SharedMemory.Creator" />
<MemberSignature Language="F#" Value="static member Creator : Android.OS.IParcelableCreator" Usage="Android.OS.SharedMemory.Creator" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("CREATOR", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("CREATOR", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.OS.IParcelableCreator</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="DescribeContents">
<MemberSignature Language="C#" Value="public int DescribeContents ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 DescribeContents() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.DescribeContents" />
<MemberSignature Language="F#" Value="abstract member DescribeContents : unit -> int
override this.DescribeContents : unit -> int" Usage="sharedMemory.DescribeContents " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Android.OS.IParcelable.DescribeContents</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("describeContents", "()I", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("describeContents", "()I", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="FromFileDescriptor">
<MemberSignature Language="C#" Value="public static Android.OS.SharedMemory FromFileDescriptor (Android.OS.ParcelFileDescriptor fd);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Android.OS.SharedMemory FromFileDescriptor(class Android.OS.ParcelFileDescriptor fd) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.FromFileDescriptor(Android.OS.ParcelFileDescriptor)" />
<MemberSignature Language="F#" Value="static member FromFileDescriptor : Android.OS.ParcelFileDescriptor -> Android.OS.SharedMemory" Usage="Android.OS.SharedMemory.FromFileDescriptor fd" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("fromFileDescriptor", "(Landroid/os/ParcelFileDescriptor;)Landroid/os/SharedMemory;", "", ApiSince=33)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("fromFileDescriptor", "(Landroid/os/ParcelFileDescriptor;)Landroid/os/SharedMemory;", "", ApiSince=33)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android33.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android33.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Android.OS.SharedMemory</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fd" Type="Android.OS.ParcelFileDescriptor" />
</Parameters>
<Docs>
<param name="fd">File descriptor of shared memory passed as <c>ParcelFileDescriptor</c>.</param>
<summary>Creates an instance from existing shared memory passed as <c>ParcelFileDescriptor</c>.</summary>
<returns>To be added.</returns>
<remarks>
<para>Creates an instance from existing shared memory passed as <c>ParcelFileDescriptor</c>.</para>
<para>The <c>fd</c> should be a shared memory created from
<c>SharedMemory or ASharedMemory</c>. This can be useful when shared memory is passed as
file descriptor through JNI or binder service implemented in cpp.</para>
<para>Note that newly created <c>SharedMemory</c> takes ownership of passed <c>fd</c> and
the original <c>fd</c> becomes detached (Check <c>ParcelFileDescriptor#detachFd()</c>).
If the caller wants to use the file descriptor after the call, the caller should duplicate
the file descriptor (Check <c>ParcelFileDescriptor#dup()</c>) and pass the duped version
instead.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#fromFileDescriptor(android.os.ParcelFileDescriptor)" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.fromFileDescriptor(android.os.ParcelFileDescriptor)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
<MemberSignature Language="C#" Value="public override Java.Interop.JniPeerMembers JniPeerMembers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Java.Interop.JniPeerMembers JniPeerMembers" />
<MemberSignature Language="DocId" Value="P:Android.OS.SharedMemory.JniPeerMembers" />
<MemberSignature Language="F#" Value="member this.JniPeerMembers : Java.Interop.JniPeerMembers" Usage="Android.OS.SharedMemory.JniPeerMembers" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Java.Interop.IJavaPeerable.JniPeerMembers</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Map">
<MemberSignature Language="C#" Value="public Java.Nio.ByteBuffer Map (int prot, int offset, int length);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Java.Nio.ByteBuffer Map(int32 prot, int32 offset, int32 length) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.Map(System.Int32,System.Int32,System.Int32)" />
<MemberSignature Language="F#" Value="member this.Map : int * int * int -> Java.Nio.ByteBuffer" Usage="sharedMemory.Map (prot, offset, length)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("map", "(III)Ljava/nio/ByteBuffer;", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("map", "(III)Ljava/nio/ByteBuffer;", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Nio.ByteBuffer</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="prot" Type="System.Int32" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<param name="prot">A bitwise-or'd combination of PROT_READ, PROT_WRITE, PROT_EXEC, or PROT_NONE.</param>
<param name="offset">The offset into the shared memory to begin mapping. Must be >= 0 and less than
getSize().</param>
<param name="length">The length of the region to map. Must be > 0 and offset + length must not
exceed getSize().</param>
<summary>Creates an mmap of the SharedMemory with the specified prot, offset, and length.</summary>
<returns>A ByteBuffer mapping.</returns>
<remarks>
<para>Creates an mmap of the SharedMemory with the specified prot, offset, and length. This will
always produce a new ByteBuffer window to the backing shared memory region. Every call
to map() may be paired with a call to <c>#unmap(ByteBuffer)</c> when the ByteBuffer
returned by map() is no longer needed.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#map(int,%20int,%20int)" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.map(int, int, int)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="MapReadOnly">
<MemberSignature Language="C#" Value="public Java.Nio.ByteBuffer MapReadOnly ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Java.Nio.ByteBuffer MapReadOnly() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.MapReadOnly" />
<MemberSignature Language="F#" Value="member this.MapReadOnly : unit -> Java.Nio.ByteBuffer" Usage="sharedMemory.MapReadOnly " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("mapReadOnly", "()Ljava/nio/ByteBuffer;", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("mapReadOnly", "()Ljava/nio/ByteBuffer;", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Nio.ByteBuffer</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a read-only mapping of the entire shared memory region.</summary>
<returns>A ByteBuffer mapping</returns>
<remarks>
<para>Creates a read-only mapping of the entire shared memory region. This requires the the
protection level of the shared memory is at least PROT_READ or the map will fail.
Use <c>#map(int, int, int)</c> to have more control over the mapping if desired.
This is equivalent to map(OsConstants.PROT_READ, 0, getSize())</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#mapReadOnly()" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.mapReadOnly()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="MapReadWrite">
<MemberSignature Language="C#" Value="public Java.Nio.ByteBuffer MapReadWrite ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Java.Nio.ByteBuffer MapReadWrite() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.MapReadWrite" />
<MemberSignature Language="F#" Value="member this.MapReadWrite : unit -> Java.Nio.ByteBuffer" Usage="sharedMemory.MapReadWrite " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("mapReadWrite", "()Ljava/nio/ByteBuffer;", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("mapReadWrite", "()Ljava/nio/ByteBuffer;", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Nio.ByteBuffer</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a read/write mapping of the entire shared memory region.</summary>
<returns>A ByteBuffer mapping</returns>
<remarks>
<para>Creates a read/write mapping of the entire shared memory region. This requires the the
protection level of the shared memory is at least PROT_READ|PROT_WRITE or the map will fail.
Use <c>#map(int, int, int)</c> to have more control over the mapping if desired.
This is equivalent to map(OsConstants.PROT_READ | OsConstants.PROT_WRITE, 0, getSize())</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#mapReadWrite()" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.mapReadWrite()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetProtect">
<MemberSignature Language="C#" Value="public bool SetProtect (int prot);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool SetProtect(int32 prot) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.SetProtect(System.Int32)" />
<MemberSignature Language="F#" Value="member this.SetProtect : int -> bool" Usage="sharedMemory.SetProtect prot" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("setProtect", "(I)Z", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("setProtect", "(I)Z", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="prot" Type="System.Int32" />
</Parameters>
<Docs>
<param name="prot">Any bitwise-or'ed combination of
<c>android.system.OsConstants#PROT_READ</c>,
<c>android.system.OsConstants#PROT_WRITE</c>, and
<c>android.system.OsConstants#PROT_EXEC</c>; or
<c>android.system.OsConstants#PROT_NONE</c></param>
<summary>Sets the protection on the shared memory to the combination specified in prot, which
is either a bitwise-or'd combination of <c>android.system.OsConstants#PROT_READ</c>,
<c>android.system.OsConstants#PROT_WRITE</c>, <c>android.system.OsConstants#PROT_EXEC</c>
from <c>android.system.OsConstants</c>, or <c>android.system.OsConstants#PROT_NONE</c>,
to remove all further access.</summary>
<returns>Whether or not the requested protection was applied. Returns true on success,
false if the requested protection was broader than the existing protection.</returns>
<remarks>
<para>Sets the protection on the shared memory to the combination specified in prot, which
is either a bitwise-or'd combination of <c>android.system.OsConstants#PROT_READ</c>,
<c>android.system.OsConstants#PROT_WRITE</c>, <c>android.system.OsConstants#PROT_EXEC</c>
from <c>android.system.OsConstants</c>, or <c>android.system.OsConstants#PROT_NONE</c>,
to remove all further access.
Note that protection can only ever be removed, not added. By default shared memory
is created with protection set to PROT_READ | PROT_WRITE | PROT_EXEC. The protection
passed here also only applies to any mappings created after calling this method. Existing
mmaps of the shared memory retain whatever protection they had when they were created.
A common usage of this is to share a read-only copy of the data with something else. To do
that first create the read/write mapping with PROT_READ | PROT_WRITE,
then call setProtect(PROT_READ) to remove write capability, then send the SharedMemory
to another process. That process will only be able to mmap with PROT_READ.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#setProtect(int)" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.setProtect(int)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public int Size { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Size" />
<MemberSignature Language="DocId" Value="P:Android.OS.SharedMemory.Size" />
<MemberSignature Language="F#" Value="member this.Size : int" Usage="Android.OS.SharedMemory.Size" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getSize", "()I", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getSize", "()I", "", ApiSince=27)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>The size of the SharedMemory region.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#getSize()" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.getSize()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
<MemberSignature Language="C#" Value="protected override IntPtr ThresholdClass { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int ThresholdClass" />
<MemberSignature Language="DocId" Value="P:Android.OS.SharedMemory.ThresholdClass" />
<MemberSignature Language="F#" Value="member this.ThresholdClass : nativeint" Usage="Android.OS.SharedMemory.ThresholdClass" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdType">
<MemberSignature Language="C#" Value="protected override Type ThresholdType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type ThresholdType" />
<MemberSignature Language="DocId" Value="P:Android.OS.SharedMemory.ThresholdType" />
<MemberSignature Language="F#" Value="member this.ThresholdType : Type" Usage="Android.OS.SharedMemory.ThresholdType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="Unmap">
<MemberSignature Language="C#" Value="public static void Unmap (Java.Nio.ByteBuffer buffer);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Unmap(class Java.Nio.ByteBuffer buffer) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.Unmap(Java.Nio.ByteBuffer)" />
<MemberSignature Language="F#" Value="static member Unmap : Java.Nio.ByteBuffer -> unit" Usage="Android.OS.SharedMemory.Unmap buffer" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("unmap", "(Ljava/nio/ByteBuffer;)V", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("unmap", "(Ljava/nio/ByteBuffer;)V", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="Java.Nio.ByteBuffer" />
</Parameters>
<Docs>
<param name="buffer">The buffer to unmap</param>
<summary>Unmaps a buffer previously returned by <c>#map(int, int, int)</c>.</summary>
<remarks>
<para>Unmaps a buffer previously returned by <c>#map(int, int, int)</c>. This will immediately
release the backing memory of the ByteBuffer, invalidating all references to it. Only
call this method if there are no duplicates of the ByteBuffer in use and don't
access the ByteBuffer after calling this method.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/SharedMemory#unmap(java.nio.ByteBuffer)" title="Reference documentation">Java documentation for <code>android.os.SharedMemory.unmap(java.nio.ByteBuffer)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="WriteToParcel">
<MemberSignature Language="C#" Value="public void WriteToParcel (Android.OS.Parcel dest, Android.OS.ParcelableWriteFlags flags);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void WriteToParcel(class Android.OS.Parcel dest, valuetype Android.OS.ParcelableWriteFlags flags) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.OS.SharedMemory.WriteToParcel(Android.OS.Parcel,Android.OS.ParcelableWriteFlags)" />
<MemberSignature Language="F#" Value="abstract member WriteToParcel : Android.OS.Parcel * Android.OS.ParcelableWriteFlags -> unit
override this.WriteToParcel : Android.OS.Parcel * Android.OS.ParcelableWriteFlags -> unit" Usage="sharedMemory.WriteToParcel (dest, flags)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Android.OS.IParcelable.WriteToParcel(Android.OS.Parcel,Android.OS.ParcelableWriteFlags)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("writeToParcel", "(Landroid/os/Parcel;I)V", "", ApiSince=27)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("writeToParcel", "(Landroid/os/Parcel;I)V", "", ApiSince=27)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android27.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android27.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dest" Type="Android.OS.Parcel" />
<Parameter Name="flags" Type="Android.OS.ParcelableWriteFlags">
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.GeneratedEnum]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.GeneratedEnum>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="dest">To be added.</param>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
</Members>
</Type>