Interface IDicomServer

Interface representing a DICOM server instance.

Inherited Members

IDisposable.Dispose()

Namespace: Dicom.Network

Assembly: cs.temp.dll.dll

Syntax

public interface IDicomServer : IDisposable

Properties

Exception

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

Declaration

Exception Exception { get; }

Property Value

Type	Description
Exception

IPAddress

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

Declaration

string IPAddress { get; }

Property Value

Type	Description
String

IsListening

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

Declaration

bool IsListening { get; }

Property Value

Type	Description
Boolean

Logger

Gets the logger used by DicomServer<T>

Declaration

Logger Logger { get; set; }

Property Value

Type	Description
Logger

Options

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

Declaration

DicomServiceOptions Options { get; }

Property Value

Type	Description
DicomServiceOptions

Port

Gets the port to which the server is listening.

Declaration

int Port { get; }

Property Value

Type	Description
Int32

Methods

StartAsync(String, Int32, String, Encoding, DicomServiceOptions, Object)

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

Declaration

Task StartAsync(string ipAddress, int port, string certificateName, Encoding fallbackEncoding, DicomServiceOptions options, object userState)

Parameters

Type	Name	Description
String	ipAddress	IP address(es) for the server to listen to.
Int32	port	Port to which the servier should be litening.
String	certificateName	Certificate name for secure connections.
Encoding	fallbackEncoding	Encoding to apply if no encoding is identified.
DicomServiceOptions	options	Service options.
Object	userState	User state to be shared with the connected services.

Returns

Type	Description
Task	Awaitable .

Stop()

Stop server from further listening.

Declaration

void Stop()