Metro ConnectionWatcher documentation

The public Javadoc describes the GatewayNetworkManager class, which includes several methods in its summary that return com.inductiveautomation.metro.impl.ConnectionWatcher objects, but I can’t seem to find any sort of documentation for those ConnectionWatcher objects themselves to make use of them.

Any guidance or source of info that I might be missing here?

When you see .impl in a package or class name, that is a hint that you are looking at an implementation of a public interface. If you aren't finding docs, then the implementation is deliberately not public.

Don't hold your breath.

Perhaps you should describe the problem you are trying to solve.

I had figured that was going to be the case, but found it odd that the methods that return those objects would be documented publicly, but then how to use the objects would not.

Essentially what I’m needing to accomplish is the identify if a specific gateway is reachable via the GAN, determine its state if possible, and then react to those state changes. I need to do this for multiple gateways simultaneously, which was what lead me to the GatewayNetworkManager and the getAvailableConnections method.

Consider using jython in a gateway script to introspect to find what's possible. You might find my Integration Toolkit's system.reflection.* methods helpful.

Thank you! I will look into this and report back!

There are a couple other ways you can do this without needing to use the SDK. For example, connected gateways are available as tags under the System tag provider under this path: [System]Gateway/Gateway Network

If you are using 8.3, you can also use the OpenAPI routes to get a connected gateways list via this route: /data/api/v1/gateway-network/gateways