Platforms to show: All Mac Windows Linux Cross-Platform
Back to PhidgetNetMBS class.
PhidgetNetMBS.addServer(serverName as String, address as String, port as Integer, password as String, Flags as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
The client will continually try to connect to the server, increasing the time between each attempt to a maximum interval of 16 seconds.
This call is intended for use when server discovery is not enabled, or to connect to a server that is not discoverable.
The server name used by this function does not have to match the name of the server running on the host machine. Only the address, port, and password need to match.
This call will fail if a server with the same name has already been discovered.
This call will fail if SetServerPassword() has already been called with the same server name, as SetServerPassword() registers the server entry anticipating the discovery of the server.
PhidgetNetMBS.disableServer(serverName as String, flags as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
By default the client (your program) will continually attempt to connect to added or discovered servers.This call will disable those attempts, but will not close an already established connection.
PhidgetNetMBS.disableServerDiscovery(serverType as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
DisableServerDiscovery() does not disconnect already established connections.
PhidgetNetMBS.enableServer(serverName as String)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
All servers are enabled by default.
This call will fail if the server was not previously added, disabled or discovered.
PhidgetNetMBS.enableServerDiscovery(serverType as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Currently Multicast DNS is used to discover and publish Phidget servers.
To connect to remote Phidgets, call this function with server type kServerTypeDeviceRemote.
EnableServerDiscovery must be called once for each server type your program requires. Multiple calls for the same server type are ignored
This call will fail with the error code EPHIDGET_UNSUPPORTED if your computer does not have the required mDNS support. We recommend using Bonjour Print Services on Windows and Mac, or Avahi on Linux.
PhidgetNetMBS.removeAllServers
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
PhidgetNetMBS.removeServer(serverName as String)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
If the client is currently connected to the server, the connection will be closed.
If the server was discovered (not added by AddServer()), the connection may be reestablished if and when the server is rediscovered. DisableServer() should be used to prevent the reconnection of a discovered server
PhidgetNetMBS.setServerPassword(serverName as String, password as String)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
If the server has not already been added or discovered, a placeholder server entry will be registered to use this password on the server once it is discovered.
serverName: The name of the server
password: The password to use for the server (empty string if no password)
The items on this page are in the following plugins: MBS Phidgets Plugin.