cc.otavia.core.channel

Abstract class of file channel and network channel.

Attributes

Companion: object
Supertypes: trait QueueMapEntity

trait ChannelState

trait CompressionBooleanLong

trait Channel

trait ChannelAddress

class Object

trait Matchable

class Any
Show all
Known subtypes: class AbstractFileChannel

class NioFileChannel

class AbstractNetworkChannel

class AbstractDatagramChannel

class NioDatagramChannel

class AbstractServerChannel

class NioServerSocketChannel

class AbstractSocketChannel

class NioSocketChannel
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: AbstractChannel.type

Attributes

Supertypes: class AbstractNetworkChannel

class AbstractChannel

trait QueueMapEntity

trait ChannelState

trait CompressionBooleanLong

trait Channel

trait ChannelAddress

class Object

trait Matchable

class Any
Show all
Known subtypes: class NioDatagramChannel

Abstract channel for file, support aio.

Attributes

Supertypes: class AbstractChannel

trait QueueMapEntity

trait ChannelState

trait CompressionBooleanLong

trait Channel

trait ChannelAddress

class Object

trait Matchable

class Any
Show all
Known subtypes: class NioFileChannel

Attributes

Companion: object
Supertypes: class AbstractChannel

trait QueueMapEntity

trait ChannelState

trait CompressionBooleanLong

trait Channel

trait ChannelAddress

class Object

trait Matchable

class Any
Show all
Known subtypes: class AbstractDatagramChannel

class NioDatagramChannel

class AbstractServerChannel

class NioServerSocketChannel

class AbstractSocketChannel

class NioSocketChannel
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: AbstractNetworkChannel.type

Attributes

Supertypes: class AbstractNetworkChannel

class AbstractChannel

trait QueueMapEntity

trait ChannelState

trait CompressionBooleanLong

trait Channel

trait ChannelAddress

class Object

trait Matchable

class Any
Show all
Known subtypes: class NioServerSocketChannel

Attributes

Supertypes: class AbstractNetworkChannel

class AbstractChannel

trait QueueMapEntity

trait ChannelState

trait CompressionBooleanLong

trait Channel

trait ChannelAddress

class Object

trait Matchable

class Any
Show all
Known subtypes: class NioSocketChannel

The AbstractChannel in Reactor

Attributes

Supertypes: trait ChannelState

trait CompressionBooleanLong

trait UnsafeChannel

class Object

trait Matchable

class Any
Show all
Known subtypes: class AbstractNioUnsafeChannel[C]

class NioUnsafeDatagramChannel

class NioUnsafeServerSocketChannel

class NioUnsafeSocketChannel

class NioUnsafeFileChannel

Attributes

Companion: object
Supertypes: trait ChannelAddress

class Object

trait Matchable

class Any
Known subtypes: trait DatagramChannel

class AbstractChannel

class AbstractFileChannel

class NioFileChannel

class AbstractNetworkChannel

class AbstractDatagramChannel

class NioDatagramChannel

class AbstractServerChannel

class NioServerSocketChannel

class AbstractSocketChannel

class NioSocketChannel

trait ServerChannel
Show all

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: Channel.type

An interface for Channel used in Actor

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait Channel

trait DatagramChannel

class AbstractChannel

class AbstractFileChannel

class NioFileChannel

class AbstractNetworkChannel

class AbstractDatagramChannel

class NioDatagramChannel

class AbstractServerChannel

class NioServerSocketChannel

class AbstractSocketChannel

class NioSocketChannel

trait ServerChannel
Show all
Self type: Channel

A RuntimeException which is thrown when an I/O operation fails.

Attributes

Supertypes: class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all
Known subtypes: class ChannelPipelineException

Attributes

Supertypes: class Object

trait Matchable

class Any

Handles an I/O event or intercepts an I/O operation, and forwards it to its next handler in its ChannelPipeline. ===The context object=== A ChannelHandler is provided with a ChannelHandlerContext object. A ChannelHandler is supposed to interact with the ChannelPipeline it belongs to via a context object. Using the context object, the ChannelHandler can pass events upstream or downstream, modify the pipeline dynamically, or store the information (using AttributeKeys) which is specific to the handler. ===State management=== A ChannelHandler often needs to store some stateful information. The simplest and recommended approach is to use member variables:

  trait Msg {
     // your methods here
  }

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait Byte2ByteDecoder

trait Byte2ByteCodec

class ByteToByteCodec

class SslHandler

class ByteToByteDecoder

class Base64Decoder

trait Byte2ByteEncoder

class ByteToByteEncoder

class Base64Encoder

trait Byte2MessageDecoder

class ByteToMessageCodec

class ByteToMessageDecoder

class ByteArrayDecoder

class StringDecoder

class FixedLengthFrameDecoder

trait Message2ByteEncoder

class MessageToByteEncoder

class ByteArrayEncoder

class LineEncoder

class StringEncoder

trait Message2MessageDecoder

trait Message2MessageCodec

trait Message2MessageEncoder

class ChannelHandlerAdapter

class CombinedChannelDuplexHandler[I, O]

class ChannelInitializer[C]

class IdleStateHandler
Show all

Attributes

Supertypes: trait ChannelHandler

class Object

trait Matchable

class Any
Known subtypes: class CombinedChannelDuplexHandler[I, O]

class ByteToByteCodec

class SslHandler

class ByteToByteDecoder

class Base64Decoder

class ByteToByteEncoder

class Base64Encoder

class ByteToMessageCodec

class ByteToMessageDecoder

class ByteArrayDecoder

class StringDecoder

class FixedLengthFrameDecoder

class MessageToByteEncoder

class ByteArrayEncoder

class LineEncoder

class StringEncoder
Show all

Attributes

Supertypes: trait ChannelInboundInvoker

trait ChannelOutboundInvoker

class Object

trait Matchable

class Any
Known subtypes: class DelegatingChannelHandlerContext

class CombinedChannelHandlerContext

class ChannelHandlerContextImpl

Attributes

Companion: object
Supertypes: trait ChannelHandlerContext

trait ChannelInboundInvoker

trait ChannelOutboundInvoker

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: ChannelHandlerContextImpl.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait ChannelHandlerContext

class DelegatingChannelHandlerContext

class CombinedChannelHandlerContext

class ChannelHandlerContextImpl

trait ChannelPipeline

class ChannelPipelineImpl
Show all

Attributes

Supertypes: class Object

trait Matchable

class Any
Self type: ChannelInflight.type

A special ChannelHandler which offers an easy way to initialize a Channel once it was registered to its ChannelsActor. Implementations are most often used in the context of ChannelsActor.handler, to setup the ChannelPipeline of a Channel.

    class MyChannelInitializer extends ChannelInitializer[Channel] {
        override protected def initChannel(ch: Channel): Unit = {
            ch.pipeline.addLast("myHandler", new MyHandler())
        }
    }

Be aware that this class is marked as isSharable and so the implementation must be safe to be re-used

Type parameters

C: A sub-type of Channel

Attributes

Supertypes: trait ChannelHandler

class Object

trait Matchable

class Any

Attributes

Companion: object
Supertypes: class Object

trait Matchable

class Any
Known subtypes: class NioChannelOption[T]

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: ChannelOption.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait ChannelHandlerContext

class DelegatingChannelHandlerContext

class CombinedChannelHandlerContext

class ChannelHandlerContextImpl

trait ChannelPipeline

class ChannelPipelineImpl
Show all

Used to fail pending writes when a channel's output has been shutdown.

Attributes

Supertypes: class IOException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait ChannelOutboundInvoker

trait ChannelInboundInvoker

class Object

trait Matchable

class Any
Known subtypes: class ChannelPipelineImpl

A ChannelException which is thrown when a ChannelPipeline failed to execute an operation.

Attributes

Supertypes: class ChannelException

class RuntimeException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Supertypes: trait ChannelPipeline

trait ChannelOutboundInvoker

trait ChannelInboundInvoker

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: ChannelPipelineImpl.type

The direction of a shutdown. Depending on the direction this has different meaning. If the Inbound direction is shutdown, no more data is read from the transport and dispatched. If the Outbound direction is shutdown, no more writes will be possible to the transport and so all writes will fail.

Attributes

Supertypes: trait Enum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

A trait for manage lifecycle for Channel

Attributes

Companion: object
Supertypes: trait CompressionBooleanLong

class Object

trait Matchable

class Any
Known subtypes: class AbstractChannel

class AbstractFileChannel

class NioFileChannel

class AbstractNetworkChannel

class AbstractDatagramChannel

class NioDatagramChannel

class AbstractServerChannel

class NioServerSocketChannel

class AbstractSocketChannel

class NioSocketChannel

class AbstractUnsafeChannel

class AbstractNioUnsafeChannel[C]

class NioUnsafeDatagramChannel

class NioUnsafeServerSocketChannel

class NioUnsafeSocketChannel

class NioUnsafeFileChannel
Show all

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: ChannelState.type

Combines the inbound handling of one ChannelHandler with the outbound handling of another ChannelHandler.

Attributes

Companion: object
Supertypes: class ChannelHandlerAdapter

trait ChannelHandler

class Object

trait Matchable

class Any

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: CombinedChannelDuplexHandler.type

Attributes

Supertypes: class ConnectException

class SocketException

class IOException

class Exception

class Throwable

trait Serializable

class Object

trait Matchable

class Any
Show all

Default FileRegion implementation which transfer data from a FileChannel or File. Be aware that the FileChannel will be automatically closed once FileRegion.refCnt returns 0.

Value parameters

count: the number of bytes to transfer
position: the position from which the transfer should start

Attributes

Supertypes: trait FileRegion

class AbstractReferenceCounted

trait ReferenceCounted

class Object

trait Matchable

class Any
Show all

A region of a file that is sent via a Channel which supports zero-copy file transfer.

=== Upgrade your JDK / JRE ===

java.nio.channels.FileChannel.transferTo has at least four known bugs in the old versions of Sun JDK and perhaps its derived ones. Please upgrade your JDK to 1.6.0_18 or later version if you are going to use zero-copy file transfer.

5103988
- FileChannel.transferTo() should return -1 for EAGAIN instead throws IOException
6253145
- FileChannel.transferTo() on Linux fails when going beyond 2GB boundary
6427312
- FileChannel.transferTo() throws IOException "system call interrupted"
6470086
- FileChannel.transferTo(2147483647, 1, channel) causes "Value too large" exception

=== Check your operating system and JDK / JRE ===

If your operating system (or JDK / JRE) does not support zero-copy file transfer, sending a file with FileRegion might fail or yield worse performance. For example, sending a large file doesn't work well in Windows.

=== Not all transports support it ===

Attributes

Supertypes: trait ReferenceCounted

class Object

trait Matchable

class Any
Known subtypes: class DefaultFileRegion

A Channel that accepts an incoming connection attempts and creates its child Channels by accepting them. A ServerChannel does not allow the following operations and so will throws Exception of these operations:

connect(SocketAddress)
disconnect()
write(Object)
flush()
shutdown(ChannelShutdownDirection)

Attributes

Supertypes: trait Channel

trait ChannelAddress

class Object

trait Matchable

class Any

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class AbstractUnsafeChannel

class AbstractNioUnsafeChannel[C]

class NioUnsafeDatagramChannel

class NioUnsafeServerSocketChannel

class NioUnsafeSocketChannel

class NioUnsafeFileChannel

trait NioUnsafeChannel
Show all

cc.otavia.core.channel

Members list

Packages

Type members

Classlikes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Type parameters

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes