org.scaladebugger.api.debuggers

Debugger

trait Debugger extends Logging

Represents the generic interface that all debugger instances implement.

Linear Supertypes
Logging, AnyRef, Any
Known Subclasses
AttachingDebugger, LaunchingDebugger, ListeningDebugger, ProcessDebugger
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Debugger
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. implicit class LoggerExtras extends AnyRef

    Definition Classes
    Logging

Abstract Value Members

  1. abstract def connectedScalaVirtualMachines: Seq[ScalaVirtualMachine]

    Retrieves the connected virtual machines for the debugger.

    Retrieves the connected virtual machines for the debugger.

    returns

    The collection of connected virtual machines

  2. abstract def isRunning: Boolean

    Indicates whether or not the debugger is running.

    Indicates whether or not the debugger is running.

    returns

    True if it is running, otherwise false

  3. abstract def start[T](startProcessingEvents: Boolean, newVirtualMachineFunc: (ScalaVirtualMachine) ⇒ T): Unit

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    T

    The return type of the callback function

    startProcessingEvents

    If true, events are immediately processed by the VM as soon as it is connected

    newVirtualMachineFunc

    The function that will be called when a new virtual machine connection is created as a result of this debugger

  4. abstract def stop(): Unit

    Shuts down the debugger, releasing any connected virtual machines.

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. def addPendingScalaVirtualMachine(scalaVirtualMachine: ScalaVirtualMachine): Option[ScalaVirtualMachine]

    Adds a new Scala virtual machine whose pending operations will be applied to any new Scala virtual machine resulting from this debugger.

    Adds a new Scala virtual machine whose pending operations will be applied to any new Scala virtual machine resulting from this debugger.

    scalaVirtualMachine

    The Scala virtual machine to add

    returns

    Some Scala virtual machine if added, otherwise None

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def assertJdiLoaded(): Unit

    Attempts to load the JDI, asserting that it can be and is loaded.

    Attempts to load the JDI, asserting that it can be and is loaded.

    Attributes
    protected
    Annotations
    @throws( classOf[AssertionError] )
    Exceptions thrown
    AssertionError

    If failed to load the JDI

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  14. def getPendingScalaVirtualMachines: Seq[ScalaVirtualMachine]

    Retrieves the collection of Scala virtual machines whose pending operations will be applied to any new Scala virtual machine resulting from this debugger.

    Retrieves the collection of Scala virtual machines whose pending operations will be applied to any new Scala virtual machine resulting from this debugger.

    returns

    The collection of Scala virtual machines

  15. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  16. def isAvailable: Boolean

    Determines whether or not the debugger is available for use.

    Determines whether or not the debugger is available for use.

    returns

    True if the debugger is available, otherwise false

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  18. val jdiLoader: JDILoader

    Attributes
    protected

  19. val logger: Logger

    Attributes
    protected
    Definition Classes
    Logging

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

    Definition Classes
    AnyRef

  21. def newDummyScalaVirtualMachine(): ScalaVirtualMachine

    Creates a new dummy Scala virtual machine instance that can be used to prepare pending requests to apply to the Scala virtual machines generated by the debugger once it starts.

    Creates a new dummy Scala virtual machine instance that can be used to prepare pending requests to apply to the Scala virtual machines generated by the debugger once it starts.

    returns

    The new dummy (no-op) Scala virtual machine instance

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. def removePendingScalaVirtualMachine(scalaVirtualMachineId: String): Option[ScalaVirtualMachine]

    Removes a Scala virtual machine from the list whose pending operations would be applied to any new Scala virtual machine resulting from this debugger.

    Removes a Scala virtual machine from the list whose pending operations would be applied to any new Scala virtual machine resulting from this debugger.

    scalaVirtualMachineId

    The id of the Scala virtual machine to remove

    returns

    Some Scala virtual machine if removed, otherwise None

  25. def start(timeout: Duration): ScalaVirtualMachine

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    timeout

    The maximum time to wait for the JVM to connect

    returns

    The connected Scala virtual machine

    Note

    Returned Scala virtual machine represents next connected Scala virtual machine. All other Scala virtual machines connected after the first one will be ignored.

  26. def start(timeout: Duration, startProcessingEvents: Boolean): ScalaVirtualMachine

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    timeout

    The maximum time to wait for the JVM to connect

    startProcessingEvents

    If true, events are immediately processed by the VM as soon as it is connected

    returns

    The connected Scala virtual machine

    Note

    Returned Scala virtual machine represents next connected Scala virtual machine. All other Scala virtual machines connected after the first one will be ignored.

  27. def start(): Future[ScalaVirtualMachine]

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    returns

    The future representing the connected Scala virtual machine

    Note

    Returned future represents next connected Scala virtual machine. All other Scala virtual machines connected after the first one will be ignored.

  28. def start(startProcessingEvents: Boolean): Future[ScalaVirtualMachine]

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    startProcessingEvents

    If true, events are immediately processed by the VM as soon as it is connected

    returns

    The future representing the connected Scala virtual machine

    Note

    Returned future represents next connected Scala virtual machine. All other Scala virtual machines connected after the first one will be ignored.

  29. def start[T](newVirtualMachineFunc: (ScalaVirtualMachine) ⇒ T): Unit

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    Starts the debugger, performing any necessary setup and ending with an initialized debugger that is or will be capable of connecting to one or more virtual machine instances.

    T

    The return type of the callback function

    newVirtualMachineFunc

    The function that will be called when a new virtual machine connection is created as a result of this debugger

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

    Definition Classes
    AnyRef

  31. def toString(): String

    Definition Classes
    AnyRef → Any

  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. def withPending(scalaVirtualMachine: ScalaVirtualMachine): Debugger

    Adds a new Scala virtual machine to use for pending operations.

    Adds a new Scala virtual machine to use for pending operations. Essentially a wrapper around Debugger.addPendingScalaVirtualMachine).

    scalaVirtualMachine

    The Scala virtual machine to add

    returns

    The debugger instance updated with the new pending operations

  36. def withoutPending(scalaVirtualMachineId: String): Debugger

    Removes a Scala virtual machine used for pending operations.

    Removes a Scala virtual machine used for pending operations. Essentially a wrapper around Debugger.removePendingScalaVirtualMachine.

    scalaVirtualMachineId

    The id of the Scala virtual machine to remove

    returns

    The updated debugger instance

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped