Node Setup

RobotRaconteurNodeSetup Class

ClientNodeSetup Class

ServerNodeSetup Class

SecureServerNodeSetup Class

CommandLineConfigParser Class

Node Setup Flags

Setup option flags

Setup option flags passed to node setup classes to select options to enable and disable. Flags are used to configure the following types of options:

  1. Enable and disable transport types

  2. Modify transport options including discovery, security requirements, and connection listening

  3. Configure TLS behavior

  4. Enable local tap for logging

Node setup classes also allow options and flags to be “overridden” using command line options. Use the *_ALLOW_OVERRIDE options to configure when these overrides are allowed.

The ClientNodeSetup, ServerNodeSetup, and SecureServerNodeSetup are convenience classes for the most commonly used options.

RobotRaconteur.RobotRaconteurNodeSetupFlags_NONE = 0x0

No options enabled

RobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_NODE_DISCOVERY_LISTENING = 0x1

Enable node discovery listening on all transports

RobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_NODE_ANNOUNCE = 0x2

Enable node announce on all transports

RobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_LOCAL_TRANSPORT = 0x4

Enable LocalTransport

RobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_TCP_TRANSPORT = 0x8

Enable TcpTransport

RobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_HARDWARE_TRANSPORT = 0x10

Enable HardwareTransport

RobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TRANSPORT_START_SERVER = 0x20

Start the LocalTransport server to listen for incoming clients

RobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TRANSPORT_START_CLIENT = 0x40

Start the LocalTransport client with specified node name

RobotRaconteur.RobotRaconteurNodeSetupFlags_TCP_TRANSPORT_START_SERVER = 0x80

Start the TcpTransport server to listen for incoming clients on the specified port

RobotRaconteur.RobotRaconteurNodeSetupFlags_TCP_TRANSPORT_START_SERVER_PORT_SHARER = 0x100

Start the TcpTransport server to incoming for incoming clients using the port sharer

RobotRaconteur.RobotRaconteurNodeSetupFlags_DISABLE_MESSAGE4 = 0x200

Disable Message Format Version 4 on all transports

RobotRaconteur.RobotRaconteurNodeSetupFlags_DISABLE_STRINGTABLE = 0x400

Disable Message Format Version 4 string table on all transports

RobotRaconteur.RobotRaconteurNodeSetupFlags_DISABLE_TIMEOUTS = 0x800

Disable all timeouts (useful for debugging)

RobotRaconteur.RobotRaconteurNodeSetupFlags_LOAD_TLS_CERT = 0x1000

Load the TLS certificate for TcpTransport

RobotRaconteur.RobotRaconteurNodeSetupFlags_REQUIRE_TLS = 0x2000

Require TLS for all clients on TcpTransport

RobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TRANSPORT_SERVER_PUBLIC = 0x4000

Make LocalTransport server listen for incoming clients from all users

RobotRaconteur.RobotRaconteurNodeSetupFlags_NODENAME_OVERRIDE = 0x10000

Allow NodeName to be configured using command line options

RobotRaconteur.RobotRaconteurNodeSetupFlags_NODEID_OVERRIDE = 0x20000

Allow NodeID to be configured using command line options

RobotRaconteur.RobotRaconteurNodeSetupFlags_TCP_PORT_OVERRIDE = 0x40000

Allow TCP port to be configured using command line options

RobotRaconteur.RobotRaconteurNodeSetupFlags_TCP_WEBSOCKET_ORIGIN_OVERRIDE = 0x80000

Allow TCP WebSocket origin control to be configured using command line options

RobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_INTRA_TRANSPORT = 0x100000

Enable IntraTransport

RobotRaconteur.RobotRaconteurNodeSetupFlags_INTRA_TRANSPORT_START_SERVER = 0x200000

Start the IntraTransport server to listen for incoming clients

RobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TAP_ENABLE = 0x1000000

Enable the LocalTap debug logging system

RobotRaconteur.RobotRaconteurNodeSetupFlags_LOCAL_TAP_NAME = 0x2000000

Allow the user to set the LocalTap name

RobotRaconteur.RobotRaconteurNodeSetupFlags_ENABLE_ALL_TRANSPORTS = 0x10001c

Convenience flag to enable all transports

RobotRaconteur.RobotRaconteurNodeSetupFlags_CLIENT_DEFAULT = 0x10004d

Default configuration for client nodes (See ClientNodeSetup)

RobotRaconteur.RobotRaconteurNodeSetupFlags_CLIENT_DEFAULT_ALLOWED_OVERRIDE = 0x3133e5d

Default allowed overrides for client nodes (See ClientNodeSetup)

RobotRaconteur.RobotRaconteurNodeSetupFlags_SERVER_DEFAULT = 0x3004af

Default configuration for server nodes

RobotRaconteur.RobotRaconteurNodeSetupFlags_SERVER_DEFAULT_ALLOWED_OVERRIDE = 0x33f7fff

Default allowed overrides for server nodes

RobotRaconteur.RobotRaconteurNodeSetupFlags_SECURE_SERVER_DEFAULT = 0x3034af

Default configuration for server nodes requiring TLS network transports

RobotRaconteur.RobotRaconteurNodeSetupFlags_SECURE_SERVER_DEFAULT_ALLOWED_OVERRIDE = 0x33f4fff

Default allowed overrides for server nodes requiring TLS network transports