Skip to content

API Reference

Comprehensive API documentation automatically generated from XML comments.

Generated Documentation

API Documentation Status

API documentation is automatically generated from XML comments during the CI build process. If you see 404 errors, the site may be in the middle of a deployment update.

  • Belay.Attributes - Attribute-based method decorators for device operations
  • Belay.Core - Core device communication and session management
  • Belay.Extensions - Dependency injection and configuration extensions
  • Belay.Sync - File synchronization utilities for device storage

Quick Reference

Core Classes

  • Device - Main device connection and communication
  • TaskExecutor - Handles [Task] attribute methods
  • EnhancedExecutor - Advanced method interception framework
  • DeviceProxy - Dynamic proxy for transparent method routing

Attributes

  • TaskAttribute - Execute methods as tasks with caching and timeout
  • ThreadAttribute - Background thread execution
  • SetupAttribute - Device initialization methods
  • TeardownAttribute - Device cleanup methods

Usage Examples

For practical examples, see the Examples section.

Released under the Apache License 2.0.