DicomServer Class Members

Summary

The following tables list the members exposed by DicomServer.

Public Constructors

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

Public Methods

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

Protected Methods

	Name	Description
	Dispose(bool)	Releases all resources used by the DicomNet. (Inherited from DicomNet)
	ExternalAuthenticateIscl	Determines whether the response code is a valid response for the challenge code. (Inherited from DicomNet)
	Finalize	This member overrides Finalize. (Inherited from DicomNet)
	GetChallengeIscl	Generates a random number. (Inherited from DicomNet)
	InternalAuthenticateIscl	Generates a response code, based on the specified challenge code. (Inherited from DicomNet)
	OnAccept	Notifies a listening connection (SCP) that it can accept pending connection requests. (Inherited from DicomNet)
	OnBeforeSendCommandSet	Notifies a connection before the Command Set portion of a DIMSE DicomNet:SendXxxResponse is transmitted. (Inherited from DicomNet)
	OnClose	Notifies a member of a connection that the connection was closed. (Inherited from DicomNet)
	OnConnect	Notifies the SCU that the connection attempt is complete. (Inherited from DicomNet)
	OnNonSecureReceivedIscl	This method is called after data sent in non-secure mode is received. (Inherited from DicomNet)
	OnNonSecureSendIscl	This method is called after data has been sent using the SendNonSecureIscl method. (Inherited from DicomNet)
	OnPrivateKeyPassword	This method is called by SetTlsClientCertificate whenever the private key file is password-encrypted in order to obtain the password. (Inherited from DicomNet)
	OnReceive	Notifies a connection that data was received. (Inherited from DicomNet)
	OnReceiveAbort	Notifies a connection that an Abort message was received. (Inherited from DicomNet)
	OnReceiveAssociateAccept	Notifies a connection that an Associate Accept message was received. (Inherited from DicomNet)
	OnReceiveAssociateReject	Notifies a connection that an Associate Reject message was received. (Inherited from DicomNet)
	OnReceiveAssociateRequest	Notifies a connection that an Associate Request message was received. (Inherited from DicomNet)
	OnReceiveCCancelRequest	Notifies a connection that a C-CANCEL-REQ command was received. (Inherited from DicomNet)
	OnReceiveCEchoRequest	Notifies a connection that a C-ECHO-REQ command was received. (Inherited from DicomNet)
	OnReceiveCEchoResponse	Notifies a connection that a C-ECHO-RSP command was received. (Inherited from DicomNet)
	OnReceiveCFindRequest	Notifies a connection that a C-FIND-REQ command was received. (Inherited from DicomNet)
	OnReceiveCFindResponse	Notifies a connection that a C-FIND-RSP command was received. (Inherited from DicomNet)
	OnReceiveCGetRequest	Notifies a connection that a C-GET-REQ command was received. (Inherited from DicomNet)
	OnReceiveCGetResponse	Notifies a connection that a C-GET-RSP command was received. (Inherited from DicomNet)
	OnReceiveCMoveRequest	Notifies a connection that a C-MOVE-REQ command was received. (Inherited from DicomNet)
	OnReceiveCMoveResponse	Notifies a connection that a C-MOVE-RSP command was received. (Inherited from DicomNet)
	OnReceiveCStoreRequest	Notifies a connection that a C-STORE-REQ command was received. (Inherited from DicomNet)
	OnReceiveCStoreResponse	Notifies a connection that a C-STORE-RSP command was received. (Inherited from DicomNet)
	OnReceiveData	Notifies a connection when a Data message was received. (Inherited from DicomNet)
	OnReceivedISCLPacket	Notifies a connection when a Data message is received in ISCL mode. (Inherited from DicomNet)
	OnReceiveNActionRequest	Notifies a connection that an N-ACTION-REQ command was received. (Inherited from DicomNet)
	OnReceiveNActionResponse	Notifies a connection that an N-ACTION-RSP command was received. (Inherited from DicomNet)
	OnReceiveNCreateRequest	Notifies a connection that an N-CREATE-REQ command was received. (Inherited from DicomNet)
	OnReceiveNCreateResponse	Notifies a connection that an N-CREATE-RSP command was received. (Inherited from DicomNet)
	OnReceiveNDeleteRequest	Notifies a connection that an N-DELETE-REQ command was received. (Inherited from DicomNet)
	OnReceiveNDeleteResponse	Notifies a connection that an N-DELETE-RSP command was received. (Inherited from DicomNet)
	OnReceiveNGetRequest	Notifies a connection that an N-GET-REQ command was received. (Inherited from DicomNet)
	OnReceiveNGetResponse	Notifies a connection that an N-GET-RSP command was received. (Inherited from DicomNet)
	OnReceiveNReportRequest	Notifies a connection that an N-EVENT-REPORT-REQ command was received. (Inherited from DicomNet)
	OnReceiveNReportResponse	Notifies a connection that an N-EVENT-REPORT-RSP command was received. (Inherited from DicomNet)
	OnReceiveNSetRequest	Notifies a connection that an N-SET-REQ command was received. (Inherited from DicomNet)
	OnReceiveNSetResponse	Notifies a connection that an N-SET-RSP command was received. (Inherited from DicomNet)
	OnReceiveReleaseRequest	Notifies a connection that a Release Request message was received. (Inherited from DicomNet)
	OnReceiveReleaseResponse	Notifies a connection that a Release Response message was received. (Inherited from DicomNet)
	OnReceiveUnknown	Notifies a connection that an unknown command was received. (Inherited from DicomNet)
	OnSecureLinkReady	This method is called when an ISCL or TLS secured connection is successfully established. (Inherited from DicomNet)
	OnSend	Notifies a connection that data was sent. (Inherited from DicomNet)
	OnServerSettingsChanged	Notifies the event subscribers that the PACS Framework Server setting have changed..
	OnVerify	A callback that provides information during the certificate exchange/verification phase of TLS DICOM Security negotiation and optionally controls the verification process. (Inherited from DicomNet)

Public Properties

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