Class WebSocketTransportCodecs

java.lang.Object

io.fluxzero.common.websocket.WebSocketTransportCodecs

public final class WebSocketTransportCodecs
extends Object

Factory and built-in implementations for Fluxzero websocket transport codecs.

Method Summary

Modifier and Type	Method	Description
static WebSocketTransportCodec	binary(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Negotiated binary codec.
static WebSocketTransportCodec	binary(com.fasterxml.jackson.databind.ObjectMapper objectMapper, List<? extends WebSocketPayloadCodec> payloadCodecs)	Negotiated binary codec extended with protocol-specific compact payload representations.
static WebSocketTransportCodec	cbor(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Jackson CBOR codec.
static WebSocketTransportCodec	forFormat(WebSocketTransportFormat format, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Creates a codec for the supplied format.
static WebSocketTransportCodec	forFormat(WebSocketTransportFormat format, com.fasterxml.jackson.databind.ObjectMapper objectMapper, List<? extends WebSocketPayloadCodec> payloadCodecs)	Creates a codec with optional protocol-specific compact payload representations.
static WebSocketTransportCodec	json(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Existing JSON websocket codec.

Methods inherited from class Object

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

Method Details

forFormat

public static WebSocketTransportCodec forFormat(WebSocketTransportFormat format,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Creates a codec for the supplied format.

forFormat

public static WebSocketTransportCodec forFormat(WebSocketTransportFormat format,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 List<? extends WebSocketPayloadCodec> payloadCodecs)

Creates a codec with optional protocol-specific compact payload representations.

json

public static WebSocketTransportCodec json(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Existing JSON websocket codec. Jackson represents byte[] fields as base64 strings here.

cbor

public static WebSocketTransportCodec cbor(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Jackson CBOR codec. This keeps the JSON object model but writes byte[] fields as native binary.

binary

public static WebSocketTransportCodec binary(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Negotiated binary codec. Protocol values without a compact representation retain the CBOR representation.

binary

public static WebSocketTransportCodec binary(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 List<? extends WebSocketPayloadCodec> payloadCodecs)

Negotiated binary codec extended with protocol-specific compact payload representations.