Interface IDicomServer
Interface representing a DICOM server instance.
Inherited Members
Namespace: FellowOakDicom.Network
Assembly: fo-dicom.core.dll
Syntax
public interface IDicomServer : IDisposableProperties
Exception
Gets the exception that was thrown if the server failed to listen.
Declaration
Exception Exception { get; }Property Value
| Type | Description |
|---|---|
| System.Exception |
IPAddress
Gets the IP address(es) the server listens to.
Declaration
string IPAddress { get; }Property Value
| Type | Description |
|---|---|
| System.String |
IsListening
Gets a value indicating whether the server is actively listening for client connections.
Declaration
bool IsListening { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Logger
Gets the logger used by DicomServer<T>
Declaration
ILogger Logger { get; set; }Property Value
| Type | Description |
|---|---|
| Microsoft.Extensions.Logging.ILogger |
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 |
|---|---|
| System.Int32 |
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.
Declaration
DicomServerRegistration Registration { get; set; }Property Value
| Type | Description |
|---|---|
| DicomServerRegistration |
ServiceScope
Gets the service scope that will live as long as the DICOM server lives. Must be disposed alongside the DicomServer instance.
Declaration
IServiceScope ServiceScope { get; set; }Property Value
| Type | Description |
|---|---|
| Microsoft.Extensions.DependencyInjection.IServiceScope |
Methods
StartAsync(String, Int32, ITlsAcceptor, Encoding, DicomServiceOptions, Object, DicomServerOptions)
Starts the DICOM server listening for connections on the specified IP address(es) and port.
Declaration
Task StartAsync(string ipAddress, int port, ITlsAcceptor tlsAcceptor, Encoding fallbackEncoding, DicomServiceOptions serviceOptions, object userState, DicomServerOptions serverOptions)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | ipAddress | IP address(es) for the server to listen to. |
| System.Int32 | port | Port to which the server should be listening. |
| ITlsAcceptor | tlsAcceptor | Handler to accept secure connections. |
| System.Text.Encoding | fallbackEncoding | Encoding to apply if no encoding is identified. |
| DicomServiceOptions | serviceOptions | Service options |
| System.Object | userState | User state to be shared with the connected services. |
| DicomServerOptions | serverOptions | Server options |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Awaitable System.Threading.Tasks.Task. |
Stop()
Stop server from further listening.
Declaration
void Stop()