Interface IDicomClient

Namespace: FellowOakDicom.Network.Client
Assembly: fo-dicom.core.dll
Syntax
public interface IDicomClient

Properties

AdditionalExtendedNegotiations

Gets or sets extended negotiation items to negotiate with association.

Declaration
List<DicomExtendedNegotiation> AdditionalExtendedNegotiations { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DicomExtendedNegotiation>

AdditionalPresentationContexts

Gets or sets additional presentation contexts to negotiate with association.

Declaration
List<DicomPresentationContext> AdditionalPresentationContexts { get; set; }
Property Value
Type Description
System.Collections.Generic.List<DicomPresentationContext>

CalledAe

Called Application Entity Title.

Declaration
string CalledAe { get; }
Property Value
Type Description
System.String

CallingAe

Calling Application Entity Title.

Declaration
string CallingAe { get; }
Property Value
Type Description
System.String

ClientOptions

Gets or sets options to control behavior of this DICOM client.

Declaration
DicomClientOptions ClientOptions { get; }
Property Value
Type Description
DicomClientOptions

FallbackEncoding

Gets or sets the fallback encoding.

Declaration
Encoding FallbackEncoding { get; set; }
Property Value
Type Description
System.Text.Encoding

Host

DICOM host.

Declaration
string Host { get; }
Property Value
Type Description
System.String

IsSendRequired

Gets whether a new send invocation is required. Send needs to be called if there are requests in queue and client is not connected.

Declaration
bool IsSendRequired { get; }
Property Value
Type Description
System.Boolean

Logger

Gets or sets the logger that will be used by this DicomClient

Declaration
ILogger Logger { get; set; }
Property Value
Type Description
Microsoft.Extensions.Logging.ILogger

OnCStoreRequest

Gets or sets the handler of a client C-STORE request.

Declaration
DicomClientCStoreRequestHandler OnCStoreRequest { get; set; }
Property Value
Type Description
DicomClientCStoreRequestHandler

OnNEventReportRequest

Gets or sets the handler of client N-EVENT-REPORT-RQ

Declaration
DicomClientNEventReportRequestHandler OnNEventReportRequest { get; set; }
Property Value
Type Description
DicomClientNEventReportRequestHandler

Port

Port.

Declaration
int Port { get; }
Property Value
Type Description
System.Int32

RequireSuccessfulUserIdentityNegotiation

Gets or sets whether to require a successful user identity negotiation during association.

Declaration
bool RequireSuccessfulUserIdentityNegotiation { get; set; }
Property Value
Type Description
System.Boolean

ServiceOptions

Gets or sets options to control behavior of DicomService base class.

Declaration
DicomServiceOptions ServiceOptions { get; }
Property Value
Type Description
DicomServiceOptions

TlsInitiator

A handler to initiate TLS security, if null then TLS is not enabled.

Declaration
ITlsInitiator TlsInitiator { get; }
Property Value
Type Description
ITlsInitiator

UserIdentityNegotiation

Gets or sets the user identity to negotiate with association.

Declaration
DicomUserIdentityNegotiation UserIdentityNegotiation { get; set; }
Property Value
Type Description
DicomUserIdentityNegotiation

Methods

AddRequestAsync(DicomRequest)

Enqueues a new DICOM request for execution.

Declaration
Task AddRequestAsync(DicomRequest dicomRequest)
Parameters
Type Name Description
DicomRequest dicomRequest

The DICOM request to send
Returns
Type Description
System.Threading.Tasks.Task

AddRequestsAsync(IEnumerable<DicomRequest>)

Enqueues new DICOM requests for execution. When you have many requests, this method is recommended over calling AddRequestAsync(DicomRequest) multiple times.

Declaration
Task AddRequestsAsync(IEnumerable<DicomRequest> dicomRequests)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<DicomRequest> dicomRequests

The DICOM requests to send
Returns
Type Description
System.Threading.Tasks.Task

NegotiateAsyncOps(Int32, Int32)

Set negotiation asynchronous operations.

Declaration
void NegotiateAsyncOps(int invoked = 0, int performed = 0)
Parameters
Type Name Description
System.Int32 invoked

Asynchronous operations invoked.
System.Int32 performed

Asynchronous operations performed.

NegotiateUserIdentity(DicomUserIdentityNegotiation)

Set negotiation of user identity.

Declaration
void NegotiateUserIdentity(DicomUserIdentityNegotiation userIdentityNegotiation)
Parameters
Type Name Description
DicomUserIdentityNegotiation userIdentityNegotiation

User identity negotiation information.

SendAsync(CancellationToken, DicomClientCancellationMode)

Sends existing requests to DICOM service. Note that subsequent calls, when the DICOM client is already sending its requests, will be completely ignored. If you want to cancel the process, be sure to cancel the cancellation token that was passed into the first call.

Declaration
Task SendAsync(CancellationToken cancellationToken = default(CancellationToken), DicomClientCancellationMode cancellationMode = DicomClientCancellationMode.ImmediatelyReleaseAssociation)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token that can abort the send process if necessary
DicomClientCancellationMode cancellationMode

The cancellation mode that determines the cancellation behavior
Returns
Type Description
System.Threading.Tasks.Task

Events

AssociationAccepted

Triggers when an association is accepted

Declaration
event EventHandler<AssociationAcceptedEventArgs> AssociationAccepted
Event Type
Type Description
System.EventHandler<AssociationAcceptedEventArgs>

AssociationRejected

Triggers when an association is rejected.

Declaration
event EventHandler<AssociationRejectedEventArgs> AssociationRejected
Event Type
Type Description
System.EventHandler<AssociationRejectedEventArgs>

AssociationReleased

Representation of the DICOM association released event.

Declaration
event EventHandler AssociationReleased
Event Type
Type Description
System.EventHandler

AssociationRequestTimedOut

Representation of the DICOM association request timed out event.

Declaration
event EventHandler<AssociationRequestTimedOutEventArgs> AssociationRequestTimedOut
Event Type
Type Description
System.EventHandler<AssociationRequestTimedOutEventArgs>

RequestTimedOut

Triggered when a DICOM request times out.

Declaration
event EventHandler<RequestTimedOutEventArgs> RequestTimedOut
Event Type
Type Description
System.EventHandler<RequestTimedOutEventArgs>

StateChanged

Whenever the DICOM client changes state, an event will be emitted containing the old state and the new state. The current DICOM client implementation is no longer state based, and has been rewritten as a wrapper around the new IAdvancedDicomClientConnection This event handler is still supported for backwards compatibility reasons, but may be removed in the future.

Declaration
[Obsolete("StateChanged is an artifact of an older state-based implementation of the DicomClient and will be deleted in the future. It only exists today for backwards compatibility purposes")]
event EventHandler<StateChangedEventArgs> StateChanged
Event Type
Type Description
System.EventHandler<StateChangedEventArgs>

Extension Methods