HttpServerOptions

Constructors

this
this()
Undocumented in source.
this
this(NetServerOptions options)
Undocumented in source.
this
this(NetServerOptions serverOptions, HttpRequestOptions requestOptions)
Undocumented in source.

Members

Functions

canUpgrade
bool canUpgrade()
Undocumented in source. Be warned that the author may not have intended to support it.
canUpgrade
HttpServerOptions canUpgrade(bool value)
Undocumented in source. Be warned that the author may not have intended to support it.
getClientAuth
ClientAuth getClientAuth()
getDefaultMaxInactiveInterval
int getDefaultMaxInactiveInterval()
Undocumented in source. Be warned that the author may not have intended to support it.
getHost
string getHost()

@return the host

getPort
int getPort()

@return the port

getSessionIdParameterName
string getSessionIdParameterName()
Undocumented in source. Be warned that the author may not have intended to support it.
getTcpConfiguration
NetServerOptions getTcpConfiguration()
Undocumented in source. Be warned that the author may not have intended to support it.
requestOptions
HttpRequestOptions requestOptions()
Undocumented in source. Be warned that the author may not have intended to support it.
setClientAuth
HttpServerOptions setClientAuth(ClientAuth clientAuth)

Set whether client auth is required

setDefaultMaxInactiveInterval
void setDefaultMaxInactiveInterval(int interval)
Undocumented in source. Be warned that the author may not have intended to support it.
setHost
HttpServerOptions setHost(string host)

Set the host @param host the host @return a reference to this, so the API can be used fluently

setPort
HttpServerOptions setPort(ushort port)

Set the port

setSessionIdParameterName
void setSessionIdParameterName(string name)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

DEFAULT_CLIENT_AUTH
enum ClientAuth DEFAULT_CLIENT_AUTH;

Default value of whether client auth is required (SSL/TLS) = No

Inherited Members

From HttpOptions

DEFAULT_WINDOW_SIZE
enum int DEFAULT_WINDOW_SIZE;
Undocumented in source.
getTcpConfiguration
TcpSslOptions getTcpConfiguration()

Get the TCP configuration.

setTcpConfiguration
void setTcpConfiguration(TcpSslOptions tcpSslOptions)

Set the TCP configuration.

getMaxDynamicTableSize
int getMaxDynamicTableSize()

Get the max dynamic table size of HTTP2 protocol.

setMaxDynamicTableSize
void setMaxDynamicTableSize(int maxDynamicTableSize)

Set the max dynamic table size of HTTP2 protocol.

getStreamIdleTimeout
int getStreamIdleTimeout()

Get the HTTP2 stream idle timeout. The time unit is millisecond.

setStreamIdleTimeout
void setStreamIdleTimeout(int streamIdleTimeout)

Set the HTTP2 stream idle timeout. The time unit is millisecond.

getFlowControlStrategy
string getFlowControlStrategy()

Get the HTTP2 flow control strategy. The value is "simple" or "buffer". If you use the "simple" flow control strategy, once the server or client receives the data, it will send the WindowUpdateFrame. If you use the "buffer" flow control strategy, the server or client will send WindowUpdateFrame when the consumed data exceed the threshold.

setFlowControlStrategy
void setFlowControlStrategy(string flowControlStrategy)

Set the HTTP2 flow control strategy. The value is "simple" or "buffer". If you use the "simple" flow control strategy, once the server or client receives the data, it will send the WindowUpdateFrame. If you use the "buffer" flow control strategy, the server or client will send WindowUpdateFrame when the consumed data exceed the threshold.

getInitialSessionRecvWindow
int getInitialSessionRecvWindow()

Get the HTTP2 initial receiving window size. The unit is byte.

setInitialSessionRecvWindow
void setInitialSessionRecvWindow(int initialSessionRecvWindow)

Set the HTTP2 initial receiving window size. The unit is byte.

getInitialStreamSendWindow
int getInitialStreamSendWindow()

Get the HTTP2 initial sending window size. The unit is byte.

setInitialStreamSendWindow
void setInitialStreamSendWindow(int initialStreamSendWindow)

Set the HTTP2 initial sending window size. The unit is byte.

getMaxConcurrentStreams
int getMaxConcurrentStreams()

Get the max concurrent stream size in a HTTP2 session.

setMaxConcurrentStreams
void setMaxConcurrentStreams(int maxConcurrentStreams)

Set the max concurrent stream size in a HTTP2 session.

getMaxHeaderBlockFragment
int getMaxHeaderBlockFragment()

Set the max HTTP2 header block size. If the header block size more the this value, the server or client will split the header buffer to many buffers to send.

setMaxHeaderBlockFragment
void setMaxHeaderBlockFragment(int maxHeaderBlockFragment)

Get the max HTTP2 header block size. If the header block size more the this value, the server or client will split the header buffer to many buffers to send.

getMaxRequestHeadLength
int getMaxRequestHeadLength()

Get the max HTTP request header size.

setMaxRequestHeadLength
void setMaxRequestHeadLength(int maxRequestHeadLength)

Set the max HTTP request header size.

getMaxResponseHeadLength
int getMaxResponseHeadLength()

Get the max HTTP response header size.

setMaxResponseHeadLength
void setMaxResponseHeadLength(int maxResponseHeadLength)

Set the max HTTP response header size.

getMaxRequestTrailerLength
int getMaxRequestTrailerLength()

Get the max HTTP request trailer size.

setMaxRequestTrailerLength
void setMaxRequestTrailerLength(int maxRequestTrailerLength)

Set the max HTTP request trailer size.

getMaxResponseTrailerLength
int getMaxResponseTrailerLength()

Get the max HTTP response trailer size.

setMaxResponseTrailerLength
void setMaxResponseTrailerLength(int maxResponseTrailerLength)

Set the max HTTP response trailer size.

getCharacterEncoding
string getCharacterEncoding()

Get the charset of the text HTTP body.

setCharacterEncoding
void setCharacterEncoding(string characterEncoding)

Set the charset of the text HTTP body.

isSecureConnectionEnabled
bool isSecureConnectionEnabled()

If return true, the server or client enable the SSL/TLS connection.

isSecureConnectionEnabled
void isSecureConnectionEnabled(bool status)

If set true, the server or client enable the SSL/TLS connection.

setSecureConnectionEnabled
void setSecureConnectionEnabled(bool status)
Undocumented in source. Be warned that the author may not have intended to support it.
isCertificateAuth
bool isCertificateAuth()
Undocumented in source. Be warned that the author may not have intended to support it.
isCertificateAuth
void isCertificateAuth(bool flag)
Undocumented in source. Be warned that the author may not have intended to support it.
setKeyCertOptions
void setKeyCertOptions(KeyCertOptions options)
Undocumented in source. Be warned that the author may not have intended to support it.
getKeyCertOptions
KeyCertOptions getKeyCertOptions()
Undocumented in source. Be warned that the author may not have intended to support it.
getProtocol
string getProtocol()

Get the default HTTP protocol version. The value is "HTTP/2.0" or "HTTP/1.1". If the value is null, the server or client will negotiate a HTTP protocol version using ALPN.

setProtocol
void setProtocol(string protocol)

Set the default HTTP protocol version. The value is "HTTP/2.0" or "HTTP/1.1". If the value is null, the server or client will negotiate a HTTP protocol version using ALPN.

getHttp2PingInterval
int getHttp2PingInterval()

Get the HTTP2 connection sending ping frame interval. The time unit is millisecond.

setHttp2PingInterval
void setHttp2PingInterval(int http2PingInterval)

Set the sending ping frame interval. The time unit is millisecond.

getWebsocketPingInterval
int getWebsocketPingInterval()

Get the WebSocket connection sending ping frame interval. The time unit is millisecond.

setWebsocketPingInterval
void setWebsocketPingInterval(int websocketPingInterval)

Set the WebSocket connection sending ping frame interval. The time unit is millisecond.

setRetryTimes
void setRetryTimes(int times)
Undocumented in source. Be warned that the author may not have intended to support it.
setRetryInterval
void setRetryInterval(Duration timeout)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta