Package io.micronaut.http.netty.websocket

Class NettyWebSocketSession

java.lang.Object

io.micronaut.http.netty.websocket.NettyWebSocketSession

All Implemented Interfaces:

ConversionServiceProvider, ConvertibleValues<Object>, MutableConvertibleValues<Object>, ValueResolver<CharSequence>, WebSocketSession, AutoCloseable, Iterable<Map.Entry<String,Object>>

@Internal
public class NettyWebSocketSession
extends Object
implements WebSocketSession

Implementation of the WebSocketSession interface for Netty.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field	Description
static final io.netty.util.AttributeKey<NettyWebSocketSession>	WEB_SOCKET_SESSION_KEY	The WebSocket session is stored within a Channel attribute using the given key.

Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NettyWebSocketSession(String id, io.netty.channel.Channel channel, HttpRequest<?> request, MediaTypeCodecRegistry codecRegistry, MessageBodyHandlerRegistry handlerRegistry, String protocolVersion, boolean isSecure)	Creates a new netty web socket session.

Method Summary

Modifier and Type	Method	Description
MutableConvertibleValues<Object>	clear()	Clear all values.
void	close()
void	close(CloseReason closeReason)	Close the session with the given event.
<T> Optional<T>	get(CharSequence name, ArgumentConversionContext<T> conversionContext)	Resolve the given property for the given name.
MutableConvertibleValues<Object>	getAttributes()
String	getId()	The ID of the session.
Set<? extends WebSocketSession>	getOpenSessions()	The current open sessions.
String	getProtocolVersion()	The protocol version of the WebSocket protocol currently being used.
ConvertibleMultiValues<String>	getRequestParameters()	The request parameters used to create this session.
URI	getRequestURI()	The request URI this session was opened under.
boolean	isOpen()	Whether the session is open.
boolean	isSecure()	Whether the connection is secure.
boolean	isWritable()	Whether the session is writable.
Set<String>	names()
MutableConvertibleValues<Object>	put(CharSequence key, @Nullable Object value)	Insert a value for the given key and value.
MutableConvertibleValues<Object>	remove(CharSequence key)	Remove a value for the given key.
<T> reactor.core.publisher.Flux<T>	send(T message, MediaType mediaType)	Send the given message to the remote peer.
<T> CompletableFuture<T>	sendAsync(T message, MediaType mediaType)	Send the given message to the remote peer asynchronously.
@NonNull CompletableFuture<?>	sendPingAsync(@io.micronaut.core.annotation.NonNull byte[] content)	Send a ping through this WebSocket.
void	sendSync(Object message, MediaType mediaType)	Send the given message to the remote peer synchronously.
String	toString()
Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

asMap, asMap, asProperties, contains, forEach, getConversionService, getValue, getValueType, isEmpty, iterator, subMap, subMap, subMap

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.micronaut.core.convert.value.MutableConvertibleValues

putAll, putAll

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get

Methods inherited from interface io.micronaut.websocket.WebSocketSession

getSubprotocol, getUriVariables, getUserPrincipal, send, sendAsync, sendSync

Field Details

WEB_SOCKET_SESSION_KEY

public static final io.netty.util.AttributeKey<NettyWebSocketSession> WEB_SOCKET_SESSION_KEY

The WebSocket session is stored within a Channel attribute using the given key.

Constructor Details

NettyWebSocketSession

protected NettyWebSocketSession(String id,
 io.netty.channel.Channel channel,
 HttpRequest<?> request,
 MediaTypeCodecRegistry codecRegistry,
 MessageBodyHandlerRegistry handlerRegistry,
 String protocolVersion,
 boolean isSecure)

Creates a new netty web socket session.

Parameters:

id - The ID

channel - The channel

request - The original request used to create the session

codecRegistry - The codec registry

handlerRegistry - The handlers registry

protocolVersion - The protocol version

isSecure - Whether the session is secure

Method Details

getId

public String getId()

Description copied from interface: WebSocketSession

The ID of the session.

Specified by:

getId in interface WebSocketSession

Returns:

The ID of the session

getAttributes

public MutableConvertibleValues<Object> getAttributes()

Specified by:

getAttributes in interface WebSocketSession

Returns:

Only the attributes of the session

isOpen

public boolean isOpen()

Description copied from interface: WebSocketSession

Whether the session is open.

Specified by:

isOpen in interface WebSocketSession

Returns:

True if it is

isWritable

public boolean isWritable()

Description copied from interface: WebSocketSession

Whether the session is writable. It may not be writable, if the buffer is currently full

Specified by:

isWritable in interface WebSocketSession

Returns:

True if it is

isSecure

public boolean isSecure()

Description copied from interface: WebSocketSession

Whether the connection is secure.

Specified by:

isSecure in interface WebSocketSession

Returns:

True if it is secure

getOpenSessions

public Set<? extends WebSocketSession> getOpenSessions()

Description copied from interface: WebSocketSession

The current open sessions.

Specified by:

getOpenSessions in interface WebSocketSession

Returns:

The open sessions

getRequestURI

public URI getRequestURI()

Description copied from interface: WebSocketSession

The request URI this session was opened under.

Specified by:

getRequestURI in interface WebSocketSession

Returns:

The request URI

getRequestParameters

public ConvertibleMultiValues<String> getRequestParameters()

Description copied from interface: WebSocketSession

The request parameters used to create this session.

Specified by:

getRequestParameters in interface WebSocketSession

Returns:

The request parameters

getProtocolVersion

public String getProtocolVersion()

Description copied from interface: WebSocketSession

The protocol version of the WebSocket protocol currently being used.

Specified by:

getProtocolVersion in interface WebSocketSession

Returns:

The protocol version

sendAsync

public <T> CompletableFuture<T> sendAsync(T message,
 MediaType mediaType)

Description copied from interface: WebSocketSession

Send the given message to the remote peer asynchronously.

Specified by:

sendAsync in interface WebSocketSession

Type Parameters:

T - The message type

Parameters:

message - The message

mediaType - The media type of the message. Used to look up an appropriate codec via the MediaTypeCodecRegistry.

Returns:

A CompletableFuture that tracks the execution. CompletableFuture.get() and related methods will return the message on success, on error throw the underlying Exception.

sendSync

public void sendSync(Object message,
 MediaType mediaType)

Description copied from interface: WebSocketSession

Send the given message to the remote peer synchronously.

Specified by:

sendSync in interface WebSocketSession

Parameters:

message - The message

mediaType - The media type of the message. Used to look up an appropriate codec via the MediaTypeCodecRegistry.

send

public <T> reactor.core.publisher.Flux<T> send(T message,
 MediaType mediaType)

Description copied from interface: WebSocketSession

Send the given message to the remote peer. The resulting Publisher does not start sending until subscribed to. If you return it from Micronaut annotated methods such as OnOpen and OnMessage, Micronaut will subscribe to it and send the message without blocking.

Specified by:

send in interface WebSocketSession

Type Parameters:

T - The message type

Parameters:

message - The message

mediaType - The media type of the message. Used to look up an appropriate codec via the MediaTypeCodecRegistry.

Returns:

A Publisher that either emits an error or emits the message once it has been published successfully.

sendPingAsync

@NonNull
public @NonNull CompletableFuture<?> sendPingAsync(@NonNull
 @io.micronaut.core.annotation.NonNull byte[] content)

Description copied from interface: WebSocketSession

Send a ping through this WebSocket. The pong reply can be intercepted using a @OnMessage method that accepts a WebSocketPongMessage.

Specified by:

sendPingAsync in interface WebSocketSession

Parameters:

content - The content of the ping. The remote should return the same content in its WebSocketPongMessage.

Returns:

A future that completes when the ping has been sent. (Not when the pong has been received!)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface WebSocketSession

close

public void close(CloseReason closeReason)

Description copied from interface: WebSocketSession

Close the session with the given event.

Specified by:

close in interface WebSocketSession

Parameters:

closeReason - The close event

toString

public String toString()

Overrides:

toString in class Object

put

public MutableConvertibleValues<Object> put(CharSequence key,
 @Nullable
 @Nullable Object value)

Description copied from interface: MutableConvertibleValues

Insert a value for the given key and value.

Specified by:

put in interface MutableConvertibleValues<Object>

Parameters:

key - The key

value - The value

Returns:

This values instance

remove

public MutableConvertibleValues<Object> remove(CharSequence key)

Description copied from interface: MutableConvertibleValues

Remove a value for the given key.

Specified by:

remove in interface MutableConvertibleValues<Object>

Parameters:

key - The key

Returns:

This values instance

clear

public MutableConvertibleValues<Object> clear()

Description copied from interface: MutableConvertibleValues

Clear all values.

Specified by:

clear in interface MutableConvertibleValues<Object>

Returns:

This values instance

names

public Set<String> names()

Specified by:

names in interface ConvertibleValues<Object>

Returns:

The names of the values

values

public Collection<Object> values()

Specified by:

values in interface ConvertibleValues<Object>

Returns:

The values

get

public <T> Optional<T> get(CharSequence name,
 ArgumentConversionContext<T> conversionContext)

Description copied from interface: ValueResolver

Resolve the given property for the given name.

Specified by:

get in interface ValueResolver<CharSequence>

Type Parameters:

T - The concrete type

Parameters:

name - The name

conversionContext - The conversion context

Returns:

An optional containing the property value if it exists and is able to be converted