-
- All Known Subinterfaces:
- Encoder.Binary<T>, Encoder.BinaryStream<T>, Encoder.Text<T>, Encoder.TextStream<T>
public interface EncoderThe Encoder interface defines how developers can provide a way to convert their custom objects into web socket messages. The Encoder interface contains subinterfaces that allow encoding algorithms to encode custom objects to: text, binary data, character stream and write to an output stream. The websocket implementation creates a new instance of the encoder per endpoint instance per connection. This means that each encoder instance has at most one calling thread at a time. The lifecycle of the Encoder instance is governed by the container calls to theinit(javax.websocket.EndpointConfig)anddestroy()methods.- Author:
- dannycoward
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static interfaceEncoder.Binary<T>This interface defines how to provide a way to convert a custom object into a binary message.static interfaceEncoder.BinaryStream<T>This interface may be implemented by encoding algorithms that want to write the encoded object to a binary stream.static interfaceEncoder.Text<T>This interface defines how to provide a way to convert a custom object into a text message.static interfaceEncoder.TextStream<T>This interface may be implemented by encoding algorithms that want to write the encoded object to a character stream.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description voiddestroy()This method is called when the encoder is about to be removed from service in order that any resources the encoder used may be closed gracefully.voidinit(EndpointConfig config)This method is called with the endpoint configuration object of the endpoint this encoder is intended for when it is about to be brought into service.
-
-
-
Method Detail
-
init
void init(EndpointConfig config)
This method is called with the endpoint configuration object of the endpoint this encoder is intended for when it is about to be brought into service.- Parameters:
config- the endpoint configuration object when being brought into service
-
destroy
void destroy()
This method is called when the encoder is about to be removed from service in order that any resources the encoder used may be closed gracefully.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/websocket/encoder.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.