Interface IDicomClient

Namespace: Dicom.Network.Client

Assembly: cs.temp.dll.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
List<DicomExtendedNegotiation>

AdditionalPresentationContexts

Gets or sets additional presentation contexts to negotiate with association.

Declaration

List<DicomPresentationContext> AdditionalPresentationContexts { get; set; }

Property Value

Type	Description
List<DicomPresentationContext>

AssociationLingerTimeoutInMs

Gets or sets the timeout (in ms) that associations need to be held open after all requests have been processed

Declaration

int AssociationLingerTimeoutInMs { get; }

Property Value

Type	Description
Int32

AssociationReleaseTimeoutInMs

Gets or sets the timeout (in ms) to wait for an association release response after sending an association release request

Declaration

int AssociationReleaseTimeoutInMs { get; }

Property Value

Type	Description
Int32

AssociationRequestTimeoutInMs

Gets or sets the timeout (in ms) to wait for an association response after sending an association request

Declaration

int AssociationRequestTimeoutInMs { get; }

Property Value

Type	Description
Int32

CalledAe

Called Application Entity Title.

Declaration

string CalledAe { get; }

Property Value

Type	Description
String

CallingAe

Calling Application Entity Title.

Declaration

string CallingAe { get; }

Property Value

Type	Description
String

FallbackEncoding

Gets or sets the fallback encoding.

Declaration

Encoding FallbackEncoding { get; set; }

Property Value

Type	Description
Encoding

Host

DICOM host.

Declaration

string Host { get; }

Property Value

Type	Description
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
Boolean

Logger

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

Declaration

Logger Logger { get; set; }

Property Value

Type	Description
Logger

MaximumNumberOfRequestsPerAssociation

Gets the maximum number of DICOM requests that are allowed to be sent over one single association. When this limit is reached, the DICOM client will wait for pending requests to complete, and then open a new association to send the remaining requests, if any.

Declaration

int? MaximumNumberOfRequestsPerAssociation { get; }

Property Value

Type	Description
Nullable<Int32>

NetworkManager

Gets or sets the network manager that will be used to open connections.

Declaration

NetworkManager NetworkManager { get; set; }

Property Value

Type	Description
NetworkManager

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

Options

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

Declaration

DicomServiceOptions Options { get; set; }

Property Value

Type	Description
DicomServiceOptions

Port

Port.

Declaration

int Port { get; }

Property Value

Type	Description
Int32

UseTls

True if TLS security should be enabled, false otherwise.

Declaration

bool UseTls { get; }

Property Value

Type	Description
Boolean

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
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
IEnumerable<DicomRequest>	dicomRequests	The DICOM requests to send

Returns

Type	Description
Task

NegotiateAsyncOps(Int32, Int32)

Set negotiation asynchronous operations.

Declaration

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

Parameters

Type	Name	Description
Int32	invoked	Asynchronous operations invoked.
Int32	performed	Asynchronous operations performed.

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 = null, DicomClientCancellationMode cancellationMode = DicomClientCancellationMode.ImmediatelyReleaseAssociation)

Parameters

Type	Name	Description
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
Task

Events

AssociationAccepted

Triggers when an association is accepted

Declaration

event EventHandler<AssociationAcceptedEventArgs> AssociationAccepted

Event Type

Type	Description
EventHandler<AssociationAcceptedEventArgs>

AssociationRejected

Triggers when an association is rejected.

Declaration

event EventHandler<AssociationRejectedEventArgs> AssociationRejected

Event Type

Type	Description
EventHandler<AssociationRejectedEventArgs>

AssociationReleased

Representation of the DICOM association released event.

Declaration

event EventHandler AssociationReleased

Event Type

Type	Description
EventHandler

RequestTimedOut

Triggered when a DICOM request times out.

Declaration

event EventHandler<RequestTimedOutEventArgs> RequestTimedOut

Event Type

Type	Description
EventHandler<RequestTimedOutEventArgs>

StateChanged

Whenever the DICOM client changes state, an event will be emitted containing the old state and the new state.

Declaration

event EventHandler<StateChangedEventArgs> StateChanged

Event Type

Type	Description
EventHandler<StateChangedEventArgs>