Packages

class Server extends Object with IEventEmitter

net.Server - This class is used to create a TCP or local server.

Annotations
@RawJSType() @native() @JSImport( "net" , "Server" )
See also

https://nodejs.org/api/net.html#net_class_net_server

Linear Supertypes
IEventEmitter, Object, Any, AnyRef, Any
Known Subclasses
Server, Http2SecureServer, Http2Server, Server, Server
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Server
  2. IEventEmitter
  3. Object
  4. Any
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Server(connectionListener: Function)
  2. new Server(options: ServerOptions, connectionListener: Function)
  3. new Server(options: ServerOptions = js.native)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addListener(eventName: String, listener: Function): Server.this.type

    Alias for emitter.on(eventName, listener).

    Alias for emitter.on(eventName, listener).

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.addListener(eventName, listener)

    See also

    on()

  5. def address(): |[Address, String]

    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' }

    Example:

    1. server.address()

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def close(callback: Function1[SystemError, Any] = js.native): Unit

    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.

    Example:

    1. server.close([callback])

  9. val domain: String
    Definition Classes
    IEventEmitter
  10. def emit(name: String, args: Any*): Boolean

    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.

    name

    the event name

    args

    the event arguments

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.emit(name[, arg1][, arg2][, ...])

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getConnections(callback: Function2[SystemError, Int, Any]): Unit

    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.

    Example:

    1. server.getConnections(callback)

  17. def getMaxListeners(): Int

    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.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.getMaxListeners()

    See also

    setMaxListeners()

  18. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  22. def listen(): Unit
  23. def listen(callback: Function): Unit
  24. def listen(port: Int): Unit
  25. def listen(port: Int, callback: Function): Unit
  26. def listen(port: Int, hostname: String): Unit
  27. def listen(port: Int, hostname: String, callback: Function): Unit
  28. def listen(port: Int, hostname: String, backlog: Int): Unit
  29. def listen(port: Int, hostname: String, backlog: Int, callback: Function): Unit
  30. def listen(handle: Handle): Unit
  31. def listen(handle: Handle, backlog: Int): Unit
  32. def listen(handle: Handle, callback: Function): Unit
  33. def listen(handle: Handle, backlog: Int, callback: Function): Unit
  34. def listen(options: ListenerOptions): Unit
  35. def listen(options: ListenerOptions, callback: Function): Unit

    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.

    Example:

    1. server.listen(options[, callback])

  36. def listenerCount(eventName: String): Int

    Returns the number of listeners listening to the event named eventName.

    Returns the number of listeners listening to the event named eventName.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.listenerCount(eventName)

  37. def listeners(eventName: String): Array[Function]

    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.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.listeners(eventName)

  38. def listening: Boolean

    A Boolean indicating whether or not the server is listening for connections.

    A Boolean indicating whether or not the server is listening for connections.

    Example:

    1. server.listening

  39. var maxConnections: UndefOr[Int]

    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().

    Example:

    1. server.maxConnections

  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. def on(eventName: String, listener: Function): Server.this.type

    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.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.on(eventName, listener)

  44. def once(eventName: String, listener: Function): Server.this.type

    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.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.once(eventName, listener)

  45. def prependListener(eventName: String, listener: Function): Server.this.type
    Definition Classes
    IEventEmitter
  46. def prependOnceListener(eventName: String, listener: Function): Server.this.type
    Definition Classes
    IEventEmitter
  47. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  48. def ref(): Server.this.type

    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.

    Example:

    1. server.ref()

  49. def removeAllListeners(eventName: String = js.native): Server.this.type

    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.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.removeAllListeners([eventName])

  50. def removeListener(eventName: String, listener: Function): Server.this.type

    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.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.removeListener(eventName, listener)

  51. def setMaxListeners(n: Int): Server.this.type

    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.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.setMaxListeners(n)

  52. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  53. def toLocaleString(): String
    Definition Classes
    Object
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. def unref(): Server.this.type

    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.

    Example:

    1. server.unref()

  56. val usingDomains: Boolean
    Definition Classes
    IEventEmitter
  57. def valueOf(): Any
    Definition Classes
    Object
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Deprecated Value Members

  1. def connections: Int

    Returns the current number of concurrent connections on the server.

    Returns the current number of concurrent connections on the server.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.7) Use server.getConnections() instead.

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped