Class/Object

io.backchat.hookup

FileBuffer

Related Docs: object FileBuffer | package hookup

Permalink

class FileBuffer extends BackupBuffer

The default file buffer. This is a file buffer that also has a memory buffer to which it writes when the file stream is being read out or if a write to the file failed.

This class has no maximum size or any limits attached to it yet. So it is possible for this class to exhaust the memory and/or disk space of the machine using this buffer.

Linear Supertypes
BackupBuffer, Closeable, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FileBuffer
  2. BackupBuffer
  3. Closeable
  4. AutoCloseable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileBuffer(file: File)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink

    Closes the buffer and releases any external resources contained by this buffer.

    Closes the buffer and releases any external resources contained by this buffer. This method is idempotent.

    Definition Classes
    FileBufferBackupBuffer → Closeable → AutoCloseable
  7. def drain(readLine: (OutboundMessage) ⇒ Future[OperationResult])(implicit executionContext: ExecutionContext, wireFormat: WireFormat): Future[OperationResult]

    Permalink

    Drain the buffer using the readLine function to process each message in the buffer.

    Drain the buffer using the readLine function to process each message in the buffer. This method works with scala.concurrent.Future objects and needs an scala.concurrent.ExecutionContext in scope

    readLine

    A function that takes a io.backchat.hookup.OutboundMessage and produces a scala.concurrent.Future of io.backchat.hookup.OperationResult

    executionContext

    An scala.concurrent.ExecutionContext

    returns

    A scala.concurrent.Future of io.backchat.hookup.OperationResult

    Definition Classes
    FileBufferBackupBuffer
  8. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

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

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

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. def open(): Unit

    Permalink

    Open this file buffer if not already opened.

    Open this file buffer if not already opened. This method is idempotent.

    Definition Classes
    FileBufferBackupBuffer
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def write(message: OutboundMessage)(implicit wireFormat: WireFormat): Unit

    Permalink

    Write a message to the buffer.

    Write a message to the buffer. When the buffer is opened it will write a new line to the file When the buffer is closed it will open the buffer and then write the new line. When the buffer is being drained it will buffer to memory When an exception is thrown it will first buffer the message to memory and then rethrow the exception

    message

    A io.backchat.hookup.OutboundMessage

    Definition Classes
    FileBufferBackupBuffer

Inherited from BackupBuffer

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped