Trait/Object

org.scaladebugger.api.debuggers

Debugger

Related Docs: object Debugger | package debuggers

Permalink

trait Debugger extends Logging

Represents the generic interface that all debugger instances implement.

Linear Supertypes
Logging, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Debugger
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class LoggerExtras extends AnyRef

    Permalink
    Definition Classes
    Logging

Abstract Value Members

  1. abstract def isRunning: Boolean

    Permalink

    Indicates whether or not the debugger is running.

    Indicates whether or not the debugger is running.

    returns

    True if it is running, otherwise false

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

    Permalink

    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

    defaultProfile

    The default profile to use with the new VMs

    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

  3. abstract def stop(): Unit

    Permalink

    Shuts down the debugger, releasing any connected virtual machines.

Concrete 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. def addPendingScalaVirtualMachine(scalaVirtualMachine: ScalaVirtualMachine): Option[ScalaVirtualMachine]

    Permalink

    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

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def assertJdiLoaded(): Unit

    Permalink

    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

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def connectedScalaVirtualMachines: Seq[ScalaVirtualMachine]

    Permalink

    Retrieves the connected virtual machines for the debugger.

    Retrieves the connected virtual machines for the debugger. Does not include any dummy virtual machines.

    returns

    The collection of connected virtual machines

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getPendingScalaVirtualMachines: Seq[ScalaVirtualMachine]

    Permalink

    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

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. def isAvailable: Boolean

    Permalink

    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

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. val jdiLoader: JDILoader

    Permalink
    Attributes
    protected
  18. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def newDummyScalaVirtualMachine(): ScalaVirtualMachine

    Permalink

    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

  21. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  23. def removePendingScalaVirtualMachine(scalaVirtualMachineId: String): Option[ScalaVirtualMachine]

    Permalink

    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

  24. def scalaVirtualMachineManager: ScalaVirtualMachineManager

    Permalink

    Retrieves the Scala virtual machine manager associated with this debugger.

    Retrieves the Scala virtual machine manager associated with this debugger.

    returns

    The Scala virtual machine manager.

    Note

    Currently, this manager is global, meaning that all debuggers have the same manager. Because of this, any operations dependent on the manager will be associated with all debuggers (such as getting a list of connected virtual machines).

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

    Permalink

    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. Uses the default profile for new VMs.

    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

  26. def start[T](defaultProfile: String, newVirtualMachineFunc: (ScalaVirtualMachine) ⇒ T): Unit

    Permalink

    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

    defaultProfile

    The default profile to use with the new VMs

    newVirtualMachineFunc

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

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

    Permalink

    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. Uses the default profile for new VMs.

    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

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

    Permalink

    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.

    defaultProfile

    The default profile to use with the new VMs

    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(startProcessingEvents: Boolean): Future[ScalaVirtualMachine]

    Permalink

    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. Uses the default profile for new VMs.

    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.

  30. def start(defaultProfile: String): Future[ScalaVirtualMachine]

    Permalink

    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.

    defaultProfile

    The default profile to use with the new VMs

    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.

  31. def start(): Future[ScalaVirtualMachine]

    Permalink

    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. Uses the default profile for new VMs.

    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.

  32. def start(timeout: Duration, defaultProfile: String, startProcessingEvents: Boolean): ScalaVirtualMachine

    Permalink

    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

    defaultProfile

    The default profile to use with the new VMs

    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.

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

    Permalink

    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. Uses the default profile for new VMs.

    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.

  34. def start(timeout: Duration, defaultProfile: String): ScalaVirtualMachine

    Permalink

    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

    defaultProfile

    The default profile to use with the new VMs

    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.

  35. def start(timeout: Duration): ScalaVirtualMachine

    Permalink

    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. Uses the default profile for new VMs.

    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.

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def withPending(scalaVirtualMachine: ScalaVirtualMachine): Debugger

    Permalink

    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

  42. def withoutPending(scalaVirtualMachineId: String): Debugger

    Permalink

    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