Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package scalawag
    Definition Classes
    org
  • package timber
    Definition Classes
    scalawag
  • package backend
    Definition Classes
    timber
  • package receiver

    Contains all of the built-in support for receivers, which are the leaves of dispatcher routing graphs.

    Contains all of the built-in support for receivers, which are the leaves of dispatcher routing graphs. Receivers do something with entries. Exactly what they do depends on the implementation.

    Definition Classes
    backend
  • package buffering

    Contains the composable Receiver buffering policies available in timber.

    Contains the composable Receiver buffering policies available in timber. These only affect how often the receiver is flushed by timber. Many receivers will be based on instances of other classes that are themselves buffered (e.g., BufferedWriters and BufferedOutputStreams). While the flushes that timber instigates should make it down to the underlying objects, those objects may also flush for other reasons (e.g., their buffer reaching capacity). So, this buffering policy may not be the only source of flushes.

    Each of the policies has two flavors. The first is a trait that can be used to mixin to a StackableReceiver. The second is an object that can be used as an argument to the file() method in the DSL.

    Definition Classes
    receiver
  • package concurrency

    Contains the composable Receiver concurrency policies available in timber.

    Contains the composable Receiver concurrency policies available in timber. These determine whether concurrent access to the various Receiver methods is allowed.

    Each of the policies has two flavors. The first is a trait that can be used to mixin to a StackableReceiver. The second is an object that can be used as an argument to the file() method in the DSL.

    Definition Classes
    receiver
  • package formatter

    Contains functionality for turning log entries into text.

    Contains functionality for turning log entries into text.

    Definition Classes
    receiver
  • ConsoleErrReceiver
  • ConsoleOutReceiver
  • DelegatingReceiver
  • Receiver
  • WriterBasedReceiver
  • WriterBasedStackableReceiver

object Receiver

Provides methods for telling timber how to manage your Receivers.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Receiver
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def closeOnShutdown(receivers: Receiver*): Unit

    Registers receivers to be closed at system shutdown.

    Registers receivers to be closed at system shutdown. This uses the Java runtime's addShutdownHook which only executes during certain system shutdown scenarios.

    Calling this method multiple times with the same receiver has no effect beyond calling it once.

    receivers

    a set of receivers to attempt to close on normal system shutdown

  7. def closeOnSignal(signal: String, receivers: Receiver*): Unit

    Registers receivers to be closed when the JVM receives a certain signal.

    Registers receivers to be closed when the JVM receives a certain signal. This is intended for integration with tools like logrotate that are capable of sending signals during rotation to tell the logging process to close and reopen its log files to prevent the process from hanging on to an open file handle and therefore continuing to log to a log file that has been rotated out.

    Calling this method multiple times with the same receiver and signal combination has no effect beyond calling it once with that combination. All receivers passed to calls for the same signal are accumulated and closed when that signal is received. There is no way to retract the registration.

    signal

    the signal to listen for (I recommend "HUP")

    receivers

    the receivers to close when the signal is received

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped