jakarta.websocket

Interface Decoder.BinaryStream<T>

Type Parameters:

T - The type of the object that is decoded

All Superinterfaces:

Decoder

Enclosing interface:

Decoder

public static interface Decoder.BinaryStream<T>
extends Decoder

This interface defines how a custom object is decoded from a web socket message in the form of a binary stream.

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.websocket.Decoder

Decoder.Binary<T>, Decoder.BinaryStream<T>, Decoder.Text<T>, Decoder.TextStream<T>

Method Summary

Modifier and Type	Method and Description
T	decode(java.io.InputStream is) Decode the given bytes read from the input stream into an object of type T.

Methods inherited from interface jakarta.websocket.Decoder

destroy, init

Method Detail

decode

T decode(java.io.InputStream is)
  throws DecodeException,
         java.io.IOException

Decode the given bytes read from the input stream into an object of type T.

Parameters:

is - the input stream carrying the bytes.

Returns:

the decoded object.

Throws:

DecodeException - If the provided input stream cannot be decoded to type T

java.io.IOException - If an error occurs reading the input stream