twampyre plugin | demo

The demo plugin is a minimal asynchronous test plugin that demonstrates how to implement a custom plugin using the twampyre framework. It simulates packet transmission and delay measurements using random values, and is intended for:

  • Plugin development and debugging
  • Demonstrating plugin lifecycle and configuration
  • Validating metrics collection and logging

Note
This plugin is not intended for production use, but serves as a reference and testing tool within the twampyre system.

✨ Key Features

  • Asynchronous execution model
  • Simulates sending and receiving packets with randomized delays
  • Demonstrates:
  • Plugin/session configuration
  • Logging and debug output
  • Metric collection and labeling

⚖ License

Licensed under the BSD 3-Clause License.

🧩 Plugin Configuration

Plugin-level configuration is mostly illustrative. The current implementation supports:

Name Type Default Description
test str "for demo purposes only" Arbitrary plugin-level test attribute

🧪 Session Parameters

Session-level configuration is similarly illustrative. The plugin currently supports:

Name Type Default Description
test str "for demo purposes only" Arbitrary session-level test attribute

🛠 Usage Example

plugins:
  demo:
    test: "Plugin used for demo and testing"

kinds:
  testdevice:
    demo:
      interval: 1.0
      timeout: 0.5

targets:
  127.0.0.1:
    kind: testdevice
    demo:
      test: "Session used for demo and testing"
      log_level: DEBUG