Class IronPdfConnectionType

Specifies how IronPDF connects to the rendering engine (IronPdfEngine). Choose based on your deployment architecture.

Example - Configure connection:

// Local executable (default):
Installation.ConnectionType = IronPdfConnectionType.LocalExecutable;
// Docker container:
IronPdf.Setting.Connection = IronPdfConnectionConfiguration.Docker;
// Remote server:
IronPdf.Setting.Connection = IronPdfConnectionConfiguration.RemoteServer(
"https://my-ironpdf-server.com:33350");

Inheritance

System.Object

IronPdfConnectionType

Namespace: IronPdf.GrpcLayer

Assembly: IronPdf.dll

Syntax

public sealed class IronPdfConnectionType : Enum

Remarks

Deployment Options:

• LocalExecutable - Default, runs engine locally
• Docker - Containerized deployment
• RemoteServer - Centralized server architecture
• CustomChannel - Advanced gRPC configurations

Related Resources:

• Docker Deployment Guide
• IronPdfEngine Docker

Fields

CustomChannel

Uses a custom gRPC channel for advanced networking configurations. Full control over connection parameters, credentials, and interceptors. Best for: Custom authentication, mTLS, corporate proxy environments.

Declaration

public const IronPdfConnectionType CustomChannel

Field Value

Type	Description
IronPdfConnectionType

Docker

Connects to IronPdfEngine running in a Docker container on the same host. Container must be running before PDF operations. Uses hostname "ironpdfengine". Best for: Containerized microservices, Kubernetes deployments.

Declaration

public const IronPdfConnectionType Docker

Field Value

Type	Description
IronPdfConnectionType

LocalExecutable

Connects to IronPdfEngine running as a local executable on the same machine. Default mode - engine binary auto-deploys and manages lifecycle. Best for: Desktop apps, development, single-server deployments.

Declaration

public const IronPdfConnectionType LocalExecutable

Field Value

Type	Description
IronPdfConnectionType

RemoteServer

Connects to IronPdfEngine running on a remote server over the network. Supports HTTPS for secure connections across networks. Best for: Centralized PDF processing, cloud deployments, load balancing.

Declaration

public const IronPdfConnectionType RemoteServer

Field Value

Type	Description
IronPdfConnectionType

value__

Declaration

public int value__

Field Value

Type	Description
System.Int32

See Also

IronPdfConnectionConfiguration