Server
Related Doc:
package https
The server.addContext() method adds a secure context that will be used if the client request's SNI hostname matches the supplied hostname (or wildcard).
The server.addContext() method adds a secure context that will be used if the client request's SNI hostname matches the supplied hostname (or wildcard).
<string> A SNI hostname or wildcard (e.g. '*')
<Object> An object containing any of the possible properties from the tls.createSecureContext() options arguments (e.g. key, cert, ca, etc).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
emitter.addListener(eventName, listener)
on()
Returns the bound address, the address family name and port of the server as reported by the operating system.
Returns the bound address, the address family name and port of the server as reported by the operating system. Useful to find which port was assigned when giving getting an OS-assigned address. Returns an object with three properties, e.g. { port: 12346, family: 'IPv4', address: '127.0.0.1' }
server.address()
Stops the server from accepting new connections and keeps existing connections.
Stops the server from accepting new connections and keeps existing connections. This function is asynchronous, the server is finally closed when all connections are ended and the server emits a 'close' event. The optional callback will be called once the 'close' event occurs. Unlike that event, it will be called with an Error as its only argument if the server was not open when it was closed.
server.close([callback])
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Returns true if the event had listeners, false otherwise.
the event name
the event arguments
emitter.emit(name[, arg1][, arg2][, ...])
Asynchronously get the number of concurrent connections on the server.
Asynchronously get the number of concurrent connections on the server. Works when sockets were sent to forks. Callback should take two arguments err and count.
server.getConnections(callback)
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
emitter.getMaxListeners()
setMaxListeners()
Returns a Buffer instance holding the keys currently used for encryption/decryption of the TLS Session Tickets
Returns a Buffer instance holding the keys currently used for encryption/decryption of the TLS Session Tickets
a Buffer
server.listen(port[, hostname][, backlog][, callback])
server.listen(port[, hostname][, backlog][, callback])
server.listen(port[, hostname][, backlog][, callback])
server.listen(port[, hostname][, backlog][, callback])
The port, host, and backlog properties of options, as well as the optional callback function, behave as they do on a call to server.listen(port[, hostname][, backlog][, callback]).
The port, host, and backlog properties of options, as well as the optional callback function, behave as they do on a call to server.listen(port[, hostname][, backlog][, callback]). Alternatively, the path option can be used to specify a UNIX socket.
server.listen(options[, callback])
The port, host, and backlog properties of options, as well as the optional callback function, behave as they do on a call to server.listen(port[, hostname][, backlog][, callback]).
The port, host, and backlog properties of options, as well as the optional callback function, behave as they do on a call to server.listen(port[, hostname][, backlog][, callback]). Alternatively, the path option can be used to specify a UNIX socket.
server.listen(options[, callback])
Returns the number of listeners listening to the event named eventName.
Returns the number of listeners listening to the event named eventName.
emitter.listenerCount(eventName)
Returns a copy of the array of listeners for the event named eventName.
Returns a copy of the array of listeners for the event named eventName.
emitter.listeners(eventName)
A Boolean indicating whether or not the server is listening for connections.
A Boolean indicating whether or not the server is listening for connections.
server.listening
Set this property to reject connections when the server's connection count gets high.
Set this property to reject connections when the server's connection count gets high. It is not recommended to use this option once a socket has been sent to a child with child_process.fork().
server.maxConnections
Limits maximum incoming headers count, equal to 1000 by default.
Limits maximum incoming headers count, equal to 1000 by default. If set to 0 - no limit will be applied.
server.maxHeadersCount
Adds the listener function to the end of the listeners array for the event named eventName.
Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
Returns a reference to the EventEmitter so calls can be chained.
emitter.on(eventName, listener)
Adds a one time listener function for the event named eventName.
Adds a one time listener function for the event named eventName. This listener is invoked only the next time eventName is triggered, after which it is removed.
emitter.once(eventName, listener)
Opposite of unref, calling ref on a previously unrefd server will not let the program exit if it's the only server left (the default behavior).
Opposite of unref, calling ref on a previously unrefd server will not let the program exit if it's the only server left (the default behavior). If the server is refd calling ref again will have no effect. Returns server.
server.ref()
Removes all listeners, or those of the specified eventName.
Removes all listeners, or those of the specified eventName.
Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter so calls can be chained.
emitter.removeAllListeners([eventName])
Removes all listeners, or those of the specified eventName.
Removes all listeners, or those of the specified eventName.
Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter so calls can be chained.
emitter.removeAllListeners([eventName])
Removes the specified listener from the listener array for the event named eventName.
Removes the specified listener from the listener array for the event named eventName. removeListener will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener must be called multiple times to remove each instance.
Note that once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events will behave as expected.
emitter.removeListener(eventName, listener)
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) for to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter so calls can be chained.
emitter.setMaxListeners(n)
Updates the keys for encryption/decryption of the TLS Session Tickets.
Updates the keys for encryption/decryption of the TLS Session Tickets.
The keys used for encryption/decryption of the TLS Session Tickets.
Sets the timeout value for sockets, and emits a 'timeout' event on the Server object, passing the socket as an argument, if a timeout occurs.
Sets the timeout value for sockets, and emits a 'timeout' event on the Server object, passing the socket as an argument, if a timeout occurs.
If there is a 'timeout' event listener on the Server object, then it will be called with the timed-out socket as an argument.
By default, the Server's timeout value is 2 minutes, and sockets are destroyed automatically if they time out. However, if you assign a callback to the Server's 'timeout' event, then you are responsible for handling socket timeouts.
the timeout in milliseconds
the callback
The number of milliseconds of inactivity before a socket is presumed to have timed out.
The number of milliseconds of inactivity before a socket is presumed to have timed out. Note that the socket timeout logic is set up on connection, so changing this value only affects new connections to the server, not any existing connections. Set to 0 to disable any kind of automatic timeout behavior on incoming connections. Default = 120000 (2 minutes)
server.timeout
Calling unref on a server will allow the program to exit if this is the only active server in the event system.
Calling unref on a server will allow the program to exit if this is the only active server in the event system. If the server is already unrefd calling unref again will have no effect. Returns server.
server.unref()
Returns the current number of concurrent connections on the server.
Returns the current number of concurrent connections on the server.
(Since version 0.9.7) Use server.getConnections() instead.
This class is a subclass of tls.Server and emits events same as http.Server. See http.Server for more information.