Package io.deephaven.web.client.api.grpc

Class MultiplexedWebsocketTransport

java.lang.Object

io.deephaven.web.client.api.grpc.MultiplexedWebsocketTransport

All Implemented Interfaces:

GrpcTransport

public class MultiplexedWebsocketTransport
extends Object
implements GrpcTransport

Custom replacement for grpc-websockets transport that handles multiple grpc streams in a single websocket. All else equal, this transport should be preferred to the default grpc-websockets transport, and in turn the fetch based transport is usually superior to this.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiplexedWebsocketTransport.Factory
static class	MultiplexedWebsocketTransport.HeaderFrame

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MULTIPLEX_PROTOCOL
static final String	SOCKET_PER_STREAM_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
MultiplexedWebsocketTransport(GrpcTransportOptions options)

Method Summary

Modifier and Type	Method	Description
void	cancel()	End the stream, both notifying the server that no more messages will be sent nor received, and preventing the client from receiving any more events.
void	finishSend()	"Half close" the stream, signaling to the server that no more messages will be sent, but that the client is still open to receiving messages.
void	sendMessage(elemental2.core.Uint8Array msgBytes)	Sends a message to the server.
void	start(jsinterop.base.JsPropertyMap<HeaderValueUnion> metadata)	Starts the stream, sending metadata to the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MULTIPLEX_PROTOCOL

public static final String MULTIPLEX_PROTOCOL

See Also:

• Constant Field Values

SOCKET_PER_STREAM_PROTOCOL

public static final String SOCKET_PER_STREAM_PROTOCOL

See Also:

• Constant Field Values

Constructor Details

MultiplexedWebsocketTransport

public MultiplexedWebsocketTransport(GrpcTransportOptions options)

Method Details

start

public void start(jsinterop.base.JsPropertyMap<HeaderValueUnion> metadata)

Description copied from interface: GrpcTransport

Starts the stream, sending metadata to the server.

Specified by:

start in interface GrpcTransport

Parameters:

metadata - the headers to send the server when opening the connection

sendMessage

public void sendMessage(elemental2.core.Uint8Array msgBytes)

Description copied from interface: GrpcTransport

Sends a message to the server.

Specified by:

sendMessage in interface GrpcTransport

Parameters:

msgBytes - bytes to send to the server

finishSend

public void finishSend()

Description copied from interface: GrpcTransport

"Half close" the stream, signaling to the server that no more messages will be sent, but that the client is still open to receiving messages.

Specified by:

finishSend in interface GrpcTransport

cancel

public void cancel()

Description copied from interface: GrpcTransport

End the stream, both notifying the server that no more messages will be sent nor received, and preventing the client from receiving any more events.

Specified by:

cancel in interface GrpcTransport