ide-find-remote-debugging-connection

ide-set-default-remote-debugging-connection

ide-list-remote-debugging-connections Functions

Summary

IDE side: Find or set as default an IDE side remote debugging connection.

Package

dbg

Signatures

ide-find-remote-debugging-connection => connection-or-nil, default-p

ide-set-default-remote-debugging-connection connection => connection

ide-list-remote-debugging-connections &optional match-string => connections

Arguments

`connection`⇩	An ide-remote-debugging.
`match-string`⇩	A string.

Values

`connection-or-nil`⇩	An ide-remote-debugging or `nil`.
`default-p`⇩	A boolean.
`connection`	An ide-remote-debugging.
`connections`	A list of ide-remote-debugging.

Description

The function ide-find-remote-debugging-connection tries to find a useful IDE remote debugging connection. If ide-set-default-remote-debugging-connection was called, and the connection argument in the last call is still open, then ide-find-remote-debugging-connection returns this connection as connection-or-nil and default-p is t. Otherwise it returns the connection that was opened last and is still open as connection-or-nil and default-p is nil. If there are no opened connections then it returns connection-or-nil and default-p both as nil.

The function ide-set-default-remote-debugging-connection sets the default connection that ide-find-remote-debugging-connection will return to connection. connection must be a valid IDE side remote debugging connection, that is an instance of ide-remote-debugging that is still open. You can obtain one by calling create-ide-remote-debugging-connection, ide-find-remote-debugging-connection, ide-list-remote-debugging-connections or remote-object-connection.

The function ide-list-remote-debugging-connections returns a list of opened connections. If match-string is nil, the list contains all the connections. If match-string is non-nil, the list contains only the connections whose name contains match-string as a substring (plain match, case-insensitive).

Notes

ide-find-remote-debugging-connection is used by all the IDE side remote debugging interface functions like ide-open-a-listener and ide-eval-form-in-remote when their connection argument is nil (the default).

The various Editor commands (starting with "Remote"), except those ending with "In Listener", use ide-eval-form-in-remote, and therefore also use ide-find-remote-debugging-connection. The Editor command Set Default Remote Debugging Connection uses ide-list-remote-debugging-connections and ide-set-default-remote-debugging-connection.

The Remote Debugger and Remote Listener tools, and all remote object handles, are each associated with a specific connection, and therefore do not use ide-find-remote-debugging-connection.

ide-find-remote-debugging-connection and ide-list-remote-debugging-connections can find the connections because create-ide-remote-debugging-connection remembers each connection it creates. The higher level interface functions start-ide-remote-debugging-server and ide-connect-remote-debugging use create-ide-remote-debugging-connection.