Class DicomServerFactory

Inheritance

System.Object

DicomServerFactory

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: FellowOakDicom.Network

Assembly: fo-dicom.core.dll

Syntax

public static class DicomServerFactory

Methods

Create<T>(Int32, ITlsAcceptor, Encoding, ILogger, Object, Action<DicomServerOptions>)

Creates a DICOM server object out of DI-container.

Declaration

public static IDicomServer Create<T>(int port, ITlsAcceptor tlsAcceptor = null, Encoding fallbackEncoding = null, ILogger logger = null, object userState = null, Action<DicomServerOptions> configure = null)
    where T : DicomService, IDicomServiceProvider

Parameters

Type	Name	Description
System.Int32	port	Port to listen to.
ITlsAcceptor	tlsAcceptor	Handler to accept authenticated connections.
System.Text.Encoding	fallbackEncoding	Fallback encoding.
Microsoft.Extensions.Logging.ILogger	logger	Logger, if null default logger will be applied.
System.Object	userState	Optional parameters
System.Action<DicomServerOptions>	configure	Configures the service options of the newly created DICOM server

Returns

Type	Description
IDicomServer	An instance of DicomServer<T>, that starts listening for connections in the background.

Type Parameters

Name	Description
T	DICOM service that the server should manage.

Create<T>(String, Int32, ITlsAcceptor, Encoding, ILogger, Object, Action<DicomServerOptions>)

Creates a DICOM server object out of DI-container.

Declaration

public static IDicomServer Create<T>(string ipAddress, int port, ITlsAcceptor tlsAcceptor = null, Encoding fallbackEncoding = null, ILogger logger = null, object userState = null, Action<DicomServerOptions> configure = null)
    where T : DicomService, IDicomServiceProvider

Parameters

Type	Name	Description
System.String	ipAddress	IP address(es) to listen to. Value null applies default, IPv4Any.
System.Int32	port	Port to listen to.
ITlsAcceptor	tlsAcceptor	Handler to accept authenticated connections.
System.Text.Encoding	fallbackEncoding	Fallback encoding.
Microsoft.Extensions.Logging.ILogger	logger	Logger, if null default logger will be applied.
System.Object	userState	Optional parameters
System.Action<DicomServerOptions>	configure	Configures the service options of the newly created DICOM server

Returns

Type	Description
IDicomServer	An instance of DicomServer<T>, that starts listening for connections in the background.

Type Parameters

Name	Description
T	DICOM service that the server should manage.

Create<T, TServer>(String, Int32, Object, ITlsAcceptor, Encoding, ILogger, Action<DicomServerOptions>)

Creates a DICOM server object out of DI-container.

Declaration

public static IDicomServer Create<T, TServer>(string ipAddress, int port, object userState = null, ITlsAcceptor tlsAcceptor = null, Encoding fallbackEncoding = null, ILogger logger = null, Action<DicomServerOptions> configure = null)
    where T : DicomService, IDicomServiceProvider where TServer : IDicomServer<T>

Parameters

Type	Name	Description
System.String	ipAddress	IP address(es) to listen to. Value null applies default, IPv4Any.
System.Int32	port	Port to listen to.
System.Object	userState	Optional optional parameters.
ITlsAcceptor	tlsAcceptor	Handler to accept authenticated connections.
System.Text.Encoding	fallbackEncoding	Fallback encoding.
Microsoft.Extensions.Logging.ILogger	logger	Logger, if null default logger will be applied.
System.Action<DicomServerOptions>	configure	Configures the service options of the newly created DICOM server

Returns

Type	Description
IDicomServer	An instance of TServer, that starts listening for connections in the background.

Type Parameters

Name	Description
T	DICOM service that the server should manage.
TServer	Concrete DICOM server type to be returned.