Examples Overview

​

Available Examples

​

Screenshot Example

• Demonstrates basic RDP client implementation in under 500 lines
• Uses blocking I/O with ironrdp-blocking crate
• Shows TLS upgrade process with custom certificate verification
• Handles graphics updates and image decoding
• Supports compression configuration

• Automated screenshot capture for monitoring
• Testing RDP server implementations
• Learning basic IronRDP client structure

​

Server Example

• Demonstrates RDP server implementation using ironrdp-server
• Implements audio streaming with OPUS encoding
• Supports clipboard redirection (stub implementation)
• Shows TLS/Hybrid security configuration
• Generates random colored bitmap updates for display
• Handles keyboard and mouse input events

• Building custom RDP servers
• Remote application access
• Virtual desktop infrastructure (VDI)
• Testing RDP client implementations

​

Example Structure

1. Argument Parsing: Using pico_args for simple CLI argument handling
2. Logging Setup: Tracing subscriber with IRONRDP_LOG environment variable
3. Configuration: Building connector or server configuration
4. Connection/Accept: Establishing the RDP connection
5. Active Stage: Processing RDP protocol messages
6. Cleanup: Proper resource cleanup and error handling

​

Common Patterns

​

Error Handling

fn main() -> anyhow::Result<()> {
    let config = parse_args()?;
    setup_logging()?;
    run(config)
}

​

Logging Configuration

# Show all IronRDP logs
IRONRDP_LOG=debug cargo run --example screenshot -- --host example.com -u user -p pass

# Filter specific modules
IRONRDP_LOG=ironrdp_connector=trace cargo run --example server

​

TLS Configuration

let mut config = rustls::client::ClientConfig::builder()
    .dangerous()
    .with_custom_certificate_verifier(std::sync::Arc::new(NoCertificateVerification))
    .with_no_client_auth();

// Enable SSLKEYLOGFILE for Wireshark debugging
config.key_log = std::sync::Arc::new(rustls::KeyLogFile::new());

// Disable TLS resumption (required for CredSSP)
config.resumption = rustls::client::Resumption::disabled();

​

Building Examples

​

Build All Examples

cargo build --examples

​

Build Specific Example

cargo build --example screenshot
cargo build --example server

​

Run with Logging

IRONRDP_LOG=info cargo run --example screenshot -- --host 10.0.0.100 -u Administrator -p MyPassword

​

Platform Support

#[cfg(windows)]
platform: MajorPlatformType::WINDOWS,
#[cfg(target_os = "macos")]
platform: MajorPlatformType::MACINTOSH,
#[cfg(target_os = "linux")]
platform: MajorPlatformType::UNIX,

​

Dependencies

• ironrdp: Core RDP protocol implementation
• ironrdp-blocking: Blocking I/O abstractions
• anyhow: Error handling
• tokio-rustls: TLS support
• tracing: Structured logging
• pico_args: Argument parsing
• image: Image encoding (screenshot example)
• rand: Random number generation (server example)

​

Next Steps

​

Additional Resources

• API Reference
• Getting Started
• Architecture Guide