Table of Contents

Interface IDicomServer

Namespace
FellowOakDicom.Network
Assembly
fo-dicom.core.dll

Interface representing a DICOM server instance.

public interface IDicomServer : IDisposable
Inherited Members
Extension Methods

Properties

Exception

Gets the exception that was thrown if the server failed to listen.

Exception Exception { get; }

Property Value

Exception

IPAddress

Gets the IP address(es) the server listens to.

string IPAddress { get; }

Property Value

string

IsListening

Gets a value indicating whether the server is actively listening for client connections.

bool IsListening { get; }

Property Value

bool

Logger

Gets the logger used by DicomServer<T>

ILogger Logger { get; set; }

Property Value

ILogger

Options

Gets the options to control behavior of DicomService base class. Gets the port to which the server is listening.

DicomServiceOptions Options { get; }

Property Value

DicomServiceOptions

Port

Gets the port to which the server is listening.

int Port { get; }

Property Value

int

Registration

Gets the DICOM server registration ticket with the central registry. The registry prevents multiple DICOM servers from being created for the same IP address and port. This registration must be disposed alongside the DICOM server itself.

DicomServerRegistration Registration { get; set; }

Property Value

DicomServerRegistration

ServiceScope

Gets the service scope that will live as long as the DICOM server lives. Must be disposed alongside the DicomServer instance.

IServiceScope ServiceScope { get; set; }

Property Value

IServiceScope

Methods

StartAsync(string, int, ITlsAcceptor, Encoding, DicomServiceOptions, object, DicomServerOptions)

Starts the DICOM server listening for connections on the specified IP address(es) and port.

Task StartAsync(string ipAddress, int port, ITlsAcceptor tlsAcceptor, Encoding fallbackEncoding, DicomServiceOptions serviceOptions, object userState, DicomServerOptions serverOptions)

Parameters

ipAddress string

IP address(es) for the server to listen to.

port int

Port to which the server should be listening.

tlsAcceptor ITlsAcceptor

Handler to accept secure connections.

fallbackEncoding Encoding

Encoding to apply if no encoding is identified.

serviceOptions DicomServiceOptions

Service options

userState object

User state to be shared with the connected services.

serverOptions DicomServerOptions

Server options

Returns

Task

Awaitable Task.

Stop()

Stop server from further listening.

void Stop()