Function demo_ring_buffer_schema

src/vpp-api/python/vpp_papi/vpp_stats.py:1580–1633

Demo function showing how to use ring buffer schema functionality

()

def demo_ring_buffer_schema():
    """Demo function showing how to use ring buffer schema functionality"""
    print("Ring Buffer Schema Demo")
    print("=" * 30)

    try:
        # Connect to VPP stats
        stats = VPPStats()
        stats.connect()

        # Look for test ring buffer
        try:
            ring_buffer = stats.get_ring_buffer("/test/ring-buffer")
            print("✓ Found test ring buffer")

            # Get configuration
            config = ring_buffer.get_config()
            print(f"Ring buffer config: {config}")

            # Get schema information
            schema_data, schema_size, schema_version = ring_buffer.get_schema()
            print(f"Schema info: size={schema_size}, version={schema_version}")

            # Get schema as string
            schema_string, _, _ = ring_buffer.get_schema_string()
            if schema_string:
                print(f"Schema content:\n{schema_string}")
            else:
                print("No schema found")

            # Use convenience methods
            print("\nUsing convenience methods:")
            conv_schema_string, conv_size, conv_version = (
                stats.get_ring_buffer_schema_string("/test/ring-buffer")
            )
            print(
                f"Convenience method result: size={conv_size}, version={conv_version}"
            )
            if conv_schema_string:
                print(f"Schema: {conv_schema_string[:100]}...")

        except (KeyError, ValueError) as e:
            print(f"Test ring buffer not found: {e}")
            print(
                "Run 'test stats ring-buffer-gen /test/ring-buffer 100 1000 16' in VPP first"
            )

        stats.disconnect()

    except Exception as e:
        print(f"Error: {e}")
        print("Make sure VPP is running and stats socket is available")

    print("=" * 30)


if __name__ == "__main__":