TaskSocketChannel

A Task based asynchronous channel for reading, writing, and manipulating a TCP socket.

On the JVM this is a wrapper around java.nio.channels.AsynchronousSocketChannel (class available since Java 7 for doing async I/O on sockets).

Example:

val taskSocketChannel = TaskSocketChannel()
val writeT =
  for {
    _ <- taskSocketChannel.connect(new InetSocketAddress("google.com", 80))
    written <- taskSocketChannel.write(ByteBuffer.wrap("Hello world!".getBytes("UTF-8")), None)
  } yield {
    written
  }
writeT.runAsync(new Callback[Int] {
  override def onSuccess(value: Int): Unit = println(f"Bytes written: $value%d")
  override def onError(ex: Throwable): Unit = println(s"ERR: $ex")
})

Linear Supertypes

AnyRef, Any

Instance Constructors

new TaskSocketChannel()

Abstract Value Members

abstract val asyncSocketChannel: AsyncSocketChannel

The underlying AsyncSocketChannel
The underlying AsyncSocketChannel

Attributes
protected

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Closes this channel
def connect(remote: InetSocketAddress): Task[Unit]

Connects this channel.
Connects this channel.
remote
the remote address to which this channel is to be connected
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def localAddress(): Task[Option[InetSocketAddress]]

Asks the socket address that this channel's socket is bound to
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def read(dst: ByteBuffer, timeout: Option[Duration] = None): Task[Int]

Reads a sequence of bytes from this channel into the given buffer
Reads a sequence of bytes from this channel into the given buffer
dst
is the buffer holding the bytes read on completion
timeout
an optional maximum time for the I/O operation to complete
returns
the number of bytes read or -1 if no bytes could be read because the channel has reached end-of-stream
def remoteAddress(): Task[Option[InetSocketAddress]]

Asks the remote address to which this channel's socket is connected
def stopReading(): Task[Unit]

Indicates that this channel will not read more data
Indicates that this channel will not read more data
- end-of-stream indication
def stopWriting(): Task[Unit]

Indicates that this channel will not write more data
Indicates that this channel will not write more data
- end-of-stream indication
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def write(src: ByteBuffer, timeout: Option[Duration] = None): Task[Int]

Writes a sequence of bytes to this channel from the given buffer
Writes a sequence of bytes to this channel from the given buffer
src
is the buffer holding the sequence of bytes to write
timeout
an optional maximum time for the I/O operation to complete
returns
the number of bytes that were written

Related Docs: object TaskSocketChannel | package tcp

abstract class TaskSocketChannel extends AnyRef

Instance Constructors

new TaskSocketChannel()

Abstract Value Members

abstract val asyncSocketChannel: AsyncSocketChannel

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): Task[Unit]

def connect(remote: InetSocketAddress): Task[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def localAddress(): Task[Option[InetSocketAddress]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def read(dst: ByteBuffer, timeout: Option[Duration] = None): Task[Int]

def remoteAddress(): Task[Option[InetSocketAddress]]

def stopReading(): Task[Unit]

def stopWriting(): Task[Unit]

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def write(src: ByteBuffer, timeout: Option[Duration] = None): Task[Int]

Inherited from AnyRef

Inherited from Any

Ungrouped