system.net.websockets

Class ClientWebSocket

java.lang.Object

org.mases.jcobridge.netreflection.NetObject

system.net.websockets.WebSocket

system.net.websockets.ClientWebSocket

All Implemented Interfaces:

java.lang.AutoCloseable, IJCOBridgeReflected

public class ClientWebSocket
extends WebSocket

The base .NET class managing System.Net.WebSockets.ClientWebSocket, System.Net.WebSockets.Client, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a.

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

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.Client, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
static java.lang.String	assemblyShortName Assembly name: System.Net.WebSockets.Client
static java.lang.String	className Qualified class name: System.Net.WebSockets.ClientWebSocket
static JCType	classType The type managed from JCOBridge.

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

Null

Constructor Summary

Constructors

Constructor and Description
ClientWebSocket() Initializes a new instance by invoking the .NET constructor.
ClientWebSocket(java.lang.Object instance) Internal constructor.

Method Summary

Modifier and Type	Method and Description
void	Abort() Invokes the .NET member Abort.
static ClientWebSocket	cast(IJCOBridgeReflected from) Try to cast the IJCOBridgeReflected instance into ClientWebSocket, a cast assert is made to check if types are compatible.
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.
Task	ConnectAsync(Uri uri, CancellationToken cancellationToken) Invokes the .NET member ConnectAsync.
Task	ConnectAsync(Uri uri, HttpMessageInvoker invoker, CancellationToken cancellationToken) Invokes the .NET member ConnectAsync.
void	Dispose() Invokes the .NET member Dispose.
IReadOnlyDictionary_2	getHttpResponseHeaders() Gets the value of the .NET property HttpResponseHeaders.
HttpStatusCode	getHttpStatusCode() Gets the value of the .NET property HttpStatusCode.
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.
ClientWebSocketOptions	getOptions() Gets the value of the .NET property Options.
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.
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	setHttpResponseHeaders(IReadOnlyDictionary_2 HttpResponseHeaders) Sets the value of the .NET property HttpResponseHeaders.
void	setJCOInstance(JCObject instance) Sets the underlying object managed by the bridge.

Methods inherited from class system.net.websockets.WebSocket

close, CreateClientBuffer, CreateClientWebSocket, CreateFromStream, CreateFromStream, CreateServerBuffer, getCloseStatus, getCloseStatusDescription, getDefaultKeepAliveInterval, getState, getSubProtocol, IsApplicationTargeting45, RegisterPrefixes

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.Client, Version=8.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.Client

See Also:

Constant Field Values

className

public static final java.lang.String className

Qualified class name: System.Net.WebSockets.ClientWebSocket

See Also:

Constant Field Values

classType

public static JCType classType

The type managed from JCOBridge. See JCType

Constructor Detail

ClientWebSocket

public ClientWebSocket()
                throws java.lang.Throwable,
                       ArgumentException,
                       OverflowException,
                       ArgumentNullException,
                       PlatformNotSupportedException,
                       InvalidOperationException

Initializes a new instance by invoking the .NET constructor.

Throws:

java.lang.Throwable - if the .NET constructor fails

ArgumentException - if the .NET member raises it

OverflowException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

See Also:

.NET documentation

ClientWebSocket

public ClientWebSocket(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,
                  ObjectDisposedException,
                  PlatformNotSupportedException,
                  ArgumentNullException,
                  ArgumentException,
                  AggregateException

Invokes the .NET member Abort.

Overrides:

Abort in class WebSocket

Throws:

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

ObjectDisposedException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

ArgumentException - if the .NET member raises it

AggregateException - if the .NET member raises it

See Also:

.NET documentation

cast

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

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

Parameters:

from - IJCOBridgeReflected instance to be casted

Returns:

ClientWebSocket instance

Throws:

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

CloseAsync

public Task CloseAsync(WebSocketCloseStatus closeStatus,
                       java.lang.String statusDescription,
                       CancellationToken cancellationToken)
                throws java.lang.Throwable,
                       ArgumentException,
                       NotSupportedException,
                       InvalidOperationException,
                       ArgumentOutOfRangeException,
                       ObjectDisposedException

Invokes the .NET member CloseAsync.

Overrides:

CloseAsync in class WebSocket

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

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

ObjectDisposedException - if the .NET member raises it

See Also:

.NET documentation

CloseOutputAsync

public Task CloseOutputAsync(WebSocketCloseStatus closeStatus,
                             java.lang.String statusDescription,
                             CancellationToken cancellationToken)
                      throws java.lang.Throwable,
                             ArgumentException,
                             NotSupportedException,
                             InvalidOperationException,
                             ArgumentOutOfRangeException,
                             ObjectDisposedException

Invokes the .NET member CloseOutputAsync.

Overrides:

CloseOutputAsync in class WebSocket

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

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

ObjectDisposedException - if the .NET member raises it

See Also:

.NET documentation

ConnectAsync

public Task ConnectAsync(Uri uri,
                         CancellationToken cancellationToken)
                  throws java.lang.Throwable,
                         ArgumentException,
                         NotSupportedException,
                         InvalidOperationException,
                         ArgumentOutOfRangeException,
                         ArgumentNullException,
                         PlatformNotSupportedException,
                         ObjectDisposedException

Invokes the .NET member ConnectAsync.

Parameters:

uri - the argument of type Uri

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

ObjectDisposedException - if the .NET member raises it

See Also:

.NET documentation

ConnectAsync

public Task ConnectAsync(Uri uri,
                         HttpMessageInvoker invoker,
                         CancellationToken cancellationToken)
                  throws java.lang.Throwable,
                         ArgumentException,
                         ArgumentOutOfRangeException,
                         PlatformNotSupportedException,
                         NotSupportedException,
                         ObjectDisposedException,
                         InvalidOperationException,
                         RankException,
                         ArrayTypeMismatchException,
                         ArgumentNullException

Invokes the .NET member ConnectAsync.

Parameters:

uri - the argument of type Uri

invoker - the argument of type HttpMessageInvoker

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

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

See Also:

.NET documentation

Dispose

public void Dispose()
             throws java.lang.Throwable

Invokes the .NET member Dispose.

Overrides:

Dispose in class WebSocket

Throws:

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

See Also:

.NET documentation

getHttpResponseHeaders

public IReadOnlyDictionary_2 getHttpResponseHeaders()
                                             throws java.lang.Throwable

Gets the value of the .NET property HttpResponseHeaders.

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

getHttpStatusCode

public HttpStatusCode getHttpStatusCode()
                                 throws java.lang.Throwable

Gets the value of the .NET property HttpStatusCode.

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 WebSocket

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 WebSocket

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 WebSocket

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 WebSocket

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 WebSocket

Returns:

the type of the .NET class

getOptions

public ClientWebSocketOptions getOptions()
                                  throws java.lang.Throwable

Gets the value of the .NET property Options.

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

ReceiveAsync

public Task_1 ReceiveAsync(ArraySegment_1 buffer,
                           CancellationToken cancellationToken)
                    throws java.lang.Throwable,
                           ArgumentException,
                           NotSupportedException,
                           InvalidOperationException,
                           ArgumentOutOfRangeException,
                           ObjectDisposedException

Invokes the .NET member ReceiveAsync.

Overrides:

ReceiveAsync in class WebSocket

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

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

ObjectDisposedException - if the .NET member raises it

See Also:

.NET documentation

ReceiveAsync

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

Invokes the .NET member ReceiveAsync.

Overrides:

ReceiveAsync in class WebSocket

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

ObjectDisposedException - if the .NET member raises it

ArgumentNullException - 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,
                      ArgumentException,
                      NotSupportedException,
                      InvalidOperationException,
                      ArgumentOutOfRangeException,
                      ObjectDisposedException

Invokes the .NET member SendAsync.

Overrides:

SendAsync in class WebSocket

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

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

ObjectDisposedException - if the .NET member raises it

See Also:

.NET documentation

SendAsync

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

Invokes the .NET member SendAsync.

Overrides:

SendAsync in class WebSocket

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

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

ObjectDisposedException - if the .NET member raises it

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,
                           ObjectDisposedException,
                           ArgumentNullException,
                           IndexOutOfRangeException,
                           PlatformNotSupportedException,
                           FormatException

Invokes the .NET member SendAsync.

Overrides:

SendAsync in class WebSocket

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

ObjectDisposedException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

FormatException - if the .NET member raises it

See Also:

.NET documentation

setHttpResponseHeaders

public void setHttpResponseHeaders(IReadOnlyDictionary_2 HttpResponseHeaders)
                            throws java.lang.Throwable

Sets the value of the .NET property HttpResponseHeaders.

Parameters:

HttpResponseHeaders - the new value of the property

Throws:

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

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 WebSocket

Parameters:

instance - the new underlying object