HttpTunnelingSocketChannelConfig (Netty 3.10.5.Final API文档

java.lang.Object
- org.jboss.netty.channel.socket.http.HttpTunnelingSocketChannelConfig

所有已实现的接口:: ChannelConfig, SocketChannelConfig

public final class HttpTunnelingSocketChannelConfig
extends java.lang.Object
implements SocketChannelConfig

The ChannelConfig of a client-side HTTP tunneling SocketChannel. A SocketChannel created by HttpTunnelingClientSocketChannelFactory will return an instance of this configuration type for SocketChannel.getConfig().

Available options

In addition to the options provided by SocketChannelConfig, HttpTunnelingSocketChannelConfig allows the following options in the option map:

Name	Associated setter method
`"sslContext"`	`setSslContext(SSLContext)`
`"enabledSslCiperSuites"`	`setEnabledSslCipherSuites(String[])`
`"enabledSslProtocols"`	`setEnabledSslProtocols(String[])`
`"enableSslSessionCreation"`	`setEnableSslSessionCreation(boolean)`

方法概要

方法
限定符和类型	方法和说明
`ChannelBufferFactory`	`getBufferFactory()` Returns the default `ChannelBufferFactory` used to create a new `ChannelBuffer`.
`int`	`getConnectTimeoutMillis()` Returns the connect timeout of the channel in milliseconds.
`java.lang.String[]`	`getEnabledSslCipherSuites()` Returns the cipher suites enabled for use on an `SSLEngine`.
`java.lang.String[]`	`getEnabledSslProtocols()` Returns the protocol versions enabled for use on an `SSLEngine`.
`ChannelPipelineFactory`	`getPipelineFactory()` Returns the `ChannelPipelineFactory` which will be used when a child channel is created.
`int`	`getReceiveBufferSize()` Gets the `StandardSocketOptions.SO_RCVBUF` option.
`int`	`getSendBufferSize()` Gets the `StandardSocketOptions.SO_SNDBUF` option.
`java.lang.String`	`getServerName()` Returns the host name of the HTTP server.
`java.lang.String`	`getServerPath()` Returns the path where the `HttpTunnelingServlet` is mapped to.
`int`	`getSoLinger()` Gets the `StandardSocketOptions.SO_LINGER` option.
`javax.net.ssl.SSLContext`	`getSslContext()` Returns the `SSLContext` which is used to establish an HTTPS connection.
`int`	`getTrafficClass()` Gets the `StandardSocketOptions.IP_TOS` option.
`boolean`	`isEnableSslSessionCreation()` Returns `true` if new `SSLSession`s may be established by an `SSLEngine`.
`boolean`	`isKeepAlive()` Gets the `StandardSocketOptions.SO_KEEPALIVE` option.
`boolean`	`isReuseAddress()` Gets the `StandardSocketOptions.SO_REUSEADDR` option.
`boolean`	`isTcpNoDelay()` Gets the `StandardSocketOptions.TCP_NODELAY` option.
`void`	`setBufferFactory(ChannelBufferFactory bufferFactory)` Sets the default `ChannelBufferFactory` used to create a new `ChannelBuffer`.
`void`	`setConnectTimeoutMillis(int connectTimeoutMillis)` Sets the connect timeout of the channel in milliseconds.
`void`	`setEnabledSslCipherSuites(java.lang.String[] suites)` Sets the cipher suites enabled for use on an `SSLEngine`.
`void`	`setEnabledSslProtocols(java.lang.String[] protocols)` Sets the protocol versions enabled for use on an `SSLEngine`.
`void`	`setEnableSslSessionCreation(boolean flag)` Sets whether new `SSLSession`s may be established by an `SSLEngine`.
`void`	`setKeepAlive(boolean keepAlive)` Sets the `StandardSocketOptions.SO_KEEPALIVE` option.
`boolean`	`setOption(java.lang.String key, java.lang.Object value)` Sets a configuration property with the specified name and value.
`void`	`setOptions(java.util.Map<java.lang.String,java.lang.Object> options)` Sets the configuration properties from the specified `Map`.
`void`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)` Sets the performance preferences as specified in `Socket.setPerformancePreferences(int, int, int)`.
`void`	`setPipelineFactory(ChannelPipelineFactory pipelineFactory)` Sets the `ChannelPipelineFactory` which will be used when a child channel is created.
`void`	`setReceiveBufferSize(int receiveBufferSize)` Sets the `StandardSocketOptions.SO_RCVBUF` option.
`void`	`setReuseAddress(boolean reuseAddress)` Sets the `StandardSocketOptions.SO_REUSEADDR` option.
`void`	`setSendBufferSize(int sendBufferSize)` Sets the `StandardSocketOptions.SO_SNDBUF` option.
`void`	`setServerName(java.lang.String serverName)` Sets the host name of the HTTP server.
`void`	`setServerPath(java.lang.String serverPath)` Sets the path where the `HttpTunnelingServlet` is mapped to.
`void`	`setSoLinger(int soLinger)` Sets the `StandardSocketOptions.SO_LINGER` option.
`void`	`setSslContext(javax.net.ssl.SSLContext sslContext)` Sets the `SSLContext` which is used to establish an HTTPS connection.
`void`	`setTcpNoDelay(boolean tcpNoDelay)` Sets the `StandardSocketOptions.TCP_NODELAY` option.
`void`	`setTrafficClass(int trafficClass)` Sets the `StandardSocketOptions.IP_TOS` option.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getServerName
```
public java.lang.String getServerName()
```
    Returns the host name of the HTTP server. If null, the "Host" header is not sent by the HTTP tunneling client.
  - setServerName
```
public void setServerName(java.lang.String serverName)
```
    Sets the host name of the HTTP server. If null, the "Host" header is not sent by the HTTP tunneling client.
  - getServerPath
```
public java.lang.String getServerPath()
```
    Returns the path where the HttpTunnelingServlet is mapped to. The default value is "/netty-tunnel".
  - setServerPath
```
public void setServerPath(java.lang.String serverPath)
```
    Sets the path where the HttpTunnelingServlet is mapped to. The default value is "/netty-tunnel".
  - getSslContext
```
public javax.net.ssl.SSLContext getSslContext()
```
    Returns the SSLContext which is used to establish an HTTPS connection. If null, a plain-text HTTP connection is established.
  - setSslContext
```
public void setSslContext(javax.net.ssl.SSLContext sslContext)
```
    Sets the SSLContext which is used to establish an HTTPS connection. If null, a plain-text HTTP connection is established.
  - getEnabledSslCipherSuites
```
public java.lang.String[] getEnabledSslCipherSuites()
```
    Returns the cipher suites enabled for use on an SSLEngine. If null, the default value will be used.
    
    另请参阅:
    SSLEngine.getEnabledCipherSuites()
  - setEnabledSslCipherSuites
```
public void setEnabledSslCipherSuites(java.lang.String[] suites)
```
    Sets the cipher suites enabled for use on an SSLEngine. If null, the default value will be used.
    
    另请参阅:
    SSLEngine.setEnabledCipherSuites(String[])
  - getEnabledSslProtocols
```
public java.lang.String[] getEnabledSslProtocols()
```
    Returns the protocol versions enabled for use on an SSLEngine.
    
    另请参阅:
    SSLEngine.getEnabledProtocols()
  - setEnabledSslProtocols
```
public void setEnabledSslProtocols(java.lang.String[] protocols)
```
    Sets the protocol versions enabled for use on an SSLEngine.
    
    另请参阅:
    SSLEngine.setEnabledProtocols(String[])
  - isEnableSslSessionCreation
```
public boolean isEnableSslSessionCreation()
```
    Returns true if new SSLSessions may be established by an SSLEngine.
    
    另请参阅:
    SSLEngine.getEnableSessionCreation()
  - setEnableSslSessionCreation
```
public void setEnableSslSessionCreation(boolean flag)
```
    Sets whether new SSLSessions may be established by an SSLEngine.
    
    另请参阅:
    SSLEngine.setEnableSessionCreation(boolean)
  - setOptions
```
public void setOptions(java.util.Map<java.lang.String,java.lang.Object> options)
```
    从接口复制的说明: ChannelConfig
    
    Sets the configuration properties from the specified Map.
    
    指定者:
    
    setOptions 在接口中 ChannelConfig
  - setOption
```
public boolean setOption(java.lang.String key,
                java.lang.Object value)
```
    从接口复制的说明: ChannelConfig
    Sets a configuration property with the specified name and value. To override this method properly, you must call the super class:
```
 public boolean setOption(String name, Object value) {
     if (super.setOption(name, value)) {
         return true;
     }

     if (name.equals("additionalOption")) {
         ....
         return true;
     }

     return false;
 }
 
```
    指定者:
    
    setOption 在接口中 ChannelConfig
    
    返回:
    true if and only if the property has been set
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    从接口复制的说明: SocketChannelConfig
    
    Gets the StandardSocketOptions.SO_RCVBUF option.
    
    指定者:
    
    getReceiveBufferSize 在接口中 SocketChannelConfig
  - getSendBufferSize
```
public int getSendBufferSize()
```
    从接口复制的说明: SocketChannelConfig
    
    Gets the StandardSocketOptions.SO_SNDBUF option.
    
    指定者:
    
    getSendBufferSize 在接口中 SocketChannelConfig
  - getSoLinger
```
public int getSoLinger()
```
    从接口复制的说明: SocketChannelConfig
    
    Gets the StandardSocketOptions.SO_LINGER option.
    
    指定者:
    
    getSoLinger 在接口中 SocketChannelConfig
  - getTrafficClass
```
public int getTrafficClass()
```
    从接口复制的说明: SocketChannelConfig
    
    Gets the StandardSocketOptions.IP_TOS option.
    
    指定者:
    
    getTrafficClass 在接口中 SocketChannelConfig
  - isKeepAlive
```
public boolean isKeepAlive()
```
    从接口复制的说明: SocketChannelConfig
    
    Gets the StandardSocketOptions.SO_KEEPALIVE option.
    
    指定者:
    
    isKeepAlive 在接口中 SocketChannelConfig
  - isReuseAddress
```
public boolean isReuseAddress()
```
    从接口复制的说明: SocketChannelConfig
    
    Gets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    isReuseAddress 在接口中 SocketChannelConfig
  - isTcpNoDelay
```
public boolean isTcpNoDelay()
```
    从接口复制的说明: SocketChannelConfig
    
    Gets the StandardSocketOptions.TCP_NODELAY option.
    
    指定者:
    
    isTcpNoDelay 在接口中 SocketChannelConfig
  - setKeepAlive
```
public void setKeepAlive(boolean keepAlive)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_KEEPALIVE option.
    
    指定者:
    
    setKeepAlive 在接口中 SocketChannelConfig
  - setPerformancePreferences
```
public void setPerformancePreferences(int connectionTime,
                             int latency,
                             int bandwidth)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the performance preferences as specified in Socket.setPerformancePreferences(int, int, int).
    
    指定者:
    
    setPerformancePreferences 在接口中 SocketChannelConfig
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int receiveBufferSize)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_RCVBUF option.
    
    指定者:
    
    setReceiveBufferSize 在接口中 SocketChannelConfig
  - setReuseAddress
```
public void setReuseAddress(boolean reuseAddress)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_REUSEADDR option.
    
    指定者:
    
    setReuseAddress 在接口中 SocketChannelConfig
  - setSendBufferSize
```
public void setSendBufferSize(int sendBufferSize)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_SNDBUF option.
    
    指定者:
    
    setSendBufferSize 在接口中 SocketChannelConfig
  - setSoLinger
```
public void setSoLinger(int soLinger)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.SO_LINGER option.
    
    指定者:
    
    setSoLinger 在接口中 SocketChannelConfig
  - setTcpNoDelay
```
public void setTcpNoDelay(boolean tcpNoDelay)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.TCP_NODELAY option.
    
    指定者:
    
    setTcpNoDelay 在接口中 SocketChannelConfig
  - setTrafficClass
```
public void setTrafficClass(int trafficClass)
```
    从接口复制的说明: SocketChannelConfig
    
    Sets the StandardSocketOptions.IP_TOS option.
    
    指定者:
    
    setTrafficClass 在接口中 SocketChannelConfig
  - getBufferFactory
```
public ChannelBufferFactory getBufferFactory()
```
    从接口复制的说明: ChannelConfig
    
    Returns the default ChannelBufferFactory used to create a new ChannelBuffer. The default is HeapChannelBufferFactory. You can specify a different factory to change the default ByteOrder for example.
    
    指定者:
    
    getBufferFactory 在接口中 ChannelConfig
  - getConnectTimeoutMillis
```
public int getConnectTimeoutMillis()
```
    从接口复制的说明: ChannelConfig
    
    Returns the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.
    
    指定者:
    
    getConnectTimeoutMillis 在接口中 ChannelConfig
    
    返回:
    the connect timeout in milliseconds. 0 if disabled.
  - getPipelineFactory
```
public ChannelPipelineFactory getPipelineFactory()
```
    从接口复制的说明: ChannelConfig
    
    Returns the ChannelPipelineFactory which will be used when a child channel is created. If the Channel does not create a child channel, this property is not used at all, and therefore will be ignored.
    
    指定者:
    
    getPipelineFactory 在接口中 ChannelConfig
  - setBufferFactory
```
public void setBufferFactory(ChannelBufferFactory bufferFactory)
```
    从接口复制的说明: ChannelConfig
    
    Sets the default ChannelBufferFactory used to create a new ChannelBuffer. The default is HeapChannelBufferFactory. You can specify a different factory to change the default ByteOrder for example.
    
    指定者:
    
    setBufferFactory 在接口中 ChannelConfig
  - setConnectTimeoutMillis
```
public void setConnectTimeoutMillis(int connectTimeoutMillis)
```
    从接口复制的说明: ChannelConfig
    
    Sets the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.
    
    指定者:
    
    setConnectTimeoutMillis 在接口中 ChannelConfig
    
    参数:
    connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.
  - setPipelineFactory
```
public void setPipelineFactory(ChannelPipelineFactory pipelineFactory)
```
    从接口复制的说明: ChannelConfig
    
    Sets the ChannelPipelineFactory which will be used when a child channel is created. If the Channel does not create a child channel, this property is not used at all, and therefore will be ignored.
    
    指定者:
    
    setPipelineFactory 在接口中 ChannelConfig

类 HttpTunnelingSocketChannelConfig

Available options

方法概要

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

方法详细资料

getServerName

setServerName

getServerPath

setServerPath

getSslContext

setSslContext

getEnabledSslCipherSuites

setEnabledSslCipherSuites

getEnabledSslProtocols

setEnabledSslProtocols

isEnableSslSessionCreation

setEnableSslSessionCreation

setOptions

setOption

getReceiveBufferSize

getSendBufferSize

getSoLinger

getTrafficClass

isKeepAlive

isReuseAddress

isTcpNoDelay

setKeepAlive

setPerformancePreferences

setReceiveBufferSize

setReuseAddress

setSendBufferSize

setSoLinger

setTcpNoDelay

setTrafficClass

getBufferFactory

getConnectTimeoutMillis

getPipelineFactory

setBufferFactory

setConnectTimeoutMillis

setPipelineFactory