7. Reference

• 7.1. Overview
• 7.2. Message Definitions
  • 7.2.1. How message definitions are looked up
• 7.3. Client API Reference
  • 7.3.1. Python API Reference
    • 7.3.1.1. Thread-Safety
    • 7.3.1.2. os.fork() calls
    • 7.3.1.3. Using the links_and_nodes Module: Public API
      • 7.3.1.3.1. client Class
        • 7.3.1.3.1.1. client Constructor
          • client
      • 7.3.1.3.2. Client Objects
        • client.subscribe()
        • client.publish()
        • client.parameter_block()
        • ParameterBlock
          • ParameterBlock.add()
          • ParameterBlock.register()
          • ParameterBlock.update()
        • ParameterSignal
          • ParameterSignal.input
          • ParameterSignal.output
        • ParameterOutputs
        • client.get_service()
        • client.get_service_provider()
        • client.wait_and_handle_service_group_requests()
        • client.handle_service_group_in_thread_pool()
        • client.set_max_threads()
      • 7.3.1.3.3. Port Objects
        • port
        • 7.3.1.3.3.1. port.packet
          • port.packet
      • 7.3.1.3.4. Subscriber Ports
        • inport
        • 7.3.1.3.4.1. inport methods
          • port.read()
      • 7.3.1.3.5. Publisher Ports
      • 7.3.1.3.6. outport Methods
        • port.write()
      • 7.3.1.3.7. Classes for instantiating Services
        • 7.3.1.3.7.1. Service provider (non-wrapped or “direct”) version
          • service_provider.set_handler()
          • service_provider.do_register()
          • connection.respond()
        • 7.3.1.3.7.2. Service Provider Wrapper Class
          • service_provider
          • service_provider.__init__()
          • service_provider.wrap_service_provider()
          • service_provider.handle_service_group_requests()
      • 7.3.1.3.8. Service Client Wrapper Class
        • services_wrapper
        • services_wrapper.__init__()
        • ServiceErrorResponse
        • services_wrapper.wrap_service()
      • 7.3.1.3.9. Service Objects
        • service
        • 7.3.1.3.9.1. Members
          • service.req
          • service.resp
        • 7.3.1.3.9.2. Methods
          • service.call()
    • 7.3.1.4. Private (Internal API)
      • port_base
      • inport.read()
      • inport.has_publisher()
      • inport.unblock()
      • outport
      • outport.write()
      • outport.has_subscriber()
    • 7.3.1.5. Relevant Source Code Files for further Reference
  • 7.3.2. C++ API Reference
    • 7.3.2.1. Required Headers
    • 7.3.2.2. Thread-Safety
    • 7.3.2.3. Exception Safety
    • 7.3.2.4. fork() calls
    • 7.3.2.5. Main API functions
      • 7.3.2.5.1. Placeholders used in this description
      • 7.3.2.5.2. Client class
        • client
          • client::client()
          • client::client()
          • client::client()
          • client::client()
        • 7.3.2.5.2.1. Client Instance Methods
          • publish()
          • subscribe()
          • wait_and_handle_service_group_requests()
          • handle_service_group_in_thread_pool()
          • set_max_threads()
          • get_parameters()
      • 7.3.2.5.3. Parameter Client API
        • parameter_proxy
          • parameter_proxy::parameter_proxy()
          • parameter_proxy::parameter_proxy()
          • parameter_proxy::get_parameters()
          • parameter_proxy::strict_type_checks()
          • parameter_proxy::set_strict_type_checks()
          • parameter_proxy::get_description()
          • parameter_proxy::get_input()
          • parameter_proxy::get_output()
          • parameter_proxy::set_override()
          • parameter_proxy::set_override_from_data_scalar()
          • parameter_proxy::set_override_from_data_vector()
          • parameter_proxy::set_override_from_data_matrix()
          • parameter_proxy::get_into_data_scalar()
          • parameter_proxy::get_into_data_vector()
          • parameter_proxy::get_into_data_matrix()
          • parameter_proxy::reset_override()
          • parameter_proxy::get_signal()
          • parameter_proxy::get_internal_value()
        • signal_proxy
          • signal_proxy::get_input()
          • signal_proxy::get_output()
          • signal_proxy::set_override()
          • signal_proxy::reset_override()
          • signal_proxy::get_description()
          • signal_proxy::get_internal_value()
        • parameter_value
          • parameter_value::full_name
          • parameter_value::description
          • parameter_value::data_type
          • parameter_value::element_data_type
          • parameter_value::scalar_size
          • parameter_value::shape
          • parameter_value::scalar_kind
          • parameter_value::override_enabled
          • parameter_value::input_float
          • parameter_value::input_integer
          • parameter_value::output_float
          • parameter_value::output_integer
        • DataType
        • ValueSource
          • ValueSource::input
          • ValueSource::output
        • MatrixLayout
          • MatrixLayout::row_major
          • MatrixLayout::column_major
        • service
        • get_service()
        • get_service_provider()
        • release_service()
      • 7.3.2.5.4. Port Base Class
        • port_base
        • message_size
      • 7.3.2.5.5. Output Ports
        • outport
        • 7.3.2.5.5.1. Output port Methods
          • write()
          • write()
      • 7.3.2.5.6. Input Ports
        • inport
        • 7.3.2.5.6.1. Input Port Methods
          • read()
          • read()
      • 7.3.2.5.7. Service calls (client side)
        • SVMDEF_NAME_t
        • 7.3.2.5.7.1. Methods
          • call()
          • call()
          • handler_t
          • set_handler()
          • USER_SERVICE_HANDLER()
          • do_register()
          • service_request
          • set_data()
          • respond()
          • is_aborted()
          • finished()
          • abort()
      • 7.3.2.5.8. Symbols generated by ln_generate
        • 7.3.2.5.8.1. Structs generated from Message Definitions (for both topics and services)
        • 7.3.2.5.8.2. Service data buffer
          • MDEF_NAME_t
          • req
          • resp
        • 7.3.2.5.8.3. Classes and Methods auto-generated for service providers
          • SVMDEF_NAME_base
          • register_SVMDEF_NAME()
          • on_SVMDEF_NAME()
          • run()
        • 7.3.2.5.8.4. Symbols generated for service client
          • SVMDEF_NAME()
    • 7.3.2.6. Relevant Source Code Files for further Reference
      • 7.3.2.6.1. C++ API
      • 7.3.2.6.2. C API
  • 7.3.3. Public C API Reference
    • 7.3.3.1. Notes on the C API
    • 7.3.3.2. Thread-Safety
    • 7.3.3.3. fork() calls
    • 7.3.3.4. Memory Management
    • 7.3.3.5. LN Client
      • ln_client
      • ln_init()
      • ln_init_to_manager()
      • ln_get_error_message()
    • 7.3.3.6. Ports and Topics
      • ln_inport
      • ln_outport
      • ln_subscribe()
      • ln_subscribe_with_buffers()
      • ln_unsubscribe()
      • ln_publish()
      • ln_publish_with_buffers()
      • ln_unpublish()
    • 7.3.3.7. Sending, Receiving and Handling Message Packets
      • 7.3.3.7.1. Common Types
        • ln_packet
      • 7.3.3.7.2. Receiving Packets
        • ln_read()
        • ln_read_timeout()
      • 7.3.3.7.3. Sending Packets
        • ln_write()
    • 7.3.3.8. LN Services
      • 7.3.3.8.1. Common Types
        • ln_service
        • ln_service_request
      • 7.3.3.8.2. Provider API
        • ln_service_init()
        • ln_service_deinit()
        • ln_service_handler
        • ln_service_provider_set_handler()
        • ln_service_provider_register()
        • ln_service_request_respond()
        • ln_wait_and_handle_service_group_requests()
        • ln_handle_service_group_in_thread_pool()
        • ln_set_max_threads()
        • ln_service_request_set_data()
      • 7.3.3.8.3. Client API
        • ln_service_call()
    • 7.3.3.9. message definitions
      • ln_get_message_definition_v21()
      • ln_get_message_definition_for_topic_v17()
      • ln_describe_message_definition()
      • ln_put_message_definition()
    • 7.3.3.10. C API Error Codes and their Meaning
  • 7.3.4. Environment Variables which affect LN clients
• 7.4. LN Manager
  • 7.4.1. Environment Variables which control the LNM
  • 7.4.2. Standard environment variables read by the LNM code
  • 7.4.3. Environment Variables which control the LN daemon
  • 7.4.4. The ln_manager GUI
    • 7.4.4.1. Overview
    • 7.4.4.2. Global Buttons
      • 7.4.4.2.1. docs
      • 7.4.4.2.2. web ui
      • 7.4.4.2.3. save all
      • 7.4.4.2.4. edit
      • 7.4.4.2.5. reload
      • 7.4.4.2.6. Opening a scope
  • 7.4.5. LN Manager user config
    • 7.4.5.1. GUI: alternate color scheme
    • 7.4.5.2. file-system location of dynamically generated message definitions
  • 7.4.6. Web UI WebSocket Protocol
    • 7.4.6.1. Transport
    • 7.4.6.2. HTTP Authentication
    • 7.4.6.3. Raw HTTP Log Endpoint
    • 7.4.6.4. Web VNC X Display Endpoints
    • 7.4.6.5. Save-All HTTP Endpoint
    • 7.4.6.6. LN Daemon Logger HTTP Endpoint
    • 7.4.6.7. JSON Message Format
      • 7.4.6.7.1. Manager to client messages
      • 7.4.6.7.2. Client to manager messages
    • 7.4.6.8. Process Snapshot Example
    • 7.4.6.9. Daemon Process Lists
    • 7.4.6.10. Clients
    • 7.4.6.11. Parameters
    • 7.4.6.12. Process Control Examples
    • 7.4.6.13. Terminal Output and Input
    • 7.4.6.14. Python Reference Client
      • 7.4.6.14.1. Proxy support
    • 7.4.6.15. Topics, Services and Logs
    • 7.4.6.16. Error Frames
    • 7.4.6.17. Implementation Notes