Interface IDicomClientConnection

Inherited Members
System.IDisposable.Dispose()
Namespace: FellowOakDicom.Network.Client
Assembly: fo-dicom.core.dll
Syntax
public interface IDicomClientConnection : IDisposable

Properties

CanStillProcessPDataTF

Gets whether or not the connection can still process P-DATA-TF This can be false when a previous P-DATA-TF timed out before it was sent completely In this scenario, the connection can only be used for control PDUs anymore

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

IsSendNextMessageRequired

Gets whether or not SendNextMessage is required, i.e. if any requests still have to be sent and there is no send loop currently running.

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

IsSendQueueEmpty

Gets whether or not the send queue is empty, i.e. if all requests are sent and handled

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

Listener

Gets the long running listener task that waits for incoming DICOM communication from the server.

Declaration
Task Listener { get; }
Property Value
Type Description
System.Threading.Tasks.Task

NetworkStream

Gets the network stream of this connection

Declaration
INetworkStream NetworkStream { get; }
Property Value
Type Description
INetworkStream

Methods

OnConnectionClosedAsync(Exception)

Callback when connection is closed.

Declaration
Task OnConnectionClosedAsync(Exception exception)
Parameters
Type Name Description
System.Exception exception

Exception, if any, that forced connection to close.
Returns
Type Description
System.Threading.Tasks.Task

OnCStoreRequestAsync(DicomCStoreRequest)

Callback for handling a client related C-STORE request, typically emanating from the client's C-GET request.

Declaration
Task<DicomResponse> OnCStoreRequestAsync(DicomCStoreRequest request)
Parameters
Type Name Description
DicomCStoreRequest request

C-STORE request.
Returns
Type Description
System.Threading.Tasks.Task<DicomResponse>

The DicomCStoreResponse related to the C-STORE request.

OnNEventReportRequestAsync(DicomNEventReportRequest)

Callback for handling a client related N-EVENT-REPORT-RQ request, typically emanating from the client's N-ACTION request.

Declaration
Task<DicomResponse> OnNEventReportRequestAsync(DicomNEventReportRequest request)
Parameters
Type Name Description
DicomNEventReportRequest request

N-EVENT-REPORT-RQ request.
Returns
Type Description
System.Threading.Tasks.Task<DicomResponse>

The DicomNEventReportResponse related to the N-EVENT-REPORT-RQ request.

OnReceiveAbortAsync(DicomAbortSource, DicomAbortReason)

Callback on receiving an abort message.

Declaration
Task OnReceiveAbortAsync(DicomAbortSource source, DicomAbortReason reason)
Parameters
Type Name Description
DicomAbortSource source

Abort source.
DicomAbortReason reason

Detailed reason for abort.
Returns
Type Description
System.Threading.Tasks.Task

OnReceiveAssociationAcceptAsync(DicomAssociation)

Callback for handling association accept scenarios.

Declaration
Task OnReceiveAssociationAcceptAsync(DicomAssociation association)
Parameters
Type Name Description
DicomAssociation association

Accepted association.
Returns
Type Description
System.Threading.Tasks.Task

OnReceiveAssociationRejectAsync(DicomRejectResult, DicomRejectSource, DicomRejectReason)

Callback for handling association reject scenarios.

Declaration
Task OnReceiveAssociationRejectAsync(DicomRejectResult result, DicomRejectSource source, DicomRejectReason reason)
Parameters
Type Name Description
DicomRejectResult result

Specification of rejection result.
DicomRejectSource source

Source of rejection.
DicomRejectReason reason

Detailed reason for rejection.
Returns
Type Description
System.Threading.Tasks.Task

OnReceiveAssociationReleaseResponseAsync()

Callback on response from an association release.

Declaration
Task OnReceiveAssociationReleaseResponseAsync()
Returns
Type Description
System.Threading.Tasks.Task

OnRequestCompletedAsync(DicomRequest, DicomResponse)

Callback when a request has been completed (a final response was received, causing it to be removed from the pending queue) One request can only receive one completed response

Declaration
Task OnRequestCompletedAsync(DicomRequest request, DicomResponse response)
Parameters
Type Name Description
DicomRequest request

The original request that was sent, which has now been fulfilled
DicomResponse response

The final response from the DICOM server
Returns
Type Description
System.Threading.Tasks.Task

OnRequestPendingAsync(DicomRequest, DicomResponse)

Callback when a request has received a pending response (this is not the final response, the request is still in the pending queue) One request can receive multiple pending responses

Declaration
Task OnRequestPendingAsync(DicomRequest request, DicomResponse response)
Parameters
Type Name Description
DicomRequest request

The original request that was sent
DicomResponse response

A pending response from the DICOM server
Returns
Type Description
System.Threading.Tasks.Task

OnRequestTimedOutAsync(DicomRequest, TimeSpan)

Callback when a request has timed out (no final response was received, but the timeout was exceeded and the request has been removed from the pending queue)

Declaration
Task OnRequestTimedOutAsync(DicomRequest request, TimeSpan timeout)
Parameters
Type Name Description
DicomRequest request

The original request that was sent, which could not be fulfilled
System.TimeSpan timeout

The timeout duration that has been exceeded
Returns
Type Description
System.Threading.Tasks.Task

SendAbortAsync(DicomAbortSource, DicomAbortReason)

Send abort request.

Declaration
Task SendAbortAsync(DicomAbortSource source, DicomAbortReason reason)
Parameters
Type Name Description
DicomAbortSource source

Abort source.
DicomAbortReason reason

Abort reason.
Returns
Type Description
System.Threading.Tasks.Task

SendAssociationReleaseRequestAsync()

Send association release request.

Declaration
Task SendAssociationReleaseRequestAsync()
Returns
Type Description
System.Threading.Tasks.Task

SendAssociationRequestAsync(DicomAssociation)

Send association request.

Declaration
Task SendAssociationRequestAsync(DicomAssociation association)
Parameters
Type Name Description
DicomAssociation association

DICOM association.
Returns
Type Description
System.Threading.Tasks.Task

SendNextMessageAsync()

Sometimes, DICOM requests can be enqueued but not immediately sent. This can happen for the following reasons: -- The same DicomService is already sending other requests -- The active association is temporarily saturated (too many open pending requests), see MaxAsyncOpsInvoked

Declaration
Task SendNextMessageAsync()
Returns
Type Description
System.Threading.Tasks.Task

SendRequestAsync(DicomRequest)

Send request from service.

Declaration
Task SendRequestAsync(DicomRequest request)
Parameters
Type Name Description
DicomRequest request

Request to send.
Returns
Type Description
System.Threading.Tasks.Task

StartListener()

Opens a long running listener task that waits for incoming DICOM communication

Declaration
void StartListener()

Extension Methods