GitHub - danielklecha/SharpIppNext: A .NET Standard library that can be used as IPP client and IPP server. · GitHub
Skip to content

danielklecha/SharpIppNext

 
 

Folders and files

Repository files navigation

SharpIppNext

NuGet NuGet downloads Docs License Coverage Status Ask DeepWiki

A .NET Standard library for building Internet Printing Protocol (IPP) clients and servers.

Features

  • IPP Version Support: Comprehensive client and server implementation supporting IPP versions 1.0, 1.1, 2.0, 2.1, and 2.2.
  • Specification Conformance: Full compliance with core IPP models, binary encoding rules, and transport semantics.
  • Client & Server SDK: Strongly-typed interfaces to build both client applications (ISharpIppClient) and print servers (ISharpIppServer).
  • Over 70 Supported Operations: Out-of-the-box methods for standard IPP operations, plus support for sending custom/extended requests via raw message mapping.
  • System Service Support: Broad support for IPP System Service operations defined in PWG 5100.22-2025, including system and printer resource management, power policies, and subscription operations.
  • CUPS Compatibility: Full client-side support for CUPS-specific operations (e.g., CUPS-Get-Printers).
  • Two-Tier Validation: Recursive model-level checks using standard .NET DataAnnotations alongside strict low-level RFC 8011 attribute and octet-limit validation.
  • Native AOT Compatible: Optimized and verified for Ahead-of-Time compilation with zero reflection overhead (AOT sample projects included).
  • Strong-Named Assembly: Available in both standard and strong-named NuGet packages.

Installation

Install the library via NuGet:

dotnet add package SharpIppNext

Strong-named version

NuGet NuGet downloads

dotnet add package SharpIppNext.StrongName

Getting Started

Quick Start

Initialize the client and send an IPP request:

using SharpIpp;
using SharpIpp.Models.Requests;

// 1. Initialize the client
using SharpIppClient client = new();

// 2. Create a request
var request = new GetPrinterAttributesRequest
{
    OperationAttributes = new()
    {
        PrinterUri = new Uri("ipp://localhost:631/printers/my-printer")
    }
};

// 3. Send the request
var response = await client.GetPrinterAttributesAsync(request);
Console.WriteLine($"Printer State: {response.PrinterAttributes?.PrinterState}");

Examples

Setting the IPP Version

By default, operations use IPP version 1.1. To target another version (such as IPP 2.0, 2.1, or 2.2), set the Version property on your request object.

Documentation

For full documentation and API reference, please visit https://danielklecha.github.io/SharpIppNext/.

Contributing

Contributions are welcome! Please refer to the CONTRIBUTING.md file for more information on how to get started.

License

SharpIppNext is provided as-is under the MIT license.

About

A .NET Standard library that can be used as IPP client and IPP server.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Contributors

Languages

  • C# 100.0%