Package io.micronaut.http.netty.websocket

Class WebSocketMessageEncoder

java.lang.Object

io.micronaut.http.netty.websocket.WebSocketMessageEncoder

@Requires(classes=io.micronaut.websocket.exceptions.WebSocketSessionException.class)
@Singleton
public class WebSocketMessageEncoder
extends Object

Encapsulate functionality to encode WebSocket messages.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
WebSocketMessageEncoder(io.micronaut.http.codec.MediaTypeCodecRegistry codecRegistry)	Deprecated, for removal: This API element is subject to removal in a future version. Not used anymore
WebSocketMessageEncoder(io.micronaut.http.codec.MediaTypeCodecRegistry codecRegistry, io.micronaut.http.body.MessageBodyHandlerRegistry messageBodyHandlerRegistry)

Method Summary

Modifier and Type	Method	Description
io.netty.handler.codec.http.websocketx.WebSocketFrame	encodeMessage(Object message, io.micronaut.http.MediaType mediaType)	Encode the given message with the given media type.

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocketMessageEncoder

@Deprecated(forRemoval=true,
            since="4.7")
public WebSocketMessageEncoder(io.micronaut.http.codec.MediaTypeCodecRegistry codecRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

Not used anymore

Parameters:

codecRegistry - The codec registry

WebSocketMessageEncoder

@Inject
public WebSocketMessageEncoder(io.micronaut.http.codec.MediaTypeCodecRegistry codecRegistry,
 io.micronaut.http.body.MessageBodyHandlerRegistry messageBodyHandlerRegistry)

Parameters:

codecRegistry - The codec registry

messageBodyHandlerRegistry - The message body handler registry

Method Details

encodeMessage

public io.netty.handler.codec.http.websocketx.WebSocketFrame encodeMessage(Object message,
 io.micronaut.http.MediaType mediaType)

Encode the given message with the given media type.

Parameters:

message - The message

mediaType - The media type

Returns:

The encoded frame