-
- All Superinterfaces:
- RemoteEndpoint
- Enclosing interface:
- RemoteEndpoint
public static interface RemoteEndpoint.Basic extends RemoteEndpoint
This representation of the peer of a web socket conversation has the ability to send messages synchronously. The point of completion of the send is defined when all the supplied data has been written to the underlying connection. The methods for sending messages on the RemoteEndpoint.Basic block until this point of completion is reached, except forgetSendStream
andgetSendWriter
which present traditional blocking I/O streams to write messages.If the websocket connection underlying this RemoteEndpoint is busy sending a message when a call is made to send another one, for example if two threads attempt to call a send method concurrently, or if a developer attempts to send a new message while in the middle of sending an existing one, the send method called while the connection is already busy may throw an
IllegalStateException
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javax.websocket.RemoteEndpoint
RemoteEndpoint.Async, RemoteEndpoint.Basic
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description OutputStream
getSendStream()
Opens an output stream on which a binary message may be sent.Writer
getSendWriter()
Opens an character stream on which a text message may be sent.void
sendBinary(ByteBuffer data)
Send a binary message, returning when all of the message has been transmitted.void
sendBinary(ByteBuffer partialByte, boolean isLast)
Send a binary message in parts, blocking until all of the message has been transmitted.void
sendObject(Object data)
Sends a custom developer object, blocking until it has been transmitted.void
sendText(String text)
Send a text message, blocking until all of the message has been transmitted.void
sendText(String partialMessage, boolean isLast)
Send a text message in parts, blocking until all of the message has been transmitted.-
Methods inherited from interface javax.websocket.RemoteEndpoint
flushBatch, getBatchingAllowed, sendPing, sendPong, setBatchingAllowed
-
-
-
-
Method Detail
-
sendText
void sendText(String text) throws IOException
Send a text message, blocking until all of the message has been transmitted.- Parameters:
text
- the message to be sent.- Throws:
IOException
- if there is a problem delivering the message.IllegalArgumentException
- if the text isnull
.
-
sendBinary
void sendBinary(ByteBuffer data) throws IOException
Send a binary message, returning when all of the message has been transmitted.- Parameters:
data
- the message to be sent.- Throws:
IOException
- if there is a problem delivering the message.IllegalArgumentException
- if the data isnull
.
-
sendText
void sendText(String partialMessage, boolean isLast) throws IOException
Send a text message in parts, blocking until all of the message has been transmitted. The runtime reads the message in order. Non-final parts of the message are sent with isLast set to false. The final part must be sent with isLast set to true.- Parameters:
partialMessage
- the parts of the message being sent.isLast
- Whether the partial message being sent is the last part of the message.- Throws:
IOException
- if there is a problem delivering the message fragment.IllegalArgumentException
- if the partialMessage isnull
.
-
sendBinary
void sendBinary(ByteBuffer partialByte, boolean isLast) throws IOException
Send a binary message in parts, blocking until all of the message has been transmitted. The runtime reads the message in order. Non-final parts are sent with isLast set to false. The final piece must be sent with isLast set to true.- Parameters:
partialByte
- the part of the message being sent.isLast
- Whether the partial message being sent is the last part of the message.- Throws:
IOException
- if there is a problem delivering the partial message.IllegalArgumentException
- if the partialByte isnull
.
-
getSendStream
OutputStream getSendStream() throws IOException
Opens an output stream on which a binary message may be sent. The developer must close the output stream in order to indicate that the complete message has been placed into the output stream.- Returns:
- the output stream to which the message will be written.
- Throws:
IOException
- if there is a problem obtaining the OutputStream to write the binary message.
-
getSendWriter
Writer getSendWriter() throws IOException
Opens an character stream on which a text message may be sent. The developer must close the writer in order to indicate that the complete message has been placed into the character stream.- Returns:
- the writer to which the message will be written.
- Throws:
IOException
- if there is a problem obtaining the Writer to write the text message.
-
sendObject
void sendObject(Object data) throws IOException, EncodeException
Sends a custom developer object, blocking until it has been transmitted. Containers will by default be able to encode java primitive types and their object equivalents, otherwise the developer must have provided an encoder for the object type in the endpoint configuration. A developer-provided encoder for a Java primitive type overrides the container default encoder.- Parameters:
data
- the object to be sent.- Throws:
IOException
- if there is a communication error sending the message object.EncodeException
- if there was a problem encoding the message object into the form of a native websocket message.IllegalArgumentException
- if the data parameter isnull
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/websocket/RemoteEndpoint.Basic.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.