dasf-messaging-typescript

Contents:

  • Installation
    • Installation for development
  • Usage
  • API Reference
    • DASFConnection
      • DASFConnection
        • DASFConnection.connected
        • DASFConnection.sendMessage()
        • DASFConnection.sendRequest()
        • DASFConnection.close()
        • DASFConnection.getApiInfo()
        • DASFConnection.getModuleInfo()
    • DASFUrlBuilder
      • DASFUrlBuilder
        • DASFUrlBuilder.DASFConsumerURL
        • DASFUrlBuilder.DASFProducerURL
        • DASFUrlBuilder.consumeTopic
        • DASFUrlBuilder.topic
      • WebsocketUrlBuilder
        • WebsocketUrlBuilder.DASFConsumerURL
        • WebsocketUrlBuilder.DASFProducerURL
        • WebsocketUrlBuilder.consumeTopic
        • WebsocketUrlBuilder.topic
        • WebsocketUrlBuilder.buildUrl()
        • WebsocketUrlBuilder.generateConsumeTopic()
        • WebsocketUrlBuilder.generateRequestToken()
        • WebsocketUrlBuilder.generateSubscriptionPrefix()
      • PulsarUrlBuilder
        • PulsarUrlBuilder.DASFConsumerURL
        • PulsarUrlBuilder.DASFProducerURL
        • PulsarUrlBuilder.consumeTopic
        • PulsarUrlBuilder.topic
        • PulsarUrlBuilder.buildUrl()
        • PulsarUrlBuilder.generateConsumeTopic()
        • PulsarUrlBuilder.generateRequestToken()
        • PulsarUrlBuilder.generateSubscriptionPrefix()
    • Request Message classes
      • DASFModuleRequest
        • DASFModuleRequest.context
        • DASFModuleRequest.payload
        • DASFModuleRequest.properties?
        • DASFModuleRequest.getMessageType()
        • DASFModuleRequest.createApiInfoMessage()
        • DASFModuleRequest.createInfoMessage()
        • DASFModuleRequest.createPingMessage()
        • DASFModuleRequest.createPongMessage()
        • DASFModuleRequest.createRequestMessage()
      • DASFModuleResponse
        • DASFModuleResponse.messageId
        • DASFModuleResponse.payload
        • DASFModuleResponse.properties?
        • DASFModuleResponse.publishTime
        • DASFModuleResponse.getFragmentId()
        • DASFModuleResponse.getMessageType()
        • DASFModuleResponse.getNumberOfFragments()
        • DASFModuleResponse.getRequestContext()
        • DASFModuleResponse.getRequestMessageId()
        • DASFModuleResponse.isFragmented()
      • DASFProgressReport
        • DASFProgressReport.children?
        • DASFProgressReport.report_id
        • DASFProgressReport.report_type
        • DASFProgressReport.status
        • DASFProgressReport.step_message
        • DASFProgressReport.steps
        • DASFProgressReport.hasError()
        • DASFProgressReport.hasSuccess()
        • DASFProgressReport.isComplete()
        • DASFProgressReport.isRunning()
    • Data classes
      • ModuleApiInfo
        • ModuleApiInfo.classes
        • ModuleApiInfo.functions
        • ModuleApiInfo.rpcSchema
      • FunctionApiInfo
        • FunctionApiInfo.name
        • FunctionApiInfo.returnSchema
        • FunctionApiInfo.rpcSchema
      • ClassApiInfo
        • ClassApiInfo.methods
        • ClassApiInfo.name
        • ClassApiInfo.rpcSchema
    • Enums
  • Contribution and development hints
    • Contributing in the development
      • Option 1: Development setup with docker
      • Option 2: Development setup without docker
    • Running the test suite
      • Option 1: Run tests with docker
      • Option 2: Run tests without docker
    • Helpers
      • Shortcuts with make
      • Annotating licenses
    • Fixing the docs
    • Contributing to the code
    • Updating the skeleton for this package
dasf-messaging-typescript
  • Search

© Copyright 2024 Helmholtz-Zentrum hereon GmbH.

Built with Sphinx using a theme provided by Read the Docs.
Creative Commons License This documentation is licensed under CC-BY-4.0