Class DicomClient

General client class for DICOM services.

Inheritance

Object

DicomClient

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Dicom.Network

Assembly: cs.temp.dll.dll

Syntax

[Obsolete("Use Dicom.Network.Client.DicomClient instead")]
public class DicomClient

Constructors

DicomClient()

Initializes an instance of DicomClient.

Declaration

[Obsolete("Use Dicom.Network.Client.DicomClient instead")]
public DicomClient()

Properties

AdditionalPresentationContexts

Gets or sets additional presentation contexts to negotiate with association.

Declaration

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

Property Value

Type	Description
List<DicomPresentationContext>

CanSend

Gets whether send functionality is activated or not.

Declaration

public bool CanSend { get; }

Property Value

Type	Description
Boolean

FallbackEncoding

Gets or sets the fallback encoding.

Declaration

public Encoding FallbackEncoding { get; set; }

Property Value

Type	Description
Encoding

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

public bool IsSendRequired { get; }

Property Value

Type	Description
Boolean

Linger

Gets or sets time in milliseconds to keep connection alive for additional requests.

Declaration

public int Linger { get; set; }

Property Value

Type	Description
Int32

Logger

Gets or sets logger that is passed to the underlying DicomService implementation.

Declaration

public Logger Logger { get; set; }

Property Value

Type	Description
Logger

OnCStoreRequest

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

Declaration

public CStoreRequestHandler OnCStoreRequest { get; set; }

Property Value

Type	Description
CStoreRequestHandler

Options

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

Declaration

public DicomServiceOptions Options { get; set; }

Property Value

Type	Description
DicomServiceOptions

Methods

Abort()

Abort DICOM service connection.

Declaration

public void Abort()

AbortAsync()

Asynchronously abort DICOM service connection.

Declaration

public async Task AbortAsync()

Returns

Type	Description
Task

AddRequest(DicomRequest)

Add DICOM service request.

Declaration

public void AddRequest(DicomRequest request)

Parameters

Type	Name	Description
DicomRequest	request	DICOM request.

NegotiateAsyncOps(Int32, Int32)

Set negotiation asynchronous operations.

Declaration

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

Parameters

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

Release(Int32)

Synchronously release association.

Declaration

[Obsolete("Use Dicom.Network.Client.DicomClient instead")]
public void Release(int millisecondsTimeout = 10000)

Parameters

Type	Name	Description
Int32	millisecondsTimeout

ReleaseAsync(Int32)

Asynchronously release association.

Declaration

[Obsolete("Use Dicom.Network.Client.DicomClient instead")]
public async Task ReleaseAsync(int millisecondsTimeout = 10000)

Parameters

Type	Name	Description
Int32	millisecondsTimeout

Returns

Type	Description
Task

Send(INetworkStream, String, String, Int32)

Synchronously send existing requests to DICOM service.

Declaration

[Obsolete("Use Dicom.Network.Client.DicomClient instead")]
public void Send(INetworkStream stream, string callingAe, string calledAe, int millisecondsTimeout = 5000)

Parameters

Type	Name	Description
INetworkStream	stream	Established network stream.
String	callingAe	Calling Application Entity Title.
String	calledAe	Called Application Entity Title.
Int32	millisecondsTimeout	Timeout in milliseconds for establishing association.

Send(String, Int32, Boolean, String, String, Int32)

Synchronously send existing requests to DICOM service.

Declaration

[Obsolete("Use Dicom.Network.Client.DicomClient instead")]
public void Send(string host, int port, bool useTls, string callingAe, string calledAe, int millisecondsTimeout = 5000)

Parameters

Type	Name	Description
String	host	DICOM host.
Int32	port	Port.
Boolean	useTls	True if TLS security should be enabled, false otherwise.
String	callingAe	Calling Application Entity Title.
String	calledAe	Called Application Entity Title.
Int32	millisecondsTimeout	Timeout in milliseconds for establishing association.

SendAsync(INetworkStream, String, String, Int32)

Asynchronously send existing requests to DICOM service.

Declaration

[Obsolete("Use Dicom.Network.Client.DicomClient instead")]
public Task SendAsync(INetworkStream stream, string callingAe, string calledAe, int millisecondsTimeout = 5000)

Parameters

Type	Name	Description
INetworkStream	stream	Established network stream.
String	callingAe	Calling Application Entity Title.
String	calledAe	Called Application Entity Title.
Int32	millisecondsTimeout	Timeout in milliseconds for establishing association.

Returns

Type	Description
Task	Awaitable task.

SendAsync(String, Int32, Boolean, String, String, Int32)

Asynchonously send existing requests to DICOM service.

Declaration

[Obsolete("Use Dicom.Network.Client.DicomClient instead")]
public Task SendAsync(string host, int port, bool useTls, string callingAe, string calledAe, int millisecondsTimeout = 5000)

Parameters

Type	Name	Description
String	host	DICOM host.
Int32	port	Port.
Boolean	useTls	True if TLS security should be enabled, false otherwise.
String	callingAe	Calling Application Entity Title.
String	calledAe	Called Application Entity Title.
Int32	millisecondsTimeout	Timeout in milliseconds for establishing association.

Returns

Type	Description
Task	Awaitable task.

WaitForAssociation(Int32)

Synchronously wait for association.

Declaration

[Obsolete("Use AssociationAccepted and AssociationRejected events to be notified of association status change.")]
public bool WaitForAssociation(int millisecondsTimeout = 5000)

Parameters

Type	Name	Description
Int32	millisecondsTimeout	Milliseconds to wait for association to occur.

Returns

Type	Description
Boolean	True if association is established, false otherwise.

WaitForAssociationAsync(Int32)

Asynchronously wait for association.

Declaration

[Obsolete("Use AssociationAccepted and AssociationRejected events to be notified of association status change.")]
public async Task<bool> WaitForAssociationAsync(int millisecondsTimeout = 5000)

Parameters

Type	Name	Description
Int32	millisecondsTimeout	Milliseconds to wait for association to occur.

Returns

Type	Description
Task<Boolean>	True if association is established, false otherwise.

Events

AssociationAccepted

Representation of the DICOM association accepted event.

Declaration

public event EventHandler<AssociationAcceptedEventArgs> AssociationAccepted

Event Type

Type	Description
EventHandler<AssociationAcceptedEventArgs>

AssociationRejected

Representation of the DICOM association rejected event.

Declaration

public event EventHandler<AssociationRejectedEventArgs> AssociationRejected

Event Type

Type	Description
EventHandler<AssociationRejectedEventArgs>

AssociationReleased

Representation of the DICOM association released event.

Declaration

public event EventHandler AssociationReleased

Event Type

Type	Description
EventHandler