Packages

class Socket extends Object with IEventEmitter

The dgram.Socket object is an EventEmitter that encapsulates the datagram functionality.

New instances of dgram.Socket are created using dgram.createSocket(). The new keyword is not to be used to create dgram.Socket instances.

Annotations
@JSType() @native() @JSImport( "dgram" , "Socket" )
Linear Supertypes
IEventEmitter, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Socket
  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 Socket()
    Attributes
    protected

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): Socket.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 addMembership(multicastAddress: String): Unit
  6. def addMembership(multicastAddress: String, multicastInterface: String): Unit

    Tells the kernel to join a multicast group at the given multicastAddress and multicastInterface using the IP_ADD_MEMBERSHIP socket option.

    Tells the kernel to join a multicast group at the given multicastAddress and multicastInterface using the IP_ADD_MEMBERSHIP socket option. If the multicastInterface argument is not specified, the operating system will choose one interface and will add membership to it. To add membership to every available interface, call addMembership multiple times, once per interface.

    multicastAddress

    the multicast address

    multicastInterface

    the multicast interface

    Example:

    1. addMembership(multicastAddress[, multicastInterface])

  7. def addSourceSpecificMembership(sourceAddress: String, groupAddress: String): Unit
  8. def addSourceSpecificMembership(sourceAddress: String, groupAddress: String, multicastInterface: String): Unit
  9. def address(): Address

    Returns an object containing the address information for a socket.

    Returns an object containing the address information for a socket. For UDP sockets, this object will contain address, family and port properties.

    returns

    an object containing the address

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def bind(options: BindOptions): Unit
  12. def bind(options: BindOptions, callback: Function): Unit

    For UDP sockets, causes the dgram.Socket to listen for datagram messages on a named port and optional address.

    For UDP sockets, causes the dgram.Socket to listen for datagram messages on a named port and optional address. If port is not specified or is 0, the operating system will attempt to bind to a random port. If address is not specified, the operating system will attempt to listen on all addresses. Once binding is complete, a 'listening' event is emitted and the optional callback function is called.

    options

    the optional settings

    callback

    the callback

    Example:

    1. bind(options[, callback])

  13. def bind(address: String): Unit
  14. def bind(callback: Function0[Any]): Unit
  15. def bind(port: Int): Unit
  16. def bind(address: String, callback: Function0[Any]): Unit
  17. def bind(port: Int, callback: Function0[Any]): Unit
  18. def bind(port: Int, address: String): Unit
  19. def bind(port: Int, address: String, callback: Function0[Any]): Unit

    For UDP sockets, causes the dgram.Socket to listen for datagram messages on a named port and optional address.

    For UDP sockets, causes the dgram.Socket to listen for datagram messages on a named port and optional address. If port is not specified or is 0, the operating system will attempt to bind to a random port. If address is not specified, the operating system will attempt to listen on all addresses. Once binding is complete, a 'listening' event is emitted and the optional callback function is called.

    port

    the port

    address

    the address

    callback

    the callback

    Example:

    1. bind([port][, address][, callback])

  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  21. def close(): Unit
  22. def close(callback: Function): Unit
  23. def connect(port: Int): Unit
  24. def connect(port: Int, callback: Function0[Any]): Unit
  25. def connect(port: Int, address: String): Unit
  26. def connect(port: Int, address: String, callback: Function0[Any]): Unit
  27. def disconnect(): Unit
  28. val domain: Domain
    Definition Classes
    IEventEmitter
  29. def dropMembership(multicastAddress: String): Unit
  30. def dropMembership(multicastAddress: String, multicastInterface: String): Unit
  31. def dropSourceSpecificMembership(sourceAddress: String, groupAddress: String): Unit
  32. def dropSourceSpecificMembership(sourceAddress: String, groupAddress: String, multicastInterface: String): Unit
  33. 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][, ...])

  34. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  36. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. 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()

  39. def getRecvBufferSize(): Int
  40. def getSendBufferSize(): Int
  41. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  45. 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)

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

  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. def off(eventName: String, listner: Function): Socket.this.type
    Definition Classes
    IEventEmitter
  51. def on(eventName: String, listener: Function): Socket.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)

  52. def once(eventName: String, listener: Function): Socket.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)

  53. def prependListener(eventName: String, listener: Function): Socket.this.type
    Definition Classes
    IEventEmitter
  54. def prependOnceListener(eventName: String, listener: Function): Socket.this.type
    Definition Classes
    IEventEmitter
  55. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  56. def rawListeners(eventName: String): Array[Function]
    Definition Classes
    IEventEmitter
  57. def ref(): Socket.this.type
  58. def remoteAddress(): RemoteAddress
  59. def removeAllListeners(): Socket.this.type
    Definition Classes
    IEventEmitter
  60. def removeAllListeners(eventName: String): Socket.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])

  61. def removeListener(eventName: String, listener: Function): Socket.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)

  62. def send(msg: Message): Unit
  63. def send(msg: Message, address: String): Unit
  64. def send(msg: Message, port: Int): Unit
  65. def send(msg: Message, callback: Function): Unit
  66. def send(msg: Message, port: Int, address: String): Unit
  67. def send(msg: Message, port: Int, callback: Function): Unit
  68. def send(msg: Message, address: String, callback: Function): Unit
  69. def send(msg: Message, port: Int, address: String, callback: Function): Unit
  70. def send(msg: BufferMessage, offset: Int, length: Int): Unit
  71. def send(msg: BufferMessage, offset: Int, length: Int, callback: Function): Unit
  72. def send(msg: BufferMessage, offset: Int, length: Int, address: String): Unit
  73. def send(msg: BufferMessage, offset: Int, length: Int, port: Int): Unit
  74. def send(msg: BufferMessage, offset: Int, length: Int, address: String, callback: Function): Unit
  75. def send(msg: BufferMessage, offset: Int, length: Int, port: Int, callback: Function): Unit
  76. def send(msg: BufferMessage, offset: Int, length: Int, port: Int, address: String): Unit
  77. def send(msg: BufferMessage, offset: Int, length: Int, port: Int, address: String, callback: Function): Unit
  78. def setBroadcast(flag: Boolean): Unit

    Sets or clears the SO_BROADCAST socket option.

    Sets or clears the SO_BROADCAST socket option. When set to true, UDP packets may be sent to a local interface's broadcast address.

    flag

    the flag to set

  79. def setMaxListeners(n: Int): Socket.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)

  80. def setMulticastInterface(multicastInterface: String): Unit
  81. def setMulticastLoopback(flag: Boolean): Unit
  82. def setMulticastTTL(ttl: Int): Unit
  83. def setRecvBufferSize(size: Int): Unit
  84. def setSendBufferSize(size: Int): Unit
  85. def setTTL(ttl: Int): Unit
  86. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  87. def toLocaleString(): String
    Definition Classes
    Object
  88. def toString(): String
    Definition Classes
    AnyRef → Any
  89. def unref(): Socket.this.type
  90. def valueOf(): Any
    Definition Classes
    Object
  91. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  92. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  93. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped