@Deprecated public abstract class StreamInbound extends Object implements UpgradeInbound
MessageInbound.| Constructor and Description |
|---|
StreamInbound()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
int |
getOutboundByteBufferSize()
Deprecated.
|
int |
getOutboundCharBufferSize()
Deprecated.
|
int |
getReadTimeout()
Deprecated.
This default implementation sets the read timeout to infinite and expects
the WebSocket application to close the connection when it is no longer
required.
|
WsOutbound |
getWsOutbound()
Deprecated.
Obtain the outbound side of this WebSocket connection used for writing
data to the client.
|
protected abstract void |
onBinaryData(InputStream is)
Deprecated.
This method is called when there is a binary WebSocket message available
to process.
|
protected void |
onClose(int status)
Deprecated.
Intended to be overridden by sub-classes that wish to be notified
when the outbound connection is closed.
|
AbstractEndpoint.Handler.SocketState |
onData()
Deprecated.
|
protected void |
onOpen(WsOutbound outbound)
Deprecated.
Intended to be overridden by sub-classes that wish to be notified
when the outbound connection is established.
|
protected void |
onPong(ByteBuffer payload)
Deprecated.
Intended to be overridden by sub-classes that wish to be notified
when a pong is received.
|
protected abstract void |
onTextData(Reader r)
Deprecated.
This method is called when there is a textual WebSocket message available
to process.
|
void |
onUpgradeComplete()
Deprecated.
|
void |
setOutboundByteBufferSize(int outboundByteBufferSize)
Deprecated.
This only applies to the
WsOutbound instance returned from
getWsOutbound() created by a subsequent call to
setUpgradeOutbound(UpgradeOutbound). |
void |
setOutboundCharBufferSize(int outboundCharBufferSize)
Deprecated.
This only applies to the
WsOutbound instance returned from
getWsOutbound() created by a subsequent call to
setUpgradeOutbound(UpgradeOutbound). |
void |
setUpgradeOutbound(UpgradeOutbound upgradeOutbound)
Deprecated.
|
void |
setUpgradeProcessor(UpgradeProcessor<?> processor)
Deprecated.
|
public int getOutboundByteBufferSize()
public void setOutboundByteBufferSize(int outboundByteBufferSize)
WsOutbound instance returned from
getWsOutbound() created by a subsequent call to
setUpgradeOutbound(UpgradeOutbound). The current
WsOutbound instance, if any, is not affected.outboundByteBufferSize - public int getOutboundCharBufferSize()
public void setOutboundCharBufferSize(int outboundCharBufferSize)
WsOutbound instance returned from
getWsOutbound() created by a subsequent call to
setUpgradeOutbound(UpgradeOutbound). The current
WsOutbound instance, if any, is not affected.outboundCharBufferSize - public final void setUpgradeOutbound(UpgradeOutbound upgradeOutbound)
setUpgradeOutbound in interface UpgradeInboundpublic final void setUpgradeProcessor(UpgradeProcessor<?> processor)
setUpgradeProcessor in interface UpgradeInboundpublic final WsOutbound getWsOutbound()
public final AbstractEndpoint.Handler.SocketState onData() throws IOException
onData in interface UpgradeInboundIOExceptionpublic final void onUpgradeComplete()
onUpgradeComplete in interface UpgradeInboundprotected void onOpen(WsOutbound outbound)
outbound - The outbound WebSocket connection.protected void onClose(int status)
status - The status code of the close reason.protected void onPong(ByteBuffer payload)
payload - The payload included in the pong.protected abstract void onBinaryData(InputStream is) throws IOException
is - The WebSocket messageIOException - If a problem occurs processing the message. Any
exception will trigger the closing of the WebSocket
connection.protected abstract void onTextData(Reader r) throws IOException
r - The WebSocket messageIOException - If a problem occurs processing the message. Any
exception will trigger the closing of the WebSocket
connection.public int getReadTimeout()
getReadTimeout in interface UpgradeInboundCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.