org.vertx.scala.core.net

NetSocket

final class NetSocket extends Self with ReadStream with WriteStream

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

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

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

Instances of this class are not thread-safe.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. NetSocket
  2. WriteStream
  3. ReadStream
  4. ReadSupport
  5. ExceptionSupport
  6. AsJava
  7. Self
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type J = java.core.net.NetSocket

    The internal type of the Java wrapped class.

    The internal type of the Java wrapped class.

    Definition Classes
    NetSocketWriteStreamReadStreamReadSupportExceptionSupport → AsJava

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. val asJava: java.core.net.NetSocket

    The internal instance of the Java wrapped class.

    The internal instance of the Java wrapped class.

    Definition Classes
    NetSocket → AsJava
  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def close(): Unit

    Close the NetSocket

  8. def closeHandler(handler: ⇒ Unit): NetSocket

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

  9. def dataHandler(handler: (Buffer) ⇒ Unit): NetSocket.this.type

    Set a data handler.

    Set a data handler. As data is read, the handler will be called with the data.

    Definition Classes
    ReadStreamReadSupport
  10. def drainHandler(handler: ⇒ Unit): NetSocket.this.type

    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 has been reduced to maxSize / 2. See org.vertx.scala.core.streams.Pump for an example of this being used.

    Definition Classes
    WriteStream
  11. def endHandler(handler: ⇒ Unit): NetSocket.this.type

    Set an end handler.

    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

    Definition Classes
    ReadStream
  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def exceptionHandler(handler: (Throwable) ⇒ Unit): NetSocket.this.type

    Set an exception handler.

    Set an exception handler.

    Definition Classes
    ExceptionSupport
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. def isSsl: Boolean

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

  20. def localAddress(): InetSocketAddress

    Return the local address for this socket

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. def pause(): NetSocket.this.type

    Pause the ReadSupport.

    Pause the ReadSupport. While it's paused, no data will be sent to the dataHandler

    Definition Classes
    ReadSupport
  25. def remoteAddress(): InetSocketAddress

    Return the remote address for this socket

  26. def resume(): NetSocket.this.type

    Resume reading.

    Resume reading. If the ReadSupport has been paused, reading will recommence on it.

    Definition Classes
    ReadSupport
  27. def sendFile(filename: String, handler: (AsyncResult[Void]) ⇒ Unit): NetSocket

    Same as NetSocket.sendFile() but also takes a handler that will be called when the send has completed or a failure has occurred

  28. def sendFile(filename: String): NetSocket

    Tell the kernel 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 kernel 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.

  29. def setWriteQueueMaxSize(maxSize: Int): NetSocket.this.type

    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 bytes in the write queue. This is used as an indicator by classes such as Pump to provide flow control.

    Definition Classes
    WriteStream
  30. def ssl(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.

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def toString(): String

    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def wrap[X](doStuff: ⇒ X): NetSocket.this.type

    Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types

    Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types

    Attributes
    protected[this]
    Definition Classes
    Self
  37. def write(data: String, enc: String): NetSocket

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

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

    returns

    A reference to this, so multiple method calls can be chained.

  38. def write(data: String): NetSocket

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

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

    returns

    A reference to this, so multiple method calls can be chained.

  39. def write(data: Buffer): NetSocket.this.type

    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 org.vertx.scala.core.streams.WriteStream.writeQueueFull() method before writing. This is done automatically if using a org.vertx.scala.core.streams.Pump.

    Definition Classes
    WriteStream
  40. 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.

  41. def writeQueueFull(): Boolean

    This will return true if there are more bytes in the write queue than the value set using org.vertx.scala.core.streams.WriteStream.setWriteQueueMaxSize()

    This will return true if there are more bytes in the write queue than the value set using org.vertx.scala.core.streams.WriteStream.setWriteQueueMaxSize()

    Definition Classes
    WriteStream

Inherited from WriteStream

Inherited from ReadStream

Inherited from ReadSupport[Buffer]

Inherited from ExceptionSupport

Inherited from AsJava

Inherited from Self

Inherited from AnyRef

Inherited from Any

Ungrouped