plus.jdk.websocket.model

接口 IWsSession<T>

所有已知实现类:

WsSession

public interface IWsSession<T>

方法概要

限定符和类型	方法和说明
default io.netty.buffer.ByteBufAllocator	alloc() Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
default long	bytesBeforeUnwritable() Get how many bytes can be written until isWritable() returns false.
default long	bytesBeforeWritable() Get how many bytes must be drained from underlying buffers until isWritable() returns true.
default io.netty.channel.ChannelFuture	close()
default io.netty.channel.ChannelFuture	close(io.netty.channel.ChannelPromise promise)
default io.netty.channel.ChannelFuture	closeFuture() Returns the ChannelFuture which will be notified when this channel is closed.
default io.netty.channel.ChannelConfig	config() Returns the configuration of this channel.
default io.netty.channel.Channel	flush()
default <T> T	getAttribute(String name)
io.netty.channel.Channel	getChannel()
T	getUserId()
default io.netty.channel.ChannelId	id() Returns the globally unique identifier of this Channel.
default boolean	isActive() Return true if the Channel is active and so connected.
default boolean	isOpen() Returns true if the Channel is open and may get active later
default boolean	isRegistered() Returns true if the Channel is registered with an EventLoop.
default boolean	isWritable() Returns true if and only if the I/O thread will perform the requested write operation immediately.
default SocketAddress	localAddress() Returns the local address where this channel is bound to.
default io.netty.channel.ChannelMetadata	metadata() Return the ChannelMetadata of the Channel which describe the nature of the Channel.
default io.netty.channel.ChannelPipeline	pipeline() Return the assigned ChannelPipeline.
default io.netty.channel.Channel	read()
default SocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
default io.netty.channel.ChannelFuture	sendBinary(io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame binaryWebSocketFrame)
default io.netty.channel.ChannelFuture	sendBinary(byte[] bytes)
default io.netty.channel.ChannelFuture	sendBinary(io.netty.buffer.ByteBuf byteBuf)
default io.netty.channel.ChannelFuture	sendBinary(ByteBuffer byteBuffer)
default io.netty.channel.ChannelFuture	sendText(io.netty.buffer.ByteBuf byteBuf)
default io.netty.channel.ChannelFuture	sendText(ByteBuffer byteBuffer)
default io.netty.channel.ChannelFuture	sendText(String message)
default io.netty.channel.ChannelFuture	sendText(io.netty.handler.codec.http.websocketx.TextWebSocketFrame textWebSocketFrame)
default <T> void	setAttribute(String name, T value)
void	setChannel(io.netty.channel.Channel channel)
default void	setSubProtocols(String subProtocols)
void	setUserId(T userId)
default io.netty.channel.Channel.Unsafe	unsafe() Returns an internal-use-only object that provides unsafe operations.

方法详细资料

getUserId

T getUserId()

setUserId

void setUserId(T userId)

getChannel

io.netty.channel.Channel getChannel()

setChannel

void setChannel(io.netty.channel.Channel channel)

setSubProtocols

default void setSubProtocols(String subProtocols)

sendText

default io.netty.channel.ChannelFuture sendText(String message)

sendText

default io.netty.channel.ChannelFuture sendText(io.netty.buffer.ByteBuf byteBuf)

sendText

default io.netty.channel.ChannelFuture sendText(ByteBuffer byteBuffer)

sendText

default io.netty.channel.ChannelFuture sendText(io.netty.handler.codec.http.websocketx.TextWebSocketFrame textWebSocketFrame)

sendBinary

default io.netty.channel.ChannelFuture sendBinary(byte[] bytes)

sendBinary

default io.netty.channel.ChannelFuture sendBinary(io.netty.buffer.ByteBuf byteBuf)

sendBinary

default io.netty.channel.ChannelFuture sendBinary(ByteBuffer byteBuffer)

sendBinary

default io.netty.channel.ChannelFuture sendBinary(io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame binaryWebSocketFrame)

setAttribute

default <T> void setAttribute(String name,
                              T value)

getAttribute

default <T> T getAttribute(String name)

id

default io.netty.channel.ChannelId id()

Returns the globally unique identifier of this Channel.

config

default io.netty.channel.ChannelConfig config()

Returns the configuration of this channel.

isOpen

default boolean isOpen()

Returns true if the Channel is open and may get active later

isRegistered

default boolean isRegistered()

Returns true if the Channel is registered with an EventLoop.

isActive

default boolean isActive()

Return true if the Channel is active and so connected.

metadata

default io.netty.channel.ChannelMetadata metadata()

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

localAddress

default SocketAddress localAddress()

Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

返回:

the local address of this channel. null if this channel is not bound.

remoteAddress

default SocketAddress remoteAddress()

Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

返回:

the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.

closeFuture

default io.netty.channel.ChannelFuture closeFuture()

Returns the ChannelFuture which will be notified when this channel is closed. This method always returns the same future instance.

isWritable

default boolean isWritable()

Returns true if and only if the I/O thread will perform the requested write operation immediately. Any write requests made when this method returns false are queued until the I/O thread is ready to process the queued write requests.

bytesBeforeUnwritable

default long bytesBeforeUnwritable()

Get how many bytes can be written until isWritable() returns false. This quantity will always be non-negative. If isWritable() is false then 0.

bytesBeforeWritable

default long bytesBeforeWritable()

Get how many bytes must be drained from underlying buffers until isWritable() returns true. This quantity will always be non-negative. If isWritable() is true then 0.

unsafe

default io.netty.channel.Channel.Unsafe unsafe()

Returns an internal-use-only object that provides unsafe operations.

pipeline

default io.netty.channel.ChannelPipeline pipeline()

Return the assigned ChannelPipeline.

alloc

default io.netty.buffer.ByteBufAllocator alloc()

Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.

read

default io.netty.channel.Channel read()

flush

default io.netty.channel.Channel flush()

close

default io.netty.channel.ChannelFuture close()

close

default io.netty.channel.ChannelFuture close(io.netty.channel.ChannelPromise promise)