←Select platform

DicomConnection Class Members

Summary

The following tables list the members exposed by DicomConnection.

Public Constructors

Name Description
Public Constructor DicomConnection Initializes a new instance of the DicomConnection class.
Public Constructor DicomNet Initializes a new instance of the DicomNet class. (Inherited from DicomNet)

Public Methods

Name Description
Public Method AbortRequest Aborts the current connection.
Public Method Accept Accepts a connection request from an SCU. (Inherited from DicomNet)
Public Method static  | Shared in VB Breathe For Windows platforms, this implements a standard Windows Message pump. (Inherited from DicomNet)
Public Method Cancel Causes the DicomConnection to immediately stop processing.
Public Method CancelRequest Cancels the current action.
Public Method Close Closes the connection between an associated SCU and SCP. (Inherited from DicomNet)
Public Method CloseForced Closes an ISCL connection. (Inherited from DicomNet)
Public Method GetClient Returns the DICOM Network object of the SCU at the specified index. (Inherited from DicomNet)
Public Method GetClientCount Returns the number of SCUs connected to the SCP. (Inherited from DicomNet)
Public Method GetCommandSet Returns a DicomDataSet containing the Command Set portion of a DIMSE DICOM message. (Inherited from DicomNet)
Public Method GetIsclCommunicationBlockLength Returns the communication block length agreed upon during mutual authentication. (Inherited from DicomNet)
Public Method GetIsclIndexForEncryption Gets the index of the encryption key used for encryption. (Inherited from DicomNet)
Public Method GetIsclIndexForMutualAuthentication Gets the index of the mutual authentication key used during the mutual authentication process. (Inherited from DicomNet)
Public Method GetIsclPeerAuthenticationData Gets the authentication data the peer computer sent during mutual authentication. (Inherited from DicomNet)
Public Method GetIsclPeerEncryption Returns the encryption mode the sender used when sending a message. (Inherited from DicomNet)
Public Method GetIsclPeerMac Returns the MAC type the sender used when sending a message. (Inherited from DicomNet)
Public Method GetIsclPeerRequestedMessageLength Gets the length of the message sent unsuccessfully by a peer computer. (Inherited from DicomNet)
Public Method GetIsclStatus Returns the internal ISCL status when an error occurs. (Inherited from DicomNet)
Public Method GetLastIsclOrTlsError Returns the code of the last occurring ISCL or TLS error. (Inherited from DicomNet)
Public Method static  | Shared in VB GetOpenSslVersion Gets information about the availability and version of the OpenSSL libraries (Inherited from DicomNet)
Public Method GetQueueSend Returns the number of bytes in the send queue. (Inherited from DicomNet)
Public Method GetServer Returns the DICOM Network object of the SCP. (Inherited from DicomNet)
Public Method GetTlsAuthenticationAlgorithm Returns the mutual authentication mode or algorithm for the specified cipher suite. (Inherited from DicomNet)
Public Method GetTlsCipherSuite Returns the cipher suite agreed upon during the TLS protocol. (Inherited from DicomNet)
Public Method GetTlsCipherSuiteByIndex Returns the cipher suite present at the specified index. (Inherited from DicomNet)
Public Method GetTlsEncryptionAlgorithm Returns the encryption mode (DES, 3DES, etc.) for the specified cipher suite. (Inherited from DicomNet)
Public Method GetTlsEncryptionKeyLength Returns the effective length, in bits, of the encryption key associated with the specified cipher suite (56 for DES, etc.). (Inherited from DicomNet)
Public Method GetTlsIntegrityAlgorithm Returns the Message Authentication Code (MAC) algorithm for the specified cipher suite. (Inherited from DicomNet)
Public Method GetTlsKeyExchangeAlgorithm Returns the key exchange algorithm for the specified cipher suite. (Inherited from DicomNet)
Public Method GetTlsMutualAuthenticationKeyLength Returns the effective length, in bits, of the mutual authentication key associated with the specified cipher suite. (Inherited from DicomNet)
Public Method Initialize Changes security options from the defaults. (Inherited from DicomNet)
Public Method IsActivated Determines whether the connection has been activated. (Inherited from DicomNet)
Public Method IsAssociated Determines whether the connection has been associated. (Inherited from DicomNet)
Public Method IsConnected Determines whether a connection has been established. (Inherited from DicomNet)
Public Method IsIsclQueueEmpty Determines whether the ISCL transmission queue is empty. (Inherited from DicomNet)
Public Method Listen Establishes a connection to listen for incoming connection requests. (Inherited from DicomNet)
Public Method Release Sends a release request to the peer member of a DICOM connection.
Public Method SendAbort Sends an Abort message to a connection. (Inherited from DicomNet)
Public Method SendAssociateAccept Sends an Associate Accept message to a connection. (Inherited from DicomNet)
Public Method SendAssociateReject Sends an Associate Reject message to a connection. (Inherited from DicomNet)
Public Method SendAssociateRequest Sends an Associate Request message to a connection. (Inherited from DicomNet)
Public Method SendCCancelRequest Sends a C-CANCEL-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCEchoRequest Sends a C-ECHO-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCEchoResponse Sends a C-ECHO-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCFindRequest Sends a C-FIND-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCFindResponse Sends a C-FIND-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCGetRequest Sends a C-GET-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCGetResponse Sends a C-GET-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCMoveRequest Sends a C-MOVE-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCMoveResponse Sends a C-MOVE-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCStoreRequest Sends a C-STORE-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendCStoreResponse Sends a C-STORE-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendData Sends a Data message to a connection. (Inherited from DicomNet)
Public Method SendNActionRequest Sends an N-ACTION-REQ message to a peer member of a connection (Inherited from DicomNet)
Public Method SendNActionResponse Sends an N-ACTION-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNCreateRequest Sends an N-CREATE-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNCreateResponse Sends an N-CREATE-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNDeleteRequest Sends an N-DELETE-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNDeleteResponse Sends an N-DELETE-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNGetRequest Sends an N-GET-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNGetResponse Sends an N-GET-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNonSecureIscl Sends data over an ISCL connection, unsecured. The data is not encrypted and the message has no authentication code. (Inherited from DicomNet)
Public Method SendNReportRequest Sends an N-EVENT-REPORT-REQ message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNReportResponse Sends an N-EVENT-REPORT-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNSetRequest Sends an N-GET-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendNSetResponse Sends an N-SET-RSP message to a peer member of a connection. (Inherited from DicomNet)
Public Method SendReleaseRequest Sends a Release Request message to a connection. (Inherited from DicomNet)
Public Method SendReleaseResponse Sends a Release Response message to a connection. (Inherited from DicomNet)
Public Method ServerClose Closes a client DicomNet in a multi-threaded environment. (Inherited from DicomNet)
Public Method SetIsclAuthenticationData Sets the authentication data used during the mutual authentication process. (Inherited from DicomNet)
Public Method SetIsclDefaultEncryptionMode Sets the encryption mode used by the ISCL operations. (Inherited from DicomNet)
Public Method SetIsclDefaultSigningMode Sets the current message authentication code (MAC) type. (Inherited from DicomNet)
Public Method SetIsclEncryptionKey Sets an encryption key at the specified index in the array of encryption keys. (Inherited from DicomNet)
Public Method SetIsclEncryptionKeyIndex Sets the index of the encryption key to be used for encryption. (Inherited from DicomNet)
Public Method SetIsclIndexForMutualAuthentication Sets the index of the mutual authentication key to be used during the mutual authentication process. (Inherited from DicomNet)
Public Method SetIsclMaxCommunicationBlockLength Sets the maximum communication block length that can be sent/received by the current entity. (Inherited from DicomNet)
Public Method SetIsclMaxMessageLength Sets the maximum message length that can be processed (sent and received) by the current entity. (Inherited from DicomNet)
Public Method SetIsclMutualAuthenticationAlgorithm Sets the mutual authentication mode. (Inherited from DicomNet)
Public Method SetIsclMutualAuthenticationKey Sets a mutual authentication key at the specified index in the array of authentication keys. (Inherited from DicomNet)
Public Method SetTlsCipherSuiteByIndex Sets the cipher suite for the specified index. (Inherited from DicomNet)
Public Method SetTlsClientCertificate Sets a certificate for the client. (Inherited from DicomNet)
Public Method static  | Shared in VB Shutdown Shuts down the LEADTOOLS DICOM DLL. (Inherited from DicomNet)
Public Method static  | Shared in VB Startup Initializes the LEADTOOLS DICOM DLL. (Inherited from DicomNet)
Public Method Verify Verifies the specified SCP.

Protected Methods

Name Description
Protected Method BuildAssociation Builds the association.
Protected Method Connect Connects the specified SCP.
Protected Method Dispose Releases unmanaged and - optionally - managed resources
Protected Method Dispose(bool) Releases all resources used by the DicomNet. (Inherited from DicomNet)
Protected Method ExternalAuthenticateIscl Determines whether the response code is a valid response for the challenge code. (Inherited from DicomNet)
Protected Method Finalize This member overrides Finalize. (Inherited from DicomNet)
Protected Method GetChallengeIscl Generates a random number. (Inherited from DicomNet)
Protected Method GetPresentationContexts Gets the presentation contexts. Should be overridden in derived classes.
Protected Method InternalAuthenticateIscl Generates a response code, based on the specified challenge code. (Inherited from DicomNet)
Protected Method Log Logs the specified message to a text file.
Protected Method LogSendAssociateRequest Logs the SendAssociateRequest message.
Protected Method LogSendCGetRequest Logs the C-GET-REQ message
Protected Method LogSendCMoveRequest Logs the C-MOVE-REQ message.
Protected Method OnAccept Notifies a listening connection (SCP) that it can accept pending connection requests. (Inherited from DicomNet)
Protected Method OnAfterAssociateRequest Fires the AfterAssociateRequest event.
Protected Method OnAfterClose Fires the AfterClose event.
Protected Method OnBeforeAssociateAccept Called before an associate accept is accepted by the SCU.
Protected Method OnBeforeAssociateRequest Fires the BeforeAssociateRequest event.
Protected Method OnBeforeClose Fires the BeforeClose event.
Protected Method OnBeforeSendCommandSet Notifies a connection before the Command Set portion of a DIMSE DicomNet:SendXxxResponse is transmitted. (Inherited from DicomNet)
Protected Method OnClose Notifies a member of a connection that the connection was closed.
Protected Method OnConnect Notifies the SCU that the connection attempt is complete.
Protected Method OnNonSecureReceivedIscl This method is called after data sent in non-secure mode is received. (Inherited from DicomNet)
Protected Method OnNonSecureSendIscl This method is called after data has been sent using the SendNonSecureIscl method. (Inherited from DicomNet)
Protected Method OnPrivateKeyPassword Invokes the private PrivateKeyPassword event.
Protected Method OnReceive Notifies a connection that data was received.
Protected Method OnReceiveAbort Notifies a connection that an Abort message was received. (Inherited from DicomNet)
Protected Method OnReceiveAssociateAccept Notifies a connection that an Associate Accept message was received.
Protected Method OnReceiveAssociateReject Notifies a connection that an Associate Reject message was received.
Protected Method OnReceiveAssociateRequest Notifies a connection that an Associate Request message was received. (Inherited from DicomNet)
Protected Method OnReceiveCCancelRequest Notifies a connection that a C-CANCEL-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveCEchoRequest Notifies a connection that a C-ECHO-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveCEchoResponse Notifies a connection that a C-ECHO-RSP command was received.
Protected Method OnReceiveCFindRequest Notifies a connection that a C-FIND-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveCFindResponse Notifies a connection that a C-FIND-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveCGetRequest Notifies a connection that a C-GET-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveCGetResponse Notifies a connection that a C-GET-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveCMoveRequest Notifies a connection that a C-MOVE-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveCMoveResponse Notifies a connection that a C-MOVE-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveCStoreRequest Notifies a connection that a C-STORE-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveCStoreResponse Notifies a connection that a C-STORE-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveData Notifies a connection when a Data message was received.
Protected Method OnReceivedISCLPacket Notifies a connection when a Data message is received in ISCL mode. (Inherited from DicomNet)
Protected Method OnReceiveNActionRequest Notifies a connection that an N-ACTION-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveNActionResponse Notifies a connection that an N-ACTION-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveNCreateRequest Notifies a connection that an N-CREATE-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveNCreateResponse Notifies a connection that an N-CREATE-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveNDeleteRequest Notifies a connection that an N-DELETE-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveNDeleteResponse Notifies a connection that an N-DELETE-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveNGetRequest Notifies a connection that an N-GET-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveNGetResponse Notifies a connection that an N-GET-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveNReportRequest Notifies a connection that an N-EVENT-REPORT-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveNReportResponse Notifies a connection that an N-EVENT-REPORT-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveNSetRequest Notifies a connection that an N-SET-REQ command was received. (Inherited from DicomNet)
Protected Method OnReceiveNSetResponse Notifies a connection that an N-SET-RSP command was received. (Inherited from DicomNet)
Protected Method OnReceiveReleaseRequest Notifies a connection that a Release Request message was received. (Inherited from DicomNet)
Protected Method OnReceiveReleaseResponse Notifies a connection that a Release Response message was received.
Protected Method OnReceiveUnknown Notifies a connection that an unknown command was received. (Inherited from DicomNet)
Protected Method OnSecureLinkReady This method is called when an ISCL or TLS secured connection is successfully established.
Protected Method OnSend Notifies a connection that data was sent. (Inherited from DicomNet)
Protected Method OnVerify Invokes the VerifyCertificate event.
Protected Method Wait Waits for the DICOM communication to finish.

Public Properties

Name Description
Public Property AETitle Gets or sets the AE title.
Public Property Association Gets the DICOM Association for the DICOM Network object. (Inherited from DicomNet)
Public Property CurrentScp Gets the current SCP this is connected to.
Public Property DebugLogFilename Gets or sets the debug log filename.
Public Property DefaultSocketOptions Gets the default DICOM socket options. (Inherited from DicomNet)
Public Property EnableDebugLog Gets or sets a value indicating whether to enable the DICOM debug log.
Public Property Flags Get or set options for DICOM communication. (Inherited from DicomNet)
Public Property HostAddress Gets or sets the host address.
Public Property HostPort Gets or sets the host port.
Public Property ImplementationClass Gets or sets the implementation class.
Public Property ImplementationVersionName The Implementation Version Name.
Public Property IpType Returns the DicomNetIpTypeFlags used in a Connect or a Listen (Inherited from DicomNet)
Public Property MaxLength The Maximum Length for data transfer.
Public Property OptimizedMemorySend Gets or sets the option to optimize memory usage when sending data sets to a server This option works when DicomNetSecurityMode is set to None (Inherited from DicomNet)
Public Property PeerAddress Gets the IP address of the peer computer of the connection (the SCU's address). (Inherited from DicomNet)
Public Property PeerPort Gets the port number of the peer computer of the connection (the SCU's port). (Inherited from DicomNet)
Public Property ProtocolVersion Gets or sets the protocol version.
Public Property Rejected Gets a value indicating whether this DicomConnection connection association has been rejected.
Public Property RejectReason Gets a descriptive string of the reason for associate rejection.
Public Property SecureHandshakeTimeout Gets or sets the number of seconds to wait for a secure handshake notification before timing out.
Public Property SecurityMode Gets the security mode used to initialize the network structure. (Inherited from DicomNet)
Public Property SocketOptions Gets or sets the DICOM Socket options. (Inherited from DicomNet)
Public Property Status Internal value to hold the status of the last DICOM operation associated with this connection.
Public Property Tag Gets or sets the object that contains extra information about this connection.
Public Property TemporaryDirectory Gets or sets the temporary directory.
Public Property Timeout Gets or sets the connection timeout.

Public Events

Name Description
Public Event AfterAssociateRequest Occurs after receiving an associate response from the SCP.
Public Event AfterClose Occurs after a close response is received from the scp.
Public Event AfterConnect Occurs after connecting to the SCP.
Public Event AfterReleaseRequest Occurs after release response received from scp.
Public Event AfterSecureLinkReady Occurs after TLS secured connection to SCP is established.
Public Event BeforeAssociateAccept Occurs before an associate is accepted by the SCU.
Public Event BeforeAssociateRequest Occurs when an associate request is sent to the SCP.
Public Event BeforeClose Occurs before a close request is sent to the scp.
Public Event BeforeConnect Occurs before connecting to the SCP.
Public Event BeforeReleaseRequest Occurs before a release request is sent to the scp.
Public Event PrivateKeyPassword Occurs when a private key password is needed.
Public Event ReceiveBuffer Occurs when connections received buffered data.
Public Event VerifyCertificate Occurs during the certificate exchange/verification phase of TLS DICOM Security negotiation and optionally controls the verification process.

Public Fields

Name Description
Public Field ActiveScp The current peer connection associated with this connection.

Protected Fields

Name Description
Protected Field cancelEvent Cancel event.
Protected Field CurrentMessageId Current message id.
Protected Field CurrentPid Current presentation context id.
Protected Field dicomEventRequest DICOM message event used when receiving DICOM requests (i.e N-Report-REQ).
Protected Field dicomEventResponse DICOM message event used when receiving DICOM responses (i.e. N-ECHO-RSP, C-Find-RSP, C-MOVE-RSP)
Protected Field parameters Internal variable to hold that information associated with DICOM commands.
Protected Field timeoutEvent Timeout event.
Protected Field waitHandles Event wait handle.

See Also

DicomConnection Class

Leadtools.Dicom.Scu Namespace

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom.Scu Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.