com.github.netty.protocol

类 HttpServletProtocol

java.lang.Object

com.github.netty.core.AbstractProtocol

com.github.netty.protocol.HttpServletProtocol

所有已实现的接口:

Ordered, ProtocolHandler, ServerListener

public class HttpServletProtocol
extends AbstractProtocol

HttpServlet protocol registry

作者:

wangzihao 2018/11/11/011

字段概要

从接口继承的字段 com.github.netty.core.Ordered

COMPARATOR

构造器概要

构造器

构造器和说明
HttpServletProtocol(ServletContext servletContext)
HttpServletProtocol(ServletContext servletContext, Supplier<Executor> executorSupplier, Supplier<Executor> defaultExecutorSupplier)

方法概要

限定符和类型	方法和说明
void	addPipeline(io.netty.channel.Channel ch, io.netty.buffer.ByteBuf clientFirstMsg) add protocol pipeline support
void	addServletPipeline(io.netty.channel.ChannelPipeline pipeline, Protocol protocol)
boolean	addWebSocketHandler(String pathPattern, WebSocketHandler handler)
boolean	canSupport(io.netty.buffer.ByteBuf msg) Support protocol
io.netty.handler.logging.LogLevel	getH2LogLevel(io.netty.channel.ChannelPipeline pipeline)
int	getHttp2MaxReservedStreams()
long	getMaxBufferBytes()
int	getOrder() default Priority order 0
String	getProtocolName() Get the protocol name
ServletContext	getServletContext()
io.netty.handler.ssl.SslContextBuilder	getSslContextBuilder()
WebsocketServletUpgrader	getWebsocketServletUpgrader()
boolean	isEnableH2()
boolean	isEnableH2c()
boolean	isEnableSsl()
boolean	onOutOfMaxConnection(io.netty.buffer.ByteBuf clientFirstMsg, TcpChannel tcpChannel, int currentConnections, int maxConnections) on out of max connection count
<T extends AbstractNettyServer> void	onServerStart(T server)
<T extends AbstractNettyServer> void	onServerStop(T server)
void	setCompressionMimeTypes(String[] compressionMimeTypes)
void	setContentSizeThreshold(int contentSizeThreshold)
void	setEnableContentCompression(boolean enableContentCompression)
void	setEnableH2(boolean enableH2)
void	setEnableH2c(boolean enableH2c)
void	setExecutor(Supplier<Executor> dispatcherExecutor)
void	setHttp2MaxReservedStreams(int http2MaxReservedStreams)
void	setMaxBufferBytes(int maxBufferBytes)
void	setMaxChunkSize(long maxChunkSize)
void	setMaxContentLength(long maxContentLength)
void	setMaxHeaderSize(int maxHeaderSize)
void	setMaxInitialLineLength(int maxInitialLineLength)
void	setSslContextBuilder(io.netty.handler.ssl.SslContextBuilder sslContextBuilder)
void	setSslFileCrtPem(File crtFile, File pemFile)
void	setSslFileJks(File jksKeyFile, File jksPassword)
void	setSslFileJks(File jksKeyFile, String jksPassword)
void	upgradeWebsocket(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest request)

从类继承的方法 com.github.netty.core.AbstractProtocol

getAutoFlushIdleMs, setAutoFlushIdleMs, toString

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.github.netty.core.ProtocolHandler

canSupport

从接口继承的方法 com.github.netty.core.ServerListener

config

从接口继承的方法 com.github.netty.core.Ordered

main

构造器详细资料

HttpServletProtocol

public HttpServletProtocol(ServletContext servletContext)

HttpServletProtocol

public HttpServletProtocol(ServletContext servletContext,
                           Supplier<Executor> executorSupplier,
                           Supplier<Executor> defaultExecutorSupplier)

方法详细资料

addWebSocketHandler

public boolean addWebSocketHandler(String pathPattern,
                                   WebSocketHandler handler)

getWebsocketServletUpgrader

public WebsocketServletUpgrader getWebsocketServletUpgrader()

onServerStart

public <T extends AbstractNettyServer> void onServerStart(T server)
                                                   throws Exception

抛出:

Exception

onServerStop

public <T extends AbstractNettyServer> void onServerStop(T server)

onOutOfMaxConnection

public boolean onOutOfMaxConnection(io.netty.buffer.ByteBuf clientFirstMsg,
                                    TcpChannel tcpChannel,
                                    int currentConnections,
                                    int maxConnections)

从接口复制的说明: ProtocolHandler

on out of max connection count

参数:

clientFirstMsg - clientFirstMsg

tcpChannel - tcpChannel

currentConnections - currentConnections

maxConnections - maxConnections

返回:

boolean. false=discard, true=keep handle

isEnableSsl

public boolean isEnableSsl()

canSupport

public boolean canSupport(io.netty.buffer.ByteBuf msg)

从接口复制的说明: ProtocolHandler

Support protocol

参数:

msg - client first message

返回:

true=Support, false=no Support

addPipeline

public void addPipeline(io.netty.channel.Channel ch,
                        io.netty.buffer.ByteBuf clientFirstMsg)
                 throws Exception

从接口复制的说明: ProtocolHandler

add protocol pipeline support

指定者:

addPipeline 在接口中 ProtocolHandler

覆盖:

addPipeline 在类中 AbstractProtocol

参数:

ch - TCP channel

clientFirstMsg - clientFirstMsg

抛出:

Exception - Exception

addServletPipeline

public void addServletPipeline(io.netty.channel.ChannelPipeline pipeline,
                               Protocol protocol)

isEnableH2c

public boolean isEnableH2c()

setEnableH2c

public void setEnableH2c(boolean enableH2c)

isEnableH2

public boolean isEnableH2()

setEnableH2

public void setEnableH2(boolean enableH2)

getHttp2MaxReservedStreams

public int getHttp2MaxReservedStreams()

setHttp2MaxReservedStreams

public void setHttp2MaxReservedStreams(int http2MaxReservedStreams)

getMaxBufferBytes

public long getMaxBufferBytes()

setMaxBufferBytes

public void setMaxBufferBytes(int maxBufferBytes)

setExecutor

public void setExecutor(Supplier<Executor> dispatcherExecutor)

getOrder

public int getOrder()

从接口复制的说明: ProtocolHandler

default Priority order 0

指定者:

getOrder 在接口中 Ordered

指定者:

getOrder 在接口中 ProtocolHandler

指定者:

getOrder 在接口中 ServerListener

覆盖:

getOrder 在类中 AbstractProtocol

返回:

The smaller the value of order, the more likely it is to be executed first

getProtocolName

public String getProtocolName()

从接口复制的说明: ProtocolHandler

Get the protocol name

返回:

name

getServletContext

public ServletContext getServletContext()

setSslFileJks

public void setSslFileJks(File jksKeyFile,
                          File jksPassword)
                   throws CertificateException,
                          IOException,
                          UnrecoverableKeyException,
                          NoSuchAlgorithmException,
                          KeyStoreException,
                          KeyManagementException

参数:

jksKeyFile - xxx.jks

jksPassword - jks-password

抛出:

CertificateException

IOException

UnrecoverableKeyException

NoSuchAlgorithmException

KeyStoreException

KeyManagementException

setSslFileJks

public void setSslFileJks(File jksKeyFile,
                          String jksPassword)
                   throws CertificateException,
                          IOException,
                          UnrecoverableKeyException,
                          NoSuchAlgorithmException,
                          KeyStoreException,
                          KeyManagementException

抛出:

CertificateException

IOException

UnrecoverableKeyException

NoSuchAlgorithmException

KeyStoreException

KeyManagementException

setSslFileCrtPem

public void setSslFileCrtPem(File crtFile,
                             File pemFile)

getSslContextBuilder

public io.netty.handler.ssl.SslContextBuilder getSslContextBuilder()

setSslContextBuilder

public void setSslContextBuilder(io.netty.handler.ssl.SslContextBuilder sslContextBuilder)

setMaxContentLength

public void setMaxContentLength(long maxContentLength)

setMaxInitialLineLength

public void setMaxInitialLineLength(int maxInitialLineLength)

setMaxHeaderSize

public void setMaxHeaderSize(int maxHeaderSize)

setMaxChunkSize

public void setMaxChunkSize(long maxChunkSize)

getH2LogLevel

public io.netty.handler.logging.LogLevel getH2LogLevel(io.netty.channel.ChannelPipeline pipeline)

setCompressionMimeTypes

public void setCompressionMimeTypes(String[] compressionMimeTypes)

setEnableContentCompression

public void setEnableContentCompression(boolean enableContentCompression)

setContentSizeThreshold

public void setContentSizeThreshold(int contentSizeThreshold)

upgradeWebsocket

public void upgradeWebsocket(io.netty.channel.ChannelHandlerContext ctx,
                             io.netty.handler.codec.http.HttpRequest request)