Skip to content

Document NIO channel socket addresses #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 2 commits into from
Aug 14, 2026
+35 −10
Merged

Document NIO channel socket addresses #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ceb1d50
Document NIO channel addresses
jonathanpeppers Aug 14, 2026
55be827
Clarify NIO remote address nullability
jonathanpeppers Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/xml/Java.Nio.Channels/DatagramChannel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,9 +480,14 @@
<ReturnType>Java.Net.SocketAddress</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns the socket address that this channel's socket is bound to, or <c>null</c> if the socket is not bound.</summary>
<value>The socket address that this channel's socket is bound to, or <c>null</c> if the socket is not bound.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/channels/DatagramChannel#getLocalAddress()" title="Reference documentation">Java documentation for <code>java.nio.channels.DatagramChannel.getLocalAddress()</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>
Expand Down Expand Up @@ -920,9 +925,14 @@
<ReturnType>Java.Net.SocketAddress</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns the remote address to which this channel's socket is connected, or <c>null</c> if the socket is not connected.</summary>
<value>The remote address to which this channel's socket is connected, or <c>null</c> if the socket is not connected.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/channels/DatagramChannel#getRemoteAddress()" title="Reference documentation">Java documentation for <code>java.nio.channels.DatagramChannel.getRemoteAddress()</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>
Expand Down
9 changes: 7 additions & 2 deletions docs/xml/Java.Nio.Channels/ServerSocketChannel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,9 +394,14 @@
<ReturnType>Java.Net.SocketAddress</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns the socket address that this channel's socket is bound to, or <c>null</c> if the socket is not bound.</summary>
<value>The socket address that this channel's socket is bound to, or <c>null</c> if the socket is not bound.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/channels/ServerSocketChannel#getLocalAddress()" title="Reference documentation">Java documentation for <code>java.nio.channels.ServerSocketChannel.getLocalAddress()</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>
Expand Down
18 changes: 14 additions & 4 deletions docs/xml/Java.Nio.Channels/SocketChannel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,9 +566,14 @@
<ReturnType>Java.Net.SocketAddress</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns the socket address that this channel's socket is bound to, or <c>null</c> if the socket is not bound.</summary>
<value>The socket address that this channel's socket is bound to, or <c>null</c> if the socket is not bound.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/channels/SocketChannel#getLocalAddress()" title="Reference documentation">Java documentation for <code>java.nio.channels.SocketChannel.getLocalAddress()</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>
Expand Down Expand Up @@ -873,9 +878,14 @@
<ReturnType>Java.Net.SocketAddress</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Returns the remote address to which this channel's socket is connected, or <c>null</c> if the socket is not connected.</summary>
<value>The remote address to which this channel's socket is connected, or <c>null</c> if the socket is not connected.</value>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/nio/channels/SocketChannel#getRemoteAddress()" title="Reference documentation">Java documentation for <code>java.nio.channels.SocketChannel.getRemoteAddress()</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>
Expand Down