|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.vertx.groovy.core.net.NetServer
abstract class NetServer
Represents a TCP or SSL server
This class is a thread safe and can safely be used by different threads.
If an instance is instantiated from an event loop then the handlers of the instance will always be called on that same event loop. If an instance is instantiated from some other arbitrary Java thread then and event loop will be assigned to the instance and used when any of its handlers are called.
Instances cannot be used from worker verticles
Field Summary | |
---|---|
protected NetServer |
jServer
|
Method Summary | |
---|---|
void
|
close()
Close the server. |
void
|
close(groovy.lang.Closure hndlr)
Close the server. |
NetServer
|
connectHandler(groovy.lang.Closure hndlr)
Supply a connect handler for this server. |
java.lang.Integer
|
getAcceptBacklog()
@return The accept backlog |
java.lang.String
|
getKeyStorePassword()
@return The keystore password |
java.lang.String
|
getKeyStorePath()
@return The path to the key store |
java.lang.Integer
|
getReceiveBufferSize()
@return The TCP receive buffer size |
java.lang.Integer
|
getSendBufferSize()
@return The TCP send buffer size |
java.lang.Integer
|
getTrafficClass()
@return the value of TCP traffic class |
java.lang.String
|
getTrustStorePassword()
@return The trust store password |
java.lang.String
|
getTrustStorePath()
@return The trust store path |
java.lang.Boolean
|
isReuseAddress()
@return The value of TCP reuse address |
boolean
|
isSSL()
@return true if this server will make SSL connections |
java.lang.Boolean
|
isSoLinger()
@return the value of TCP so linger |
java.lang.Boolean
|
isTCPKeepAlive()
@return true if TCP keep alive is enabled |
java.lang.Boolean
|
isTCPNoDelay()
@return true if Nagle's algorithm is disabled. |
NetServer
|
listen(int port)
Instruct the server to listen for incoming connections on the specified port and all available interfaces. |
NetServer
|
listen(int port, java.lang.String host)
Instruct the server to listen for incoming connections on the specified port and host. |
NetServer
|
setAcceptBacklog(int backlog)
Set the accept backlog |
NetServer
|
setClientAuthRequired(boolean required)
Set required to true if you want the server to request client authentication from any connecting clients. |
NetServer
|
setKeyStorePassword(java.lang.String pwd)
Set the password for the SSL key store. |
NetServer
|
setKeyStorePath(java.lang.String path)
Set the path to the SSL key store. |
NetServer
|
setReceiveBufferSize(int size)
Set the TCP receive buffer size for connections created by this instance to size in bytes. |
NetServer
|
setReuseAddress(boolean reuse)
Set the TCP reuseAddress setting for connections created by this instance to reuse. |
NetServer
|
setSSL(boolean ssl)
If ssl is true, this signifies that any connections will be SSL connections. |
NetServer
|
setSendBufferSize(int size)
Set the TCP send buffer size for connections created by this instance to size in bytes. |
NetServer
|
setSoLinger(boolean linger)
Set the TCP soLinger setting for connections created by this instance to reuse. |
NetServer
|
setTCPKeepAlive(boolean keepAlive)
Set the TCP keepAlive setting for connections created by this instance to keepAlive. |
NetServer
|
setTCPNoDelay(boolean tcpNoDelay)
If tcpNoDelay is set to true then Nagle's algorithm will turned off for the TCP connections created by this instance. |
NetServer
|
setTrafficClass(int trafficClass)
Set the TCP trafficClass setting for connections created by this instance to reuse. |
NetServer
|
setTrustStorePassword(java.lang.String pwd)
Set the password for the SSL trust store. |
NetServer
|
setTrustStorePath(java.lang.String path)
Set the path to the SSL trust store. |
Methods inherited from class java.lang.Object | |
---|---|
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Field Detail |
---|
protected NetServer jServer
Method Detail |
---|
void close()
void close(groovy.lang.Closure hndlr)
NetServer connectHandler(groovy.lang.Closure hndlr)
java.lang.Integer getAcceptBacklog()
java.lang.String getKeyStorePassword()
java.lang.String getKeyStorePath()
java.lang.Integer getReceiveBufferSize()
java.lang.Integer getSendBufferSize()
java.lang.Integer getTrafficClass()
java.lang.String getTrustStorePassword()
java.lang.String getTrustStorePath()
java.lang.Boolean isReuseAddress()
boolean isSSL()
java.lang.Boolean isSoLinger()
java.lang.Boolean isTCPKeepAlive()
java.lang.Boolean isTCPNoDelay()
NetServer listen(int port)
NetServer listen(int port, java.lang.String host)
NetServer setAcceptBacklog(int backlog)
NetServer setClientAuthRequired(boolean required)
NetServer setKeyStorePassword(java.lang.String pwd)
NetServer setKeyStorePath(java.lang.String path)
The SSL key store is a standard Java Key Store, and, if on the server side will contain the server certificate.
NetServer setReceiveBufferSize(int size)
NetServer setReuseAddress(boolean reuse)
NetServer setSSL(boolean ssl)
NetServer setSendBufferSize(int size)
NetServer setSoLinger(boolean linger)
NetServer setTCPKeepAlive(boolean keepAlive)
NetServer setTCPNoDelay(boolean tcpNoDelay)
NetServer setTrafficClass(int trafficClass)
NetServer setTrustStorePassword(java.lang.String pwd)
NetServer setTrustStorePath(java.lang.String path)
The trust store is a standard Java Key Store, and should contain the certificates of any clients that the server trusts - this is only necessary if client authentication is enabled.
Groovy Documentation