←Select platform
In This Topic ▼

DicomServer Class Members

Summary

The following tables list the members exposed by DicomServer.

Public Constructors

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

Public Methods

Name Description
Public Method Accept Accepts a connection request from an SCU. (Inherited from DicomNet)
Public Method Breathe For Windows platforms, this implements a standard Windows Message pump. (Inherited from DicomNet)
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 Connect Connects an Called AE to an Calling AE. (Inherited from DicomNet)
Public Method Dispose Releases all resources used by the DicomNet. (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 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 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 RequestAdditionalTime Requests additional time for add-in processing.
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 Shutdown Shuts down the LEADTOOLS DICOM DLL. (Inherited from DicomNet)
Public Method Start Starts this instance.
Public Method Startup Initializes the LEADTOOLS DICOM DLL. (Inherited from DicomNet)
Public Method Stop Stops this instance.

Protected Methods

Name Description
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 InternalAuthenticateIscl Generates a response code, based on the specified challenge code. (Inherited from DicomNet)
Protected Method OnAccept Notifies a listening connection (SCP) that it can accept pending connection requests. (Inherited from DicomNet)
Protected Method OnClose Notifies a member of a connection that the connection was closed. (Inherited from DicomNet)
Protected Method OnConnect Notifies the SCU that the connection attempt is complete. (Inherited from DicomNet)
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 This method is called by SetTlsClientCertificate whenever the private key file is password-encrypted in order to obtain the password. (Inherited from DicomNet)
Protected Method OnReceive Notifies a connection that data was received. (Inherited from DicomNet)
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. (Inherited from DicomNet)
Protected Method OnReceiveAssociateReject Notifies a connection that an Associate Reject message was received. (Inherited from DicomNet)
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. (Inherited from DicomNet)
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. (Inherited from DicomNet)
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. (Inherited from DicomNet)
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. (Inherited from DicomNet)
Protected Method OnSend Notifies a connection that data was sent. (Inherited from DicomNet)
Protected Method OnServerSettingsChanged Notifies the event subscribers that the PACS Framework Server setting have changed..

Public Properties

Name Description
Public Property Active Gets a value indicating whether this DicomServer is active.
Public Property AddInTimeout Gets the add-in's timeout in seconds.
Public Property AETitle Gets the server AE title.
Public Property AllowAnonymousCMove Gets or sets a value indicating whether to allow anonymous C-MOVE on the DICOM Listening Service.
Public Property AllowMultipleConnections Gets a value indicating whether to allow multiple client connections.
Public Property AnonymousClientPort Gets or sets a value indicating the anonymous C-MOVE reconnect port for the DICOM Listening Service.
Public Property Association Gets the DICOM Association for the DICOM Network object. (Inherited from DicomNet)
Public Property Clients Gets the connected clients.
Public Property ClientTimeout Gets the client timeout in seconds.
Public Property DefaultSocketOptions Gets the default DICOM socket options. (Inherited from DicomNet)
Public Property Description Gets the server description.
Public Property Flags Get or set options for DICOM communication. (Inherited from DicomNet)
Public Property HostAddress Gets the IP address of the host computer (the SCP's address). (Inherited from DicomNet)
Public Property HostPort Gets the port number of the host (the SCP's port). (Inherited from DicomNet)
Public Property Id Gets the unique server id.
Public Property ImplementationClass Gets the Implementation Class UID .
Public Property ImplementationVersionName Gets the Implementation Version Name.
Public Property IpType Returns the DicomNetIpTypeFlags used in a Connect or a Listen (Inherited from DicomNet)
Public Property LicenseFile Gets the license file associated with the PACS Framework Server.
Public Property MaxClients Gets or sets the maximum clients allowed to connect to the server.
Public Property MaxPduLength Gets the Maximum Length for data transfer.
Public Property Name Gets the server name.
Public Property NoDelay Gets the value for Nagle algorithm for send coalescing. This socket option is included for backward compatibility with Windows Sockets 1.1.
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 Port Gets the server port.
Public Property ReceiveBufferSize Specifies the total per-socket buffer space reserved for receives.
Public Property ReconnectTimeout Gets the reconnect timeout in seconds.
Public Property RelationalQueries Gets a value indicating whether relational queries are supported
Public Property RoleSelectionOptions Gets RoleSelectionFlags that define how the SCP will accept/reject any role selection proposed by the SCU.
Public Property Secure Gets a value indicating whether this DicomServer is secure.
Public Property SecurityMode Gets the security mode used to initialize the network structure. (Inherited from DicomNet)
Public Property SendBufferSize Specifies the total per-socket buffer space reserved for sends.
Public Property ServerDirectory Gets the server directory.
Public Property SocketOptions Gets or sets the DICOM Socket options. (Inherited from DicomNet)
Public Property StoreDataset Gets a value indicating whether store received datasets.
Public Property TemporaryDirectory The location of the temporary files. DICOM uses temporary files during the course of creating a file. If this parameter is a null reference (Nothing in VB), the DICOM temporary files are kept in the directory Windows places its own temporary files. If this parameter is not a null reference, the temporary files are placed in the specified directory.
Public Property TotalClients Gets the total number of clients connected.

Public Events

Name Description
Public Event ServerSettingsChanged Occurs when the PACS Framework Server settings are changed.

Protected Fields

Name Description
Protected Field clientsBacking Internally used by DicomServer and descendants.

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

Leadtools.Dicom.AddIn Assembly