Class: NetServer

vertx/net. NetServer

new NetServer()

Represents a TCP or SSL server.
Source:

Extends

Methods

acceptBacklog(backlog) → {number|Object}

Set or get the server's accept backlog
Parameters:
Name Type Argument Description
backlog number <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
number | Object

clientAuthRequired(required) → {boolean|Object}

Get or set whether client authorization is required
Parameters:
Name Type Argument Description
required boolean <optional>
 If provided, sets whether client authorization is required
Inherited From:
Source:
Returns:
the current status, or this
Type
boolean | Object

close(handler)

Close the server. This will close any open connections.
Parameters:
Name Type Argument Description
handler Handler <optional>
 the handler to call when the close operation has completed
Source:

connectHandler(handler) → {module:vertx/net.NetServer}

Supply a connect handler for this server. The server can only have at most one connect handler at any one time. As the server accepts TCP or SSL connections it creates an instance of module:vertx/net.NetSocket and passes it to the connect handler.
Parameters:
Name Type Description
handler ConnectHandler the connection handler
Source:
Returns:
this
Type
module:vertx/net.NetServer

host() → {string}

The host name
Source:
Returns:
the host
Type
string

keyStorePassword(password) → {boolean|Object}

Get or set the current keystore password for this object.
Parameters:
Name Type Argument Description
password string <optional>
 If provided, sets the keystore password
Inherited From:
Source:
Returns:
the current password, or this.
Type
boolean | Object

keyStorePath(path) → {boolean|Object}

Get or set the current keystore path for this object.
Parameters:
Name Type Argument Description
path string <optional>
 If provided, sets the keystore path
Inherited From:
Source:
Returns:
the current path, or this.
Type
boolean | Object

listen(port, host, handler) → {module:vertx/net.NetServer}

Tell the server to start listening on all available interfaces and port. Be aware this is an async operation and the server may not bound on return of the method.
Parameters:
Name Type Argument Description
port number The network port to listen on
host string <optional>
 The hostname or IP address to listen on
handler ListenHandler <optional>
 The listen handler
Source:
Returns:
this
Type
module:vertx/net.NetServer

port() → {number}

The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port.
Source:
Returns:
The port number the server is listening on
Type
number

receiveBufferSize(size) → {number|Object}

Set or get the receive buffer size
Parameters:
Name Type Argument Description
size number <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
number | Object

reuseAddress(reuse) → {boolean|Object}

Set or get the TCP reuse address value
Parameters:
Name Type Argument Description
reuse boolean <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
boolean | Object

sendBufferSize(size) → {number|Object}

Set or get the send buffer size
Parameters:
Name Type Argument Description
size number <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
number | Object

soLinger(linger) → {boolean|Object}

Set or get the TCP so linger value
Parameters:
Name Type Argument Description
linger boolean <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
boolean | Object

ssl(ssl) → {boolean|Object}

Get or set the current SSL support for this object.
Parameters:
Name Type Argument Description
ssl boolean <optional>
 If provided, sets whether this object supports SSL
Inherited From:
Source:
Returns:
the current status, or this.
Type
boolean | Object

tcpKeepAlive(keepAlive) → {boolean|Object}

Set or get the TCP keep-alive value
Parameters:
Name Type Argument Description
keepAlive boolean <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
boolean | Object

tcpNoDelay(nodelay) → {boolean|Object}

Set or get the TCP no delay value.
Parameters:
Name Type Argument Description
nodelay boolean <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
boolean | Object

trafficClass(class) → {number|Object}

Set or get the TCP traffic class
Parameters:
Name Type Argument Description
class number <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
number | Object

trustStorePassword(password) → {boolean|Object}

Get or set the current trust store password for this object.
Parameters:
Name Type Argument Description
password string <optional>
 If provided, sets the trust store password
Inherited From:
Source:
Returns:
the current password, or this.
Type
boolean | Object

trustStorePath(path) → {boolean|Object}

Get or set the current trust store path for this object.
Parameters:
Name Type Argument Description
path string <optional>
 If provided, sets the trust store path
Inherited From:
Source:
Returns:
the current path, or this.
Type
boolean | Object

usePooledBuffers(use) → {boolean|Object}

Set or get if vertx should use pooled buffers for performance reasons. Doing so will give the best throughput but may need a bit higher memory footprint.
Parameters:
Name Type Argument Description
use boolean <optional>
 If provided, set the value; if not, returns the current value.
Inherited From:
Source:
Returns:
the value or this
Type
boolean | Object