system.net.websockets

Class WebSocket

java.lang.Object

org.mases.jcobridge.netreflection.NetObject

system.net.websockets.WebSocket

All Implemented Interfaces:

java.lang.AutoCloseable, IJCOBridgeReflected

Direct Known Subclasses:

ClientWebSocket

public class WebSocket
extends NetObject
implements java.lang.AutoCloseable

The base .NET class managing System.Net.WebSockets.WebSocket, System.Net.WebSockets, Version=9.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a.

.NET documentation at https://learn.microsoft.com/dotnet/api/System.Net.WebSockets.WebSocket

Powered by JCOBridge: more info at https://www.jcobridge.com

Author:

MASES s.r.l https://masesgroup.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	assemblyFullName Fully assembly qualified name: System.Net.WebSockets, Version=9.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
static java.lang.String	assemblyShortName Assembly name: System.Net.WebSockets
static java.lang.String	className Qualified class name: System.Net.WebSockets.WebSocket
static JCType	classType The type managed from JCOBridge.

Fields inherited from class org.mases.jcobridge.netreflection.NetObject

Null

Constructor Summary

Constructors

Constructor and Description
WebSocket()
WebSocket(java.lang.Object instance) Internal constructor.

Method Summary

Modifier and Type	Method and Description
void	Abort() Invokes the .NET member Abort.
static WebSocket	cast(IJCOBridgeReflected from) Try to cast the IJCOBridgeReflected instance into WebSocket, a cast assert is made to check if types are compatible.
void	close()
Task	CloseAsync(WebSocketCloseStatus closeStatus, java.lang.String statusDescription, CancellationToken cancellationToken) Invokes the .NET member CloseAsync.
Task	CloseOutputAsync(WebSocketCloseStatus closeStatus, java.lang.String statusDescription, CancellationToken cancellationToken) Invokes the .NET member CloseOutputAsync.
static ArraySegment_1	CreateClientBuffer(int receiveBufferSize, int sendBufferSize) Invokes the .NET member CreateClientBuffer.
static WebSocket	CreateClientWebSocket(Stream innerStream, java.lang.String subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval, boolean useZeroMaskingKey, ArraySegment_1 internalBuffer) Invokes the .NET member CreateClientWebSocket.
static WebSocket	CreateFromStream(Stream stream, boolean isServer, java.lang.String subProtocol, TimeSpan keepAliveInterval) Invokes the .NET member CreateFromStream.
static WebSocket	CreateFromStream(Stream stream, WebSocketCreationOptions options) Invokes the .NET member CreateFromStream.
static ArraySegment_1	CreateServerBuffer(int receiveBufferSize) Invokes the .NET member CreateServerBuffer.
void	Dispose() Invokes the .NET member Dispose.
Nullable_1	getCloseStatus() Gets the value of the .NET property CloseStatus.
java.lang.String	getCloseStatusDescription() Gets the value of the .NET property CloseStatusDescription.
static TimeSpan	getDefaultKeepAliveInterval() Gets the value of the .NET property DefaultKeepAliveInterval.
java.lang.String	getJCOAssemblyName() Returns the full name of the assembly of the .NET type.
java.lang.String	getJCOClassName() Returns the full name of the .NET type.
java.lang.Object	getJCOInstance() Returns the underlying object managed by the bridge.
java.lang.String	getJCOObjectName() Returns the name of the .NET type qualified with its assembly.
JCType	getJCOType() Returns the JCType of the .NET type.
WebSocketState	getState() Gets the value of the .NET property State.
java.lang.String	getSubProtocol() Gets the value of the .NET property SubProtocol.
static boolean	IsApplicationTargeting45() Invokes the .NET member IsApplicationTargeting45.
Task_1	ReceiveAsync(ArraySegment_1 buffer, CancellationToken cancellationToken) Invokes the .NET member ReceiveAsync.
ValueTask_1	ReceiveAsync(Memory_1 buffer, CancellationToken cancellationToken) Invokes the .NET member ReceiveAsync.
static void	RegisterPrefixes() Invokes the .NET member RegisterPrefixes.
Task	SendAsync(ArraySegment_1 buffer, WebSocketMessageType messageType, boolean endOfMessage, CancellationToken cancellationToken) Invokes the .NET member SendAsync.
ValueTask	SendAsync(ReadOnlyMemory_1 buffer, WebSocketMessageType messageType, boolean endOfMessage, CancellationToken cancellationToken) Invokes the .NET member SendAsync.
ValueTask	SendAsync(ReadOnlyMemory_1 buffer, WebSocketMessageType messageType, WebSocketMessageFlags messageFlags, CancellationToken cancellationToken) Invokes the .NET member SendAsync.
void	setJCOInstance(JCObject instance) Sets the underlying object managed by the bridge.

Methods inherited from class org.mases.jcobridge.netreflection.NetObject

Equals, Equals, GetHashCode, GetType, hashCode, toString, ToString

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Field Detail

assemblyFullName

public static final java.lang.String assemblyFullName

Fully assembly qualified name: System.Net.WebSockets, Version=9.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a

See Also:

Constant Field Values

assemblyShortName

public static final java.lang.String assemblyShortName

Assembly name: System.Net.WebSockets

See Also:

Constant Field Values

className

public static final java.lang.String className

Qualified class name: System.Net.WebSockets.WebSocket

See Also:

Constant Field Values

classType

public static JCType classType

The type managed from JCOBridge. See JCType

Constructor Detail

WebSocket

public WebSocket()
          throws java.lang.Throwable

Throws:

java.lang.Throwable

WebSocket

public WebSocket(java.lang.Object instance)
          throws java.lang.Throwable

Internal constructor. Use with caution

Parameters:

instance - the underlying bridge object: it must be a JCObject

Throws:

java.lang.Throwable - if instance is not a JCObject

Method Detail

Abort

public void Abort()
           throws java.lang.Throwable

Invokes the .NET member Abort.

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

cast

public static WebSocket cast(IJCOBridgeReflected from)
                      throws java.lang.Throwable

Try to cast the IJCOBridgeReflected instance into WebSocket, a cast assert is made to check if types are compatible.

Parameters:

from - IJCOBridgeReflected instance to be casted

Returns:

WebSocket instance

Throws:

java.lang.Throwable - in case of error during cast operation

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

CloseAsync

public Task CloseAsync(WebSocketCloseStatus closeStatus,
                       java.lang.String statusDescription,
                       CancellationToken cancellationToken)
                throws java.lang.Throwable

Invokes the .NET member CloseAsync.

Parameters:

closeStatus - the argument of type WebSocketCloseStatus

statusDescription - the argument of type java.lang.String

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

CloseOutputAsync

public Task CloseOutputAsync(WebSocketCloseStatus closeStatus,
                             java.lang.String statusDescription,
                             CancellationToken cancellationToken)
                      throws java.lang.Throwable

Invokes the .NET member CloseOutputAsync.

Parameters:

closeStatus - the argument of type WebSocketCloseStatus

statusDescription - the argument of type java.lang.String

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

CreateClientBuffer

public static ArraySegment_1 CreateClientBuffer(int receiveBufferSize,
                                                int sendBufferSize)
                                         throws java.lang.Throwable,
                                                ArgumentException,
                                                ArgumentOutOfRangeException,
                                                ArgumentNullException,
                                                InvalidOperationException,
                                                PlatformNotSupportedException,
                                                ArrayTypeMismatchException,
                                                NotSupportedException,
                                                ObjectDisposedException,
                                                RankException,
                                                IndexOutOfRangeException

Invokes the .NET member CreateClientBuffer.

Parameters:

receiveBufferSize - the argument of type int

sendBufferSize - the argument of type int

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

RankException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

See Also:

.NET documentation

CreateClientWebSocket

public static WebSocket CreateClientWebSocket(Stream innerStream,
                                              java.lang.String subProtocol,
                                              int receiveBufferSize,
                                              int sendBufferSize,
                                              TimeSpan keepAliveInterval,
                                              boolean useZeroMaskingKey,
                                              ArraySegment_1 internalBuffer)
                                       throws java.lang.Throwable,
                                              ArgumentException,
                                              ArgumentOutOfRangeException,
                                              PlatformNotSupportedException,
                                              NotSupportedException,
                                              ObjectDisposedException,
                                              InvalidOperationException,
                                              RankException,
                                              ArrayTypeMismatchException,
                                              ArgumentNullException,
                                              IndexOutOfRangeException,
                                              UnreachableException,
                                              OverflowException,
                                              FormatException,
                                              OutOfMemoryException,
                                              EventSourceException

Invokes the .NET member CreateClientWebSocket.

Parameters:

innerStream - the argument of type Stream

subProtocol - the argument of type java.lang.String

receiveBufferSize - the argument of type int

sendBufferSize - the argument of type int

keepAliveInterval - the argument of type TimeSpan

useZeroMaskingKey - the argument of type boolean

internalBuffer - the argument of type ArraySegment_1

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

UnreachableException - if the .NET member raises it

OverflowException - if the .NET member raises it

FormatException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

EventSourceException - if the .NET member raises it

See Also:

.NET documentation

CreateFromStream

public static WebSocket CreateFromStream(Stream stream,
                                         boolean isServer,
                                         java.lang.String subProtocol,
                                         TimeSpan keepAliveInterval)
                                  throws java.lang.Throwable,
                                         ArgumentException,
                                         ArgumentOutOfRangeException,
                                         PlatformNotSupportedException,
                                         NotSupportedException,
                                         ObjectDisposedException,
                                         InvalidOperationException,
                                         RankException,
                                         ArrayTypeMismatchException,
                                         ArgumentNullException,
                                         IndexOutOfRangeException,
                                         UnreachableException,
                                         OverflowException,
                                         FormatException,
                                         OutOfMemoryException,
                                         EventSourceException

Invokes the .NET member CreateFromStream.

Parameters:

stream - the argument of type Stream

isServer - the argument of type boolean

subProtocol - the argument of type java.lang.String

keepAliveInterval - the argument of type TimeSpan

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

UnreachableException - if the .NET member raises it

OverflowException - if the .NET member raises it

FormatException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

EventSourceException - if the .NET member raises it

See Also:

.NET documentation

CreateFromStream

public static WebSocket CreateFromStream(Stream stream,
                                         WebSocketCreationOptions options)
                                  throws java.lang.Throwable,
                                         ArgumentException,
                                         ArgumentOutOfRangeException,
                                         PlatformNotSupportedException,
                                         NotSupportedException,
                                         ObjectDisposedException,
                                         InvalidOperationException,
                                         RankException,
                                         ArrayTypeMismatchException,
                                         ArgumentNullException,
                                         OutOfMemoryException,
                                         EventSourceException,
                                         FormatException,
                                         SynchronizationLockException

Invokes the .NET member CreateFromStream.

Parameters:

stream - the argument of type Stream

options - the argument of type WebSocketCreationOptions

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

EventSourceException - if the .NET member raises it

FormatException - if the .NET member raises it

SynchronizationLockException - if the .NET member raises it

See Also:

.NET documentation

CreateServerBuffer

public static ArraySegment_1 CreateServerBuffer(int receiveBufferSize)
                                         throws java.lang.Throwable,
                                                ArgumentException,
                                                ArgumentOutOfRangeException,
                                                ArgumentNullException,
                                                InvalidOperationException,
                                                PlatformNotSupportedException,
                                                ArrayTypeMismatchException,
                                                NotSupportedException,
                                                ObjectDisposedException,
                                                RankException,
                                                IndexOutOfRangeException

Invokes the .NET member CreateServerBuffer.

Parameters:

receiveBufferSize - the argument of type int

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

RankException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

See Also:

.NET documentation

Dispose

public void Dispose()
             throws java.lang.Throwable

Invokes the .NET member Dispose.

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getCloseStatus

public Nullable_1 getCloseStatus()
                          throws java.lang.Throwable

Gets the value of the .NET property CloseStatus.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getCloseStatusDescription

public java.lang.String getCloseStatusDescription()
                                           throws java.lang.Throwable

Gets the value of the .NET property CloseStatusDescription.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getDefaultKeepAliveInterval

public static TimeSpan getDefaultKeepAliveInterval()
                                            throws java.lang.Throwable

Gets the value of the .NET property DefaultKeepAliveInterval.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getJCOAssemblyName

public java.lang.String getJCOAssemblyName()

Description copied from class: NetObject

Returns the full name of the assembly of the .NET type.

Specified by:

getJCOAssemblyName in interface IJCOBridgeReflected

Overrides:

getJCOAssemblyName in class NetObject

Returns:

the full assembly name

getJCOClassName

public java.lang.String getJCOClassName()

Description copied from class: NetObject

Returns the full name of the .NET type.

Specified by:

getJCOClassName in interface IJCOBridgeReflected

Overrides:

getJCOClassName in class NetObject

Returns:

the full class name

getJCOInstance

public java.lang.Object getJCOInstance()

Description copied from class: NetObject

Returns the underlying object managed by the bridge.

Specified by:

getJCOInstance in interface IJCOBridgeReflected

Overrides:

getJCOInstance in class NetObject

Returns:

the underlying object, or null if there is none

getJCOObjectName

public java.lang.String getJCOObjectName()

Description copied from class: NetObject

Returns the name of the .NET type qualified with its assembly.

Specified by:

getJCOObjectName in interface IJCOBridgeReflected

Overrides:

getJCOObjectName in class NetObject

Returns:

the assembly qualified name

getJCOType

public JCType getJCOType()

Description copied from class: NetObject

Returns the JCType of the .NET type.

Specified by:

getJCOType in interface IJCOBridgeReflected

Overrides:

getJCOType in class NetObject

Returns:

the type of the .NET class

getState

public WebSocketState getState()
                        throws java.lang.Throwable

Gets the value of the .NET property State.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getSubProtocol

public java.lang.String getSubProtocol()
                                throws java.lang.Throwable

Gets the value of the .NET property SubProtocol.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

IsApplicationTargeting45

public static boolean IsApplicationTargeting45()
                                        throws java.lang.Throwable

Invokes the .NET member IsApplicationTargeting45.

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

ReceiveAsync

public Task_1 ReceiveAsync(ArraySegment_1 buffer,
                           CancellationToken cancellationToken)
                    throws java.lang.Throwable

Invokes the .NET member ReceiveAsync.

Parameters:

buffer - the argument of type ArraySegment_1

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

ReceiveAsync

public ValueTask_1 ReceiveAsync(Memory_1 buffer,
                                CancellationToken cancellationToken)
                         throws java.lang.Throwable,
                                ArgumentException,
                                NotSupportedException,
                                InvalidOperationException,
                                ArgumentOutOfRangeException,
                                ArgumentNullException

Invokes the .NET member ReceiveAsync.

Parameters:

buffer - the argument of type Memory_1

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

RegisterPrefixes

public static void RegisterPrefixes()
                             throws java.lang.Throwable,
                                    ArgumentException,
                                    ArgumentOutOfRangeException,
                                    ArgumentNullException,
                                    InvalidOperationException,
                                    PlatformNotSupportedException,
                                    ArrayTypeMismatchException,
                                    NotSupportedException,
                                    CultureNotFoundException,
                                    ObjectDisposedException

Invokes the .NET member RegisterPrefixes.

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

See Also:

.NET documentation

SendAsync

public Task SendAsync(ArraySegment_1 buffer,
                      WebSocketMessageType messageType,
                      boolean endOfMessage,
                      CancellationToken cancellationToken)
               throws java.lang.Throwable

Invokes the .NET member SendAsync.

Parameters:

buffer - the argument of type ArraySegment_1

messageType - the argument of type WebSocketMessageType

endOfMessage - the argument of type boolean

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

SendAsync

public ValueTask SendAsync(ReadOnlyMemory_1 buffer,
                           WebSocketMessageType messageType,
                           boolean endOfMessage,
                           CancellationToken cancellationToken)
                    throws java.lang.Throwable,
                           PlatformNotSupportedException,
                           ArgumentNullException

Invokes the .NET member SendAsync.

Parameters:

buffer - the argument of type ReadOnlyMemory_1

messageType - the argument of type WebSocketMessageType

endOfMessage - the argument of type boolean

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

PlatformNotSupportedException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

SendAsync

public ValueTask SendAsync(ReadOnlyMemory_1 buffer,
                           WebSocketMessageType messageType,
                           WebSocketMessageFlags messageFlags,
                           CancellationToken cancellationToken)
                    throws java.lang.Throwable,
                           ArgumentException,
                           NotSupportedException,
                           InvalidOperationException,
                           ArgumentOutOfRangeException,
                           ArgumentNullException,
                           PlatformNotSupportedException,
                           IndexOutOfRangeException,
                           FormatException

Invokes the .NET member SendAsync.

Parameters:

buffer - the argument of type ReadOnlyMemory_1

messageType - the argument of type WebSocketMessageType

messageFlags - the argument of type WebSocketMessageFlags

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

FormatException - if the .NET member raises it

See Also:

.NET documentation

setJCOInstance

public void setJCOInstance(JCObject instance)

Description copied from class: NetObject

Sets the underlying object managed by the bridge.

Overrides:

setJCOInstance in class NetObject

Parameters:

instance - the new underlying object