Class DicomClient

Inheritance

System.Object

DicomClient

Implements

IDicomClient

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.Client

Assembly: fo-dicom.core.dll

Syntax

public class DicomClient : IDicomClient

Constructors

DicomClient(String, Int32, ITlsInitiator, String, String, DicomClientOptions, DicomServiceOptions, ILoggerFactory, IAdvancedDicomClientConnectionFactory)

Initializes an instance of DicomClient.

Declaration

public DicomClient(string host, int port, ITlsInitiator tlsInitiator, string callingAe, string calledAe, DicomClientOptions clientOptions, DicomServiceOptions serviceOptions, ILoggerFactory loggerFactory, IAdvancedDicomClientConnectionFactory advancedDicomClientConnectionFactory)

Parameters

Type	Name	Description
System.String	host	DICOM host.
System.Int32	port	Port.
ITlsInitiator	tlsInitiator	if null then no TLS is enabled, otherwise the handler to initiate TLS security.
System.String	callingAe	Calling Application Entity Title.
System.String	calledAe	Called Application Entity Title.
DicomClientOptions	clientOptions	The options that further modify the behavior of this DICOM client
DicomServiceOptions	serviceOptions	The options that modify the behavior of the base DICOM service
Microsoft.Extensions.Logging.ILoggerFactory	loggerFactory	The log manager that will be used to extract a default logger
IAdvancedDicomClientConnectionFactory	advancedDicomClientConnectionFactory	The advanced DICOM client factory that will be used to actually send the requests

Properties

AdditionalExtendedNegotiations

Declaration

public List<DicomExtendedNegotiation> AdditionalExtendedNegotiations { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<DicomExtendedNegotiation>

AdditionalPresentationContexts

Declaration

public List<DicomPresentationContext> AdditionalPresentationContexts { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<DicomPresentationContext>

CalledAe

Declaration

public string CalledAe { get; }

Property Value

Type	Description
System.String

CallingAe

Declaration

public string CallingAe { get; }

Property Value

Type	Description
System.String

ClientOptions

Declaration

public DicomClientOptions ClientOptions { get; set; }

Property Value

Type	Description
DicomClientOptions

FallbackEncoding

Declaration

public Encoding FallbackEncoding { get; set; }

Property Value

Type	Description
System.Text.Encoding

Host

Declaration

public string Host { get; }

Property Value

Type	Description
System.String

IsSendRequired

Declaration

public bool IsSendRequired { get; }

Property Value

Type	Description
System.Boolean

Logger

Declaration

public ILogger Logger { get; set; }

Property Value

Type	Description
Microsoft.Extensions.Logging.ILogger

OnCStoreRequest

Declaration

public DicomClientCStoreRequestHandler OnCStoreRequest { get; set; }

Property Value

Type	Description
DicomClientCStoreRequestHandler

OnNEventReportRequest

Declaration

public DicomClientNEventReportRequestHandler OnNEventReportRequest { get; set; }

Property Value

Type	Description
DicomClientNEventReportRequestHandler

Port

Declaration

public int Port { get; }

Property Value

Type	Description
System.Int32

RequireSuccessfulUserIdentityNegotiation

Declaration

public bool RequireSuccessfulUserIdentityNegotiation { get; set; }

Property Value

Type	Description
System.Boolean

ServiceOptions

Declaration

public DicomServiceOptions ServiceOptions { get; set; }

Property Value

Type	Description
DicomServiceOptions

TlsInitiator

Declaration

public ITlsInitiator TlsInitiator { get; }

Property Value

Type	Description
ITlsInitiator

UserIdentityNegotiation

Declaration

public DicomUserIdentityNegotiation UserIdentityNegotiation { get; set; }

Property Value

Type	Description
DicomUserIdentityNegotiation

Methods

AddRequestAsync(DicomRequest)

Declaration

public Task AddRequestAsync(DicomRequest dicomRequest)

Parameters

Type	Name	Description
DicomRequest	dicomRequest

Returns

Type	Description
System.Threading.Tasks.Task

AddRequestsAsync(IEnumerable<DicomRequest>)

Declaration

public Task AddRequestsAsync(IEnumerable<DicomRequest> dicomRequests)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<DicomRequest>	dicomRequests

Returns

Type	Description
System.Threading.Tasks.Task

NegotiateAsyncOps(Int32, Int32)

Declaration

public void NegotiateAsyncOps(int invoked = 0, int performed = 0)

Parameters

Type	Name	Description
System.Int32	invoked
System.Int32	performed

NegotiateUserIdentity(DicomUserIdentityNegotiation)

Declaration

public void NegotiateUserIdentity(DicomUserIdentityNegotiation userIdentity)

Parameters

Type	Name	Description
DicomUserIdentityNegotiation	userIdentity

SendAsync(CancellationToken, DicomClientCancellationMode)

Declaration

public async Task SendAsync(CancellationToken cancellationToken = default(CancellationToken), DicomClientCancellationMode cancellationMode = DicomClientCancellationMode.ImmediatelyReleaseAssociation)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken
DicomClientCancellationMode	cancellationMode

Returns

Type	Description
System.Threading.Tasks.Task

Events

AssociationAccepted

Declaration

public event EventHandler<AssociationAcceptedEventArgs> AssociationAccepted

Event Type

Type	Description
System.EventHandler<AssociationAcceptedEventArgs>

AssociationRejected

Declaration

public event EventHandler<AssociationRejectedEventArgs> AssociationRejected

Event Type

Type	Description
System.EventHandler<AssociationRejectedEventArgs>

AssociationReleased

Declaration

public event EventHandler AssociationReleased

Event Type

Type	Description
System.EventHandler

AssociationRequestTimedOut

Declaration

public event EventHandler<AssociationRequestTimedOutEventArgs> AssociationRequestTimedOut

Event Type

Type	Description
System.EventHandler<AssociationRequestTimedOutEventArgs>

RequestTimedOut

Declaration

public event EventHandler<RequestTimedOutEventArgs> RequestTimedOut

Event Type

Type	Description
System.EventHandler<RequestTimedOutEventArgs>

StateChanged

Declaration

public event EventHandler<StateChangedEventArgs> StateChanged

Event Type

Type	Description
System.EventHandler<StateChangedEventArgs>

Implements

IDicomClient

Extension Methods

LinqExtensions.IsOneOf<T>(T, T[])