vertx-lang-scala-docs_2.12 3.8.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package net
  Definition Classes
    core
- ClientOptionsBase
- JdkSSLEngineOptions
- JksOptions
- NetClient
- NetClientOptions
- NetServer
- NetServerOptions
- NetSocket
- NetworkOptions
- OpenSSLEngineOptions
- PemKeyCertOptions
- PemTrustOptions
- PfxOptions
- ProxyOptions
- SelfSignedCertificate
- SocketAddress
- TCPSSLOptions

c

io.vertx.scala.core.net

# NetSocket 

###
Companion object NetSocket

#### class NetSocket extends ReadStream[Buffer] with WriteStream[Buffer]

Represents a socket-like interface to a TCP connection on either the client or the server side.

Instances of this class are created on the client side by an io.vertx.scala.core.net.NetClient when a connection to a server is made, or on the server side by a io.vertx.scala.core.net.NetServer when a server accepts a connection.

It implements both and so it can be used with io.vertx.scala.core.streams.Pump to pump data with flow control.

Linear Supertypes
WriteStream[Buffer], ReadStream[Buffer], StreamBase, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. NetSocket
2. WriteStream
3. ReadStream
4. StreamBase
5. AnyRef
6. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new NetSocket(_asJava: AnyRef)

### 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.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: AnyRef
   Definition Classes
     NetSocket → WriteStream → ReadStream → StreamBase
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
7.  def close(handler: Handler[AsyncResult[Unit]]): Unit

   Close the NetSocket and notify the `handler` when the operation completes.

8.  def close(): Unit

   Close the NetSocket

9.  def closeFuture(): scala.concurrent.Future[Unit]

   Like close but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

10.  def closeHandler(handler: Handler[Unit]): NetSocket

    Set a handler that will be called when the NetSocket is closed * @param handler the handler

    Set a handler that will be called when the NetSocket is closed * @param handler the handler

    returns

      a reference to this, so the API can be used fluently

11.  def drainHandler(handler: Handler[Unit]): NetSocket

    Set a drain handler on the stream.

    Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See io.vertx.scala.core.streams.Pump for an example of this being used.

    The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to `maxSize / 2`. * @param handler the handler

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      NetSocket → WriteStream
12.  def end(handler: Handler[AsyncResult[Unit]]): Unit

    Calls io.vertx.scala.core.net.NetSocket#end

    Calls io.vertx.scala.core.net.NetSocket#end

    Definition Classes
      NetSocket → WriteStream
13.  def end(): Unit

    Calls io.vertx.scala.core.net.NetSocket#close

    Calls io.vertx.scala.core.net.NetSocket#close

    Definition Classes
      NetSocket → WriteStream
14.  def end(data: Buffer, handler: Handler[AsyncResult[Unit]]): Unit

    Same as but with an `handler` called when the operation completes

    Same as but with an `handler` called when the operation completes

    Definition Classes
      NetSocket → WriteStream
15.  def end(data: Buffer): Unit

    Same as io.vertx.scala.core.net.NetSocket#end but writes some data to the stream before ending.

    Same as io.vertx.scala.core.net.NetSocket#end but writes some data to the stream before ending. * @param data the data to write

    Definition Classes
      NetSocket → WriteStream
16.  def endFuture(): scala.concurrent.Future[Unit]

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      NetSocket → WriteStream
17.  def endFuture(data: Buffer): scala.concurrent.Future[Unit]

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like end but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      NetSocket → WriteStream
18.  def endHandler(endHandler: Handler[Unit]): NetSocket

    This handler might be called after the close handler when the socket is paused and there are still buffers to deliver.

    This handler might be called after the close handler when the socket is paused and there are still buffers to deliver.

    Definition Classes
      NetSocket → ReadStream
19.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
20.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
21.  def exceptionHandler(handler: Handler[Throwable]): NetSocket

    Set an exception handler on the write stream.

    Set an exception handler on the write stream. * @param handler the exception handler

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      NetSocket → WriteStream → ReadStream → StreamBase
22.  def fetch(amount: Long): NetSocket

    Fetch the specified `amount` of elements.

    Fetch the specified `amount` of elements. If the `ReadStream` has been paused, reading will recommence with the specified `amount` of items, otherwise the specified `amount` will be added to the current stream demand. * @return a reference to this, so the API can be used fluently

    Definition Classes
      NetSocket → ReadStream
23.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
24.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
25.  def handler(handler: Handler[Buffer]): NetSocket

    Set a data handler.

    Set a data handler. As data is read, the handler will be called with the data. * @return a reference to this, so the API can be used fluently

    Definition Classes
      NetSocket → ReadStream
26.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
27.  def indicatedServerName(): String

    Returns the SNI server name presented during the SSL handshake by the client.

    Returns the SNI server name presented during the SSL handshake by the client. * @return the indicated server name

28.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
29.  def isSsl(): Boolean

    returns

      true if this io.vertx.scala.core.net.NetSocket is encrypted via SSL/TLS.

30.  def localAddress(): SocketAddress

    returns

      the local address for this socket

31.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
32.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
33.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
34.  def pause(): NetSocket

    Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.

    Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.

    While it's paused, no data will be sent to the data `handler`. * @return a reference to this, so the API can be used fluently

    Definition Classes
      NetSocket → ReadStream
35.  def pipe(): Pipe[Buffer]

    Pause this stream and return a to transfer the elements of this stream to a destination .

    Pause this stream and return a to transfer the elements of this stream to a destination .

    The stream will be resumed when the pipe will be wired to a `WriteStream`. * @return a pipe

    Definition Classes
      NetSocket → ReadStream
36.  def pipeTo(dst: WriteStream[Buffer], handler: Handler[AsyncResult[Unit]]): Unit

    Pipe this `ReadStream` to the `WriteStream`.

    Pipe this `ReadStream` to the `WriteStream`.

    Elements emitted by this stream will be written to the write stream until this stream ends or fails.

    Once this stream has ended or failed, the write stream will be ended and the `handler` will be called with the result. * @param dst the destination write stream

    Definition Classes
      NetSocket → ReadStream
37.  def pipeTo(dst: WriteStream[Buffer]): Unit

    Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

    Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

    Definition Classes
      NetSocket → ReadStream
38.  def pipeToFuture(dst: WriteStream[Buffer]): scala.concurrent.Future[Unit]

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      NetSocket → ReadStream
39.  def remoteAddress(): SocketAddress

    returns

      the remote address for this socket

40.  def resume(): NetSocket

    Resume reading, and sets the buffer in `flowing` mode.

    Resume reading, and sets the buffer in `flowing` mode.

    If the `ReadStream` has been paused, reading will recommence on it. * @return a reference to this, so the API can be used fluently

    Definition Classes
      NetSocket → ReadStream
41.  def sendFile(filename: String, offset: Long, length: Long, resultHandler: Handler[AsyncResult[Unit]]): NetSocket

    Same as io.vertx.scala.core.net.NetSocket#sendFile but also takes a handler that will be called when the send has completed or a failure has occurred * @param filename file name of the file to send

    Same as io.vertx.scala.core.net.NetSocket#sendFile but also takes a handler that will be called when the send has completed or a failure has occurred * @param filename file name of the file to send

    offset

      offset

    length

      length

    resultHandler

      handler

    returns

      a reference to this, so the API can be used fluently

42.  def sendFile(filename: String, offset: Long, resultHandler: Handler[AsyncResult[Unit]]): NetSocket

    Same as io.vertx.scala.core.net.NetSocket#sendFile but also takes a handler that will be called when the send has completed or a failure has occurred * @param filename file name of the file to send

    Same as io.vertx.scala.core.net.NetSocket#sendFile but also takes a handler that will be called when the send has completed or a failure has occurred * @param filename file name of the file to send

    offset

      offset

    resultHandler

      handler

    returns

      a reference to this, so the API can be used fluently

43.  def sendFile(filename: String, resultHandler: Handler[AsyncResult[Unit]]): NetSocket

    Same as io.vertx.scala.core.net.NetSocket#sendFile but also takes a handler that will be called when the send has completed or a failure has occurred * @param filename file name of the file to send

    Same as io.vertx.scala.core.net.NetSocket#sendFile but also takes a handler that will be called when the send has completed or a failure has occurred * @param filename file name of the file to send

    resultHandler

      handler

    returns

      a reference to this, so the API can be used fluently

44.  def sendFile(filename: String, offset: Long, length: Long): NetSocket

    Tell the operating system to stream a file as specified by `filename` directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.

    Tell the operating system to stream a file as specified by `filename` directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files. * @param filename file name of the file to send

    offset

      offset

    length

      length

    returns

      a reference to this, so the API can be used fluently

45.  def sendFile(filename: String, offset: Long): NetSocket

    Tell the operating system to stream a file as specified by `filename` directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.

    Tell the operating system to stream a file as specified by `filename` directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files. * @param filename file name of the file to send

    offset

      offset

    returns

      a reference to this, so the API can be used fluently

46.  def sendFile(filename: String): NetSocket

    Tell the operating system to stream a file as specified by `filename` directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.

    Tell the operating system to stream a file as specified by `filename` directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files. * @param filename file name of the file to send

    returns

      a reference to this, so the API can be used fluently

47.  def sendFileFuture(filename: String, offset: Long, length: Long): scala.concurrent.Future[Unit]

    Like sendFile but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

48.  def sendFileFuture(filename: String, offset: Long): scala.concurrent.Future[Unit]

    Like sendFile but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

49.  def sendFileFuture(filename: String): scala.concurrent.Future[Unit]

    Like sendFile but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

50.  def setWriteQueueMaxSize(maxSize: Int): NetSocket

    Set the maximum size of the write queue to `maxSize`.

    Set the maximum size of the write queue to `maxSize`. You will still be able to write to the stream even if there is more than `maxSize` items in the write queue. This is used as an indicator by classes such as `Pump` to provide flow control.

    The value is defined by the implementation of the stream, e.g in bytes for a io.vertx.scala.core.net.NetSocket, the number of io.vertx.scala.core.eventbus.Message for a io.vertx.scala.core.eventbus.MessageProducer, etc... * @param maxSize the max size of the write stream

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      NetSocket → WriteStream
51.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
52.  def toString(): String
    Definition Classes
      AnyRef → Any
53.  def upgradeToSsl(serverName: String, handler: Handler[Unit]): NetSocket

    Upgrade channel to use SSL/TLS.

    Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured. * @param serverName the server name

    handler

      the handler will be notified when it's upgraded

    returns

      a reference to this, so the API can be used fluently

54.  def upgradeToSsl(handler: Handler[Unit]): NetSocket

    Upgrade channel to use SSL/TLS.

    Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured. * @param handler the handler will be notified when it's upgraded

    returns

      a reference to this, so the API can be used fluently

55.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
56.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
57.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
58.  def write(message: Buffer, handler: Handler[AsyncResult[Unit]]): NetSocket

    Like but with an `handler` called when the message has been written or failed to be written.

    Like but with an `handler` called when the message has been written or failed to be written.

    Definition Classes
      NetSocket → WriteStream
59.  def write(str: String, enc: String): NetSocket

    Write a String to the connection, encoded using the encoding `enc`.

    Write a String to the connection, encoded using the encoding `enc`. * @param str the string to write

    enc

      the encoding to use

    returns

      a reference to this, so the API can be used fluently

60.  def write(str: String, enc: String, handler: Handler[AsyncResult[Unit]]): NetSocket

    Same as io.vertx.scala.core.net.NetSocket#write but with an `handler` called when the operation completes

61.  def write(str: String): NetSocket

    Write a String to the connection, encoded in UTF-8.

    Write a String to the connection, encoded in UTF-8. * @param str the string to write

    returns

      a reference to this, so the API can be used fluently

62.  def write(str: String, handler: Handler[AsyncResult[Unit]]): NetSocket

    Same as io.vertx.scala.core.net.NetSocket#write but with an `handler` called when the operation completes

63.  def write(data: Buffer): NetSocket

    Write some data to the stream.

    Write some data to the stream. The data is put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the io.vertx.scala.core.streams.WriteStream#writeQueueFull method before writing. This is done automatically if using a io.vertx.scala.core.streams.Pump. * @param data the data to write

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      NetSocket → WriteStream
64.  def writeFuture(message: Buffer): scala.concurrent.Future[Unit]

    Like write but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like write but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      NetSocket → WriteStream
65.  def writeFuture(str: String, enc: String): scala.concurrent.Future[Unit]

    Like write but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

66.  def writeFuture(str: String): scala.concurrent.Future[Unit]

    Like write but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

67.  def writeHandlerID(): String

    When a `NetSocket` is created it automatically registers an event handler with the event bus, the ID of that handler is given by `writeHandlerID`.

    When a `NetSocket` is created it automatically registers an event handler with the event bus, the ID of that handler is given by `writeHandlerID`.

    Given this ID, a different event loop can send a buffer to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other connections which are owned by different event loops. * @return the write handler ID

68.  def writeQueueFull(): Boolean

    This will return `true` if there are more bytes in the write queue than the value set using io.vertx.scala.core.net.NetSocket#setWriteQueueMaxSize * @return true if write queue is full

    This will return `true` if there are more bytes in the write queue than the value set using io.vertx.scala.core.net.NetSocket#setWriteQueueMaxSize * @return true if write queue is full

    Definition Classes
      NetSocket → WriteStream

### Inherited from WriteStream[Buffer]

### Inherited from ReadStream[Buffer]

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped