Packages

class TLSSocket extends Socket

The tls.TLSSocket is a subclass of net.Socket that performs transparent encryption of written data and all required TLS negotiation.

Instances of tls.TLSSocket implement the duplex Stream interface.

Annotations
@JSType() @native() @JSImport("tls", "TLSSocket")
Linear Supertypes
Socket, HasHandle, Duplex, IDuplex, IWritable, IReadable, LegacyStream, IEventEmitter, Stream, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TLSSocket
  2. Socket
  3. HasHandle
  4. Duplex
  5. IDuplex
  6. IWritable
  7. IReadable
  8. LegacyStream
  9. IEventEmitter
  10. Stream
  11. Object
  12. Any
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TLSSocket(socket: IDuplex)
  2. new TLSSocket(socket: IDuplex, options: TLSSocketOptions)
  3. new TLSSocket()
    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 _handle: Any
    Definition Classes
    Socket → HasHandle
  5. def addListener(eventName: String, listener: Function): TLSSocket.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()

  6. def address(): Address

    Returns the bound address, the address family name and port of the socket as reported by the operating system.

    Returns the bound address, the address family name and port of the socket as reported by the operating system.

    returns

    an object with three properties, e.g. { port: 12346, family: 'IPv4', address: '127.0.0.1' }

    Definition Classes
    Socket
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def authorizationError: UndefOr[Boolean]
  9. def authorized: Boolean
  10. var bufferSize: Int

    net.Socket has the property that socket.write() always works.

    net.Socket has the property that socket.write() always works. This is to help users get up and running quickly. The computer cannot always keep up with the amount of data that is written to a socket - the network connection simply might be too slow. Node.js will internally queue up the data written to a socket and send it out over the wire when it is possible. (Internally it is polling on the socket's file descriptor for being writable).

    The consequence of this internal buffering is that memory may grow. This property shows the number of characters currently buffered to be written. (Number of characters is approximately equal to the number of bytes to be written, but the buffer may contain strings, and the strings are lazily encoded, so the exact number of bytes is not known.)

    Users who experience large or growing bufferSize should attempt to "throttle" the data flows in their program with pause() and resume().

    Definition Classes
    Socket
  11. def bytesRead: Int

    The amount of received bytes.

    The amount of received bytes.

    Definition Classes
    Socket
  12. def bytesWritten: Int

    The amount of bytes sent.

    The amount of bytes sent.

    Definition Classes
    Socket
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. def connect(path: String): Unit
    Definition Classes
    Socket
  15. def connect(path: String, connectListener: Function): Unit
    Definition Classes
    Socket
  16. def connect(port: Int): Unit
    Definition Classes
    Socket
  17. def connect(port: Int, host: String): Unit
    Definition Classes
    Socket
  18. def connect(port: Int, connectListener: Function): Unit
    Definition Classes
    Socket
  19. def connect(port: Int, host: String, connectListener: Function): Unit
    Definition Classes
    Socket
  20. def connect(options: net.ConnectOptions): Unit
    Definition Classes
    Socket
  21. def connect(options: net.ConnectOptions, connectListener: Function): Unit

    Opens the connection for a given socket.

    Opens the connection for a given socket. For TCP sockets, options argument should be an object which specifies:

    • port: Port the client should connect to (Required).
    • host: Host the client should connect to. Defaults to 'localhost'.
    • localAddress: Local interface to bind to for network connections.
    • localPort: Local port to bind to for network connections.
    • family : Version of IP stack. Defaults to 4.
    • hints: dns.lookup() hints. Defaults to 0.
    • lookup : Custom lookup function. Defaults to dns.lookup. <lu>

    For local domain sockets, options argument should be an object which specifies:

    path: Path the client should connect to (Required).

    Normally this method is not needed, as net.createConnection opens the socket. Use this only if you are implementing a custom Socket. This function is asynchronous. When the 'connect' event is emitted the socket is established. If there is a problem connecting, the 'connect' event will not be emitted, the 'error' event will be emitted with the exception. The connectListener parameter will be added as a listener for the 'connect' event.

    options

    the given socket options

    connectListener

    the optional connect listener

    Definition Classes
    Socket
    Examples:

    1. socket.connect(path[, connectListener])

      2. ,

    2. socket.connect(port[, host][, connectListener]) As socket.connect(options[, connectListener]), with options either as either {port: port, host: host} or {path: path}.

      3. ,

    3. socket.connect(options[, connectListener])

  22. def connecting: Boolean

    If true - socket.connect(options[, connectListener]) was called and haven't yet finished.

    If true - socket.connect(options[, connectListener]) was called and haven't yet finished. Will be set to false before emitting connect event and/or calling socket.connect(options[, connectListener])'s callback.

    Definition Classes
    Socket
  23. def cork(): Unit

    Forces buffering of all writes.

    Forces buffering of all writes. Buffered data will be flushed either at stream.uncork() or at stream.end() call.

    Definition Classes
    IWritable
    Example:

    1. writable.cork()

  24. def destroy(): Unit
    Definition Classes
    IWritable
  25. def destroy(error: Error): Unit
    Definition Classes
    IWritable
  26. def destroyed: Boolean
    Definition Classes
    IDuplex → IWritable → IReadable
  27. def disableRenegotiation(): Unit
  28. val domain: Domain
    Definition Classes
    IEventEmitter
  29. 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][, ...])

  30. def enableTrace(): Unit
  31. def encrypted: Boolean
  32. def end(): TLSSocket.this.type
    Definition Classes
    IWritable
  33. def end(callback: Function1[Error, Any]): TLSSocket.this.type
    Definition Classes
    IWritable
  34. def end(chunk: String, encoding: String): TLSSocket.this.type
    Definition Classes
    IWritable
  35. def end(chunk: String, encoding: String, callback: Function1[Error, Any]): TLSSocket.this.type
    Definition Classes
    IWritable
  36. def end(chunk: Uint8Array): TLSSocket.this.type
    Definition Classes
    IWritable
  37. def end(chunk: String): TLSSocket.this.type
    Definition Classes
    IWritable
  38. def end(chunk: Uint8Array, callback: Function1[Error, Any]): TLSSocket.this.type
    Definition Classes
    IWritable
  39. def end(chunk: String, callback: Function1[Error, Any]): TLSSocket.this.type
    Definition Classes
    IWritable
  40. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  42. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  43. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  44. def getCertificate(): TLSCertificate
  45. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  46. 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()

  47. def getPeerCertificate(detailed: String): TLSCertificate

    Returns an object representing the peer's certificate.

    Returns an object representing the peer's certificate. The returned object has some properties corresponding to the fields of the certificate.

    If the full certificate chain was requested, each certificate will include a issuerCertificate property containing an object representing its issuer's certificate.

    detailed

    Include the full certificate chain if true, otherwise include just the peer's certificate.

    returns

    the peer certificate

  48. def getPeerFinished(): UndefOr[Buffer]
  49. def getProtocol(): |[String, Null]

    Returns a string containing the negotiated SSL/TLS protocol version of the current connection.

    Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected client sockets.

    returns

    a string containing the negotiated SSL/TLS protocol version

  50. def getSession(): UndefOr[Buffer]

    Returns the ASN.1 encoded TLS session or undefined if no session was negotiated.

    Returns the ASN.1 encoded TLS session or undefined if no session was negotiated. Can be used to speed up handshake establishment when reconnecting to the server.

    returns

    the ASN.1 encoded TLS session

  51. def getSharedSigalgs(): Array[String]
  52. def getTLSTicket(): Buffer
  53. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  54. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. def isPaused(): Boolean

    This method returns whether or not the readable has been explicitly paused by client code (using stream.pause() without a corresponding stream.resume()).

    This method returns whether or not the readable has been explicitly paused by client code (using stream.pause() without a corresponding stream.resume()).

    Definition Classes
    IReadable
    Example:

    1. readable.isPaused()

  57. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  58. def isSessionReused(): Boolean
  59. 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)

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

  61. def localAddress: String

    The string representation of the local IP address the remote client is connecting on.

    The string representation of the local IP address the remote client is connecting on. For example, if you are listening on '0.0.0.0' and the client connects on '192.168.1.1', the value would be '192.168.1.1'.

    Definition Classes
    Socket
  62. def localPort: Int

    The numeric representation of the local port.

    The numeric representation of the local port. For example, 80 or 21.

    Definition Classes
    Socket
  63. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  64. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  65. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  66. def off(eventName: String, listner: Function): TLSSocket.this.type
    Definition Classes
    IEventEmitter
  67. def on(eventName: String, listener: Function): TLSSocket.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)

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

  69. def pause(): TLSSocket.this.type

    This method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode.

    This method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

    Definition Classes
    IReadable
    Example:

    1. readable.pause()

  70. def pending: Boolean
    Definition Classes
    Socket
  71. def pipe(destination: IWritable): TLSSocket.this.type
    Definition Classes
    IReadable
  72. def pipe(destination: IWritable, options: ReadablePipeOptions): TLSSocket.this.type

    This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.

    This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream. Multiple destinations can be piped to safely.

    Definition Classes
    IReadable
    Example:

    1. readable.pipe(destination[, options])

  73. def prependListener(eventName: String, listener: Function): TLSSocket.this.type
    Definition Classes
    IEventEmitter
  74. def prependOnceListener(eventName: String, listener: Function): TLSSocket.this.type
    Definition Classes
    IEventEmitter
  75. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  76. def push(chunk: Uint8Array): Boolean

    When chunk is a Buffer or string, the chunk of data will be added to the internal queue for users of the stream to consume.

    When chunk is a Buffer or string, the chunk of data will be added to the internal queue for users of the stream to consume. Passing chunk as null signals the end of the stream (EOF), after which no more data can be written.

    When the Readable is operating in paused mode, the data added with readable.push() can be read out by calling the readable.read() method when the 'readable' event is emitted.

    When the Readable is operating in flowing mode, the data added with readable.push() will be delivered by emitting a 'data' event.

    chunk

    the chunk of data to push into the read queue

    returns

    true if additional chunks of data may continued to be pushed; false otherwise.

    Definition Classes
    IReadable
  77. def push(chunk: String): Boolean
    Definition Classes
    IReadable
  78. def push(chunk: String, encoding: String): Boolean

    When chunk is a Buffer or string, the chunk of data will be added to the internal queue for users of the stream to consume.

    When chunk is a Buffer or string, the chunk of data will be added to the internal queue for users of the stream to consume. Passing chunk as null signals the end of the stream (EOF), after which no more data can be written.

    When the Readable is operating in paused mode, the data added with readable.push() can be read out by calling the readable.read() method when the 'readable' event is emitted.

    When the Readable is operating in flowing mode, the data added with readable.push() will be delivered by emitting a 'data' event.

    chunk

    the chunk of data to push into the read queue

    encoding

    the encoding of String chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'

    returns

    true if additional chunks of data may continued to be pushed; false otherwise.

    Definition Classes
    IReadable
  79. def rawListeners(eventName: String): Array[Function]
    Definition Classes
    IEventEmitter
  80. def readAsBuffer(): Buffer
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  81. def readAsBuffer(size: Int): Buffer
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  82. def readAsObject(): Any
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  83. def readAsObject(size: Int): Any
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  84. def readAsString(): String
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  85. def readAsString(size: Int): String
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  86. def readable: Boolean
    Definition Classes
    IReadable
  87. def readableEncoding: String
    Definition Classes
    IReadable
  88. def readableEnded: Boolean
    Definition Classes
    IReadable
  89. def readableFlowing: |[Boolean, Null]
    Definition Classes
    IReadable
  90. def readableHighWaterMark: Double
    Definition Classes
    IReadable
  91. def readableLength: Int
    Definition Classes
    IReadable
  92. def readableObjectMode: Boolean
    Definition Classes
    IReadable
  93. def ref(): TLSSocket.this.type

    Opposite of unref, calling ref on a previously unrefd socket will not let the program exit if it's the only socket left (the default behavior).

    Opposite of unref, calling ref on a previously unrefd socket will not let the program exit if it's the only socket left (the default behavior). If the socket is refd calling ref again will have no effect.

    returns

    socket

    Definition Classes
    Socket
  94. def remoteAddress: UndefOr[String]

    The string representation of the remote IP address.

    The string representation of the remote IP address. For example, '74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if the socket is destroyed (for example, if the client disconnected).

    Definition Classes
    Socket
  95. def remoteFamily: String

    The string representation of the remote IP family.

    The string representation of the remote IP family. 'IPv4' or 'IPv6'.

    Definition Classes
    Socket
  96. def remotePort: Int

    The numeric representation of the remote port.

    The numeric representation of the remote port. For example, 80 or 21.

    Definition Classes
    Socket
  97. def removeAllListeners(): TLSSocket.this.type
    Definition Classes
    IEventEmitter
  98. def removeAllListeners(eventName: String): TLSSocket.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])

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

  100. def renegotiate(options: RenegotiateOptions, callback: Function1[Error, Any]): Boolean
  101. def resume(): TLSSocket.this.type

    This method will cause the readable stream to resume emitting 'data' events.

    This method will cause the readable stream to resume emitting 'data' events. This method will switch the stream into flowing mode. If you do not want to consume the data from a stream, but you do want to get to its 'end' event, you can call stream.resume() to open the flow of data.

    Definition Classes
    IReadable
    Example:

    1. readable.resume()

  102. def setDefaultEncoding(encoding: String): TLSSocket.this.type

    Sets the default encoding for a writable stream.

    Sets the default encoding for a writable stream.

    Definition Classes
    IWritable
    Example:

    1. writable.setDefaultEncoding(encoding)

  103. def setEncoding(encoding: String): TLSSocket.this.type

    Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects.

    Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects. For example, if you do readable.setEncoding('utf8'), then the output data will be interpreted as UTF-8 data, and returned as strings. If you do readable.setEncoding('hex'), then the data will be encoded in hexadecimal string format.

    This properly handles multi-byte characters that would otherwise be potentially mangled if you simply pulled the Buffers directly and called buf.toString(encoding) on them. If you want to read the data as strings, always use this method.

    Also you can disable any encoding at all with readable.setEncoding(null). This approach is very useful if you deal with binary data or with large multi-byte strings spread out over multiple chunks.

    Definition Classes
    IReadable
    Example:

    1. readable.setEncoding(encoding)

  104. def setKeepAlive(): TLSSocket.this.type
    Definition Classes
    Socket
  105. def setKeepAlive(initialDelay: Int): TLSSocket.this.type
    Definition Classes
    Socket
  106. def setKeepAlive(enable: Boolean): TLSSocket.this.type
    Definition Classes
    Socket
  107. def setKeepAlive(enable: Boolean, initialDelay: Int): TLSSocket.this.type

    Enable/disable keep-alive functionality, and optionally set the initial delay before the first keepalive probe is sent on an idle socket.

    Enable/disable keep-alive functionality, and optionally set the initial delay before the first keepalive probe is sent on an idle socket. enable defaults to false.

    Set initialDelay (in milliseconds) to set the delay between the last data packet received and the first keepalive probe. Setting 0 for initialDelay will leave the value unchanged from the default (or previous) setting. Defaults to 0.

    returns

    socket

    Definition Classes
    Socket
    Example:

    1. socket.setKeepAlive([enable][, initialDelay])

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

  109. def setMaxSendFragment(size: Int): Boolean
  110. def setNoDelay(): TLSSocket.this.type
    Definition Classes
    Socket
  111. def setNoDelay(noDelay: Boolean): TLSSocket.this.type

    Disables the Nagle algorithm.

    Disables the Nagle algorithm. By default TCP connections use the Nagle algorithm, they buffer data before sending it off. Setting true for noDelay will immediately fire off data each time socket.write() is called. noDelay defaults to true.

    returns

    socket

    Definition Classes
    Socket
    Example:

    1. socket.setNoDelay([noDelay])

  112. def setTimeout(timeout: Int): TLSSocket.this.type
    Definition Classes
    Socket
  113. def setTimeout(timeout: Int, callback: Function): TLSSocket.this.type

    Sets the socket to timeout after timeout milliseconds of inactivity on the socket.

    Sets the socket to timeout after timeout milliseconds of inactivity on the socket. By default net.Socket do not have a timeout. When an idle timeout is triggered the socket will receive a 'timeout' event but the connection will not be severed. The user must manually end() or destroy() the socket. If timeout is 0, then the existing idle timeout is disabled. The optional callback parameter will be added as a one time listener for the 'timeout' event.

    returns

    socket.

    Definition Classes
    Socket
    Example:

    1. socket.setTimeout(timeout[, callback])

  114. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  115. def toLocaleString(): String
    Definition Classes
    Object
  116. def toString(): String
    Definition Classes
    AnyRef → Any
  117. def uncork(): Unit

    Flush all data, buffered since stream.cork() call.

    Flush all data, buffered since stream.cork() call.

    Definition Classes
    IWritable
    Example:

    1. writable.uncork()

  118. def unpipe(): Unit
    Definition Classes
    IReadable
  119. def unpipe(destination: IWritable): Unit

    This method will remove the hooks set up for a previous stream.pipe() call.

    This method will remove the hooks set up for a previous stream.pipe() call.

    If the destination is not specified, then all pipes are removed.

    If the destination is specified, but no pipe is set up for it, then this is a no-op.

    Definition Classes
    IReadable
    Example:

    1. readable.unpipe([destination])

  120. def unref(): TLSSocket.this.type

    Calling unref on a socket will allow the program to exit if this is the only active socket in the event system.

    Calling unref on a socket will allow the program to exit if this is the only active socket in the event system. If the socket is already unrefd calling unref again will have no effect.

    returns

    socket.

    Definition Classes
    Socket
  121. def unshift(chunk: Uint8Array): Unit
    Definition Classes
    IReadable
  122. def unshift(chunk: String): Unit

    This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.

    This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.

    Note that stream.unshift(chunk) cannot be called after the 'end' event has been triggered; a runtime error will be raised.

    If you find that you must often call stream.unshift(chunk) in your programs, consider implementing a Transform stream instead.

    Definition Classes
    IReadable
    Example:

    1. readable.unshift(chunk)

  123. def valueOf(): Any
    Definition Classes
    Object
  124. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  125. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  126. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  127. def wrap(stream: LegacyStream): Unit

    Versions of Node.js prior to v0.10 had streams that did not implement the entire Streams API as it is today.

    Versions of Node.js prior to v0.10 had streams that did not implement the entire Streams API as it is today. (See Compatibility for more information.)

    If you are using an older Node.js library that emits 'data' events and has a stream.pause() method that is advisory only, then you can use the wrap() method to create a Readable stream that uses the old stream as its data source.

    You will very rarely ever need to call this function, but it exists as a convenience for interacting with old Node.js programs and libraries.

    Definition Classes
    IReadable
    Example:

    1. readable.wrap(stream)

  128. def writable: Boolean
    Definition Classes
    IWritable
  129. def writableCorked: Int
    Definition Classes
    IWritable
  130. def writableEnded: Boolean
    Definition Classes
    IWritable
  131. def writableFinished: Boolean
    Definition Classes
    IWritable
  132. def writableHighWaterMark: Double
    Definition Classes
    IWritable
  133. def writableLength: Int
    Definition Classes
    IWritable
  134. def writableObjectMode: Boolean
    Definition Classes
    IWritable
  135. def write(chunk: String, encoding: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  136. def write(chunk: String, encoding: String): Boolean
    Definition Classes
    IWritable
  137. def write(chunk: String): Boolean
    Definition Classes
    IWritable
  138. def write(chunk: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  139. def write(chunk: Uint8Array): Boolean
    Definition Classes
    IWritable
  140. def write(chunk: Uint8Array, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable

Inherited from Socket

Inherited from HasHandle

Inherited from Duplex

Inherited from IDuplex

Inherited from IWritable

Inherited from IReadable

Inherited from LegacyStream

Inherited from IEventEmitter

Inherited from Stream

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped