tcMenuJavaAPI
Public Member Functions | List of all members
com.thecoderscorner.menu.remote.ConnectorFactory Interface Reference
Inheritance diagram for com.thecoderscorner.menu.remote.ConnectorFactory:
com.thecoderscorner.menu.remote.socket.SocketControllerBuilder

Public Member Functions

RemoteMenuController build () throws IOException
 
boolean attemptPairing (Optional< Consumer< AuthStatus >> maybePairingListener) throws IOException
 

Detailed Description

A base connection factory for client side remote connectors that can build connections and try to pair with a device. This is for client side connections such as embedCONTROL remote and RemoteConnectors.

Member Function Documentation

◆ attemptPairing()

boolean com.thecoderscorner.menu.remote.ConnectorFactory.attemptPairing ( Optional< Consumer< AuthStatus >>  maybePairingListener) throws IOException

Attempt to pair with a remote optionally providing a listener that gets notified of status for updating a UI for example. It returns when pairing is complete.

Parameters
maybePairingListeneran optional pairing listener to listen for status updates
Returns
true if successful, otherwise false.
Exceptions
IOExceptionif the pairing connection fails.

Implemented in com.thecoderscorner.menu.remote.socket.SocketControllerBuilder.

◆ build()

RemoteMenuController com.thecoderscorner.menu.remote.ConnectorFactory.build ( ) throws IOException

Build a remote connection from the factory and return a controller that can be used to manage the menu on a remote device.

Returns
the controller object
Exceptions
IOExceptionif the controller cannot be created

Implemented in com.thecoderscorner.menu.remote.socket.SocketControllerBuilder.


The documentation for this interface was generated from the following file: