SocketChannel SocketChannel Class

Definition

A SocketChannel is a selectable channel that provides a partial abstraction of stream connecting socket.

[Android.Runtime.Register("java/nio/channels/SocketChannel", ApiSince=1, DoNotGenerateAcw=true)]
public abstract class SocketChannel : Java.Nio.Channels.Spi.AbstractSelectableChannel, IDisposable, Java.Nio.Channels.IByteChannel, Java.Nio.Channels.IGatheringByteChannel, Java.Nio.Channels.IScatteringByteChannel
type SocketChannel = class
    inherit AbstractSelectableChannel
    interface IByteChannel
    interface IReadableByteChannel
    interface IChannel
    interface ICloseable
    interface IJavaObject
    interface IDisposable
    interface IWritableByteChannel
    interface IGatheringByteChannel
    interface IScatteringByteChannel
Inheritance
Attributes
Implements

Remarks

Android platform documentation

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

SocketChannel(IntPtr, JniHandleOwnership) SocketChannel(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

SocketChannel(SelectorProvider) SocketChannel(SelectorProvider)

Constructs a new SocketChannel.

Properties

Class Class

Returns the unique instance of Class that represents this object's class.

(Inherited from Object)
Handle Handle

The handle to the underlying Android instance.

(Inherited from Object)
IJavaObjectEx.IsProxy IJavaObjectEx.IsProxy Inherited from Object
IJavaObjectEx.KeyHandle IJavaObjectEx.KeyHandle Inherited from Object
IJavaObjectEx.NeedsActivation IJavaObjectEx.NeedsActivation Inherited from Object
IJavaPeerable.JniManagedPeerState IJavaPeerable.JniManagedPeerState Inherited from Object
IsBlocking IsBlocking

Indicates whether this channel is in blocking mode.

(Inherited from AbstractSelectableChannel)
IsConnected IsConnected

Indicates whether this channel's socket is connected.

IsConnectionPending IsConnectionPending

Indicates whether this channel's socket is still trying to connect.

IsOpen IsOpen

Returns true if this channel is open.

(Inherited from AbstractInterruptibleChannel)
IsRegistered IsRegistered

Indicates whether this channel is registered with one or more selectors.

(Inherited from AbstractSelectableChannel)
JniIdentityHashCode JniIdentityHashCode Inherited from Object
JniPeerMembers JniPeerMembers
LocalAddress LocalAddress
PeerReference PeerReference Inherited from Object
RemoteAddress RemoteAddress
ThresholdClass ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Begin() Begin()

Indicates the beginning of a code section that includes an I/O operation that is potentially blocking.

(Inherited from AbstractInterruptibleChannel)
Bind(SocketAddress) Bind(SocketAddress)
BlockingLock() BlockingLock()

Gets the object used for the synchronization of register and configureBlocking.

(Inherited from AbstractSelectableChannel)
Clone() Clone()

Creates and returns a copy of this Object.

(Inherited from Object)
Close() Close()

Closes an open channel.

(Inherited from AbstractInterruptibleChannel)
ConfigureBlocking(Boolean) ConfigureBlocking(Boolean)

Sets the blocking mode of this channel.

(Inherited from AbstractSelectableChannel)
Connect(SocketAddress) Connect(SocketAddress)

Connects this channel's socket with a remote address.

ConnectAsync(SocketAddress) ConnectAsync(SocketAddress)
Dispose() Dispose() Inherited from Object
Dispose(Boolean) Dispose(Boolean) Inherited from Object
End(Boolean) End(Boolean)

Indicates the end of a code section that has been started with begin() and that includes a potentially blocking I/O operation.

(Inherited from AbstractInterruptibleChannel)
Equals(Object) Equals(Object)

Compares this instance with the specified object and indicates if they are equal.

(Inherited from Object)
FinishConnect() FinishConnect()

Completes the connection process initiated by a call of connect(SocketAddress).

FinishConnectAsync() FinishConnectAsync()
GetHashCode() GetHashCode()

Returns an integer hash code for this object.

(Inherited from Object)
ImplCloseChannel() ImplCloseChannel()

Implements the channel closing behavior.

(Inherited from AbstractSelectableChannel)
ImplCloseSelectableChannel() ImplCloseSelectableChannel()

Implements the closing function of the SelectableChannel.

(Inherited from AbstractSelectableChannel)
ImplConfigureBlocking(Boolean) ImplConfigureBlocking(Boolean)

Implements the configuration of blocking/non-blocking mode.

(Inherited from AbstractSelectableChannel)
JavaFinalize() JavaFinalize()

Invoked when the garbage collector has detected that this instance is no longer reachable.

(Inherited from Object)
KeyFor(Selector) KeyFor(Selector)

Gets this channel's selection key for the specified selector.

(Inherited from AbstractSelectableChannel)
Notify() Notify()

Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.

(Inherited from Object)
NotifyAll() NotifyAll()

Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.

(Inherited from Object)
Open() Open()

Creates an open and unconnected socket channel.

Open(SocketAddress) Open(SocketAddress)

Creates a socket channel and connects it to a socket address.

Provider() Provider()

Returns the selector provider that has created this channel.

(Inherited from AbstractSelectableChannel)
Read(ByteBuffer) Read(ByteBuffer)

Reads bytes from this socket channel into the given buffer.

Read(ByteBuffer[]) Read(ByteBuffer[])

Reads bytes from this socket channel and stores them in the specified array of buffers.

Read(ByteBuffer[], Int32, Int32) Read(ByteBuffer[], Int32, Int32)

Reads bytes from this socket channel into a subset of the given buffers.

Register(Selector, Operations) Register(Selector, Operations)

Registers this channel with the specified selector for the specified interest set.

(Inherited from SelectableChannel)
Register(Selector, Operations, Object) Register(Selector, Operations, Object)

Registers this channel with the specified selector for the specified interest set.

(Inherited from AbstractSelectableChannel)
SetHandle(IntPtr, JniHandleOwnership) SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetOption(ISocketOption, Object) SetOption(ISocketOption, Object)
ShutdownInput() ShutdownInput()
ShutdownOutput() ShutdownOutput()
Socket() Socket()

Returns the socket assigned to this channel, which does not declare any public methods that are not declared in Socket.

ToArray<T>() ToArray<T>() Inherited from Object
ToString() ToString()

Returns a string containing a concise, human-readable description of this object.

(Inherited from Object)
UnregisterFromRuntime() UnregisterFromRuntime() Inherited from Object
ValidOps() ValidOps()

Gets the valid operations of this channel.

Wait() Wait()

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

(Inherited from Object)
Wait(Int64) Wait(Int64)

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.

(Inherited from Object)
Wait(Int64, Int32) Wait(Int64, Int32)

Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.

(Inherited from Object)
Write(ByteBuffer) Write(ByteBuffer)

Writes bytes from the given byte buffer to this socket channel.

Write(ByteBuffer[]) Write(ByteBuffer[])

Writes bytes from all the given byte buffers to this socket channel.

Write(ByteBuffer[], Int32, Int32) Write(ByteBuffer[], Int32, Int32)

Attempts to write a subset of the given bytes from the buffers to this socket channel.

Explicit Interface Implementations

IJavaObjectEx.ToLocalJniHandle() IJavaObjectEx.ToLocalJniHandle() Inherited from Object
IJavaPeerable.Disposed() IJavaPeerable.Disposed() Inherited from Object
IJavaPeerable.DisposeUnlessReferenced() IJavaPeerable.DisposeUnlessReferenced() Inherited from Object
IJavaPeerable.Finalized() IJavaPeerable.Finalized() Inherited from Object
IJavaPeerable.SetJniIdentityHashCode(Int32) IJavaPeerable.SetJniIdentityHashCode(Int32) Inherited from Object
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) Inherited from Object
IJavaPeerable.SetPeerReference(JniObjectReference) IJavaPeerable.SetPeerReference(JniObjectReference) Inherited from Object

Extension Methods

JavaCast<TResult>(IJavaObject) JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject) JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable) GetJniTypeName(IJavaPeerable)
WriteAsync(IGatheringByteChannel, ByteBuffer[]) WriteAsync(IGatheringByteChannel, ByteBuffer[])
WriteAsync(IGatheringByteChannel, ByteBuffer[], Int32, Int32) WriteAsync(IGatheringByteChannel, ByteBuffer[], Int32, Int32)
ReadAsync(IReadableByteChannel, ByteBuffer) ReadAsync(IReadableByteChannel, ByteBuffer)
ReadAsync(IScatteringByteChannel, ByteBuffer[]) ReadAsync(IScatteringByteChannel, ByteBuffer[])
ReadAsync(IScatteringByteChannel, ByteBuffer[], Int32, Int32) ReadAsync(IScatteringByteChannel, ByteBuffer[], Int32, Int32)
WriteAsync(IWritableByteChannel, ByteBuffer) WriteAsync(IWritableByteChannel, ByteBuffer)

Applies to