←Select platform

DicomNet Class Members

Summary

The following tables list the members exposed by DicomNet.

Public Constructors

	Name	Description
	DicomNet	Initializes a new instance of the DicomNet class.

Public Methods

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

Protected Methods

	Name	Description
	Dispose	Releases all resources used by the DicomNet.
	ExternalAuthenticateIscl	Determines whether the response code is a valid response for the challenge code.
	Finalize	This member overrides Finalize.
	GetChallengeIscl	Generates a random number.
	InternalAuthenticateIscl	Generates a response code, based on the specified challenge code.
	OnAccept	Notifies a listening connection (SCP) that it can accept pending connection requests.
	OnClose	Notifies a member of a connection that the connection was closed.
	OnConnect	Notifies the SCU that the connection attempt is complete.
	OnNonSecureReceivedIscl	This method is called after data sent in non-secure mode is received.
	OnNonSecureSendIscl	This method is called after data has been sent using the SendNonSecureIscl method.
	OnPrivateKeyPassword	This method is called by SetTlsClientCertificate whenever the private key file is password-encrypted in order to obtain the password.
	OnReceive	Notifies a connection that data was received.
	OnReceiveAbort	Notifies a connection that an Abort message was received.
	OnReceiveAssociateAccept	Notifies a connection that an Associate Accept message was received.
	OnReceiveAssociateReject	Notifies a connection that an Associate Reject message was received.
	OnReceiveAssociateRequest	Notifies a connection that an Associate Request message was received.
	OnReceiveCCancelRequest	Notifies a connection that a C-CANCEL-REQ command was received.
	OnReceiveCEchoRequest	Notifies a connection that a C-ECHO-REQ command was received.
	OnReceiveCEchoResponse	Notifies a connection that a C-ECHO-RSP command was received.
	OnReceiveCFindRequest	Notifies a connection that a C-FIND-REQ command was received.
	OnReceiveCFindResponse	Notifies a connection that a C-FIND-RSP command was received.
	OnReceiveCGetRequest	Notifies a connection that a C-GET-REQ command was received.
	OnReceiveCGetResponse	Notifies a connection that a C-GET-RSP command was received.
	OnReceiveCMoveRequest	Notifies a connection that a C-MOVE-REQ command was received.
	OnReceiveCMoveResponse	Notifies a connection that a C-MOVE-RSP command was received.
	OnReceiveCStoreRequest	Notifies a connection that a C-STORE-REQ command was received.
	OnReceiveCStoreResponse	Notifies a connection that a C-STORE-RSP command was received.
	OnReceiveData	Notifies a connection when a Data message was received.
	OnReceiveNActionRequest	Notifies a connection that an N-ACTION-REQ command was received.
	OnReceiveNActionResponse	Notifies a connection that an N-ACTION-RSP command was received.
	OnReceiveNCreateRequest	Notifies a connection that an N-CREATE-REQ command was received.
	OnReceiveNCreateResponse	Notifies a connection that an N-CREATE-RSP command was received.
	OnReceiveNDeleteRequest	Notifies a connection that an N-DELETE-REQ command was received.
	OnReceiveNDeleteResponse	Notifies a connection that an N-DELETE-RSP command was received.
	OnReceiveNGetRequest	Notifies a connection that an N-GET-REQ command was received.
	OnReceiveNGetResponse	Notifies a connection that an N-GET-RSP command was received.
	OnReceiveNReportRequest	Notifies a connection that an N-EVENT-REPORT-REQ command was received.
	OnReceiveNReportResponse	Notifies a connection that an N-EVENT-REPORT-RSP command was received.
	OnReceiveNSetRequest	Notifies a connection that an N-SET-REQ command was received.
	OnReceiveNSetResponse	Notifies a connection that an N-SET-RSP command was received.
	OnReceiveReleaseRequest	Notifies a connection that a Release Request message was received.
	OnReceiveReleaseResponse	Notifies a connection that a Release Response message was received.
	OnReceiveUnknown	Notifies a connection that an unknown command was received.
	OnSecureLinkReady	This method is called when an ISCL or TLS secured connection is successfully established.
	OnSend	Notifies a connection that data was sent.

Public Properties

	Name	Description
	Association	Gets the DICOM Association for the DICOM Network object.
	DefaultSocketOptions	Gets the default DICOM socket options.
	HostAddress	Gets the IP address of the host computer (the SCP's address).
	HostPort	Gets the port number of the host (the SCP's port).
	IpType	Returns the DicomNetIpTypeFlags used in a Connect or a Listen
	OptimizedMemorySend	Gets or sets the option to optimize memory usage when sending data sets to a server This option works when DicomNetSecurityeMode is set to None
	PeerAddress	Gets the IP address of the peer computer of the connection (the SCU's address).
	PeerPort	Gets the port number of the peer computer of the connection (the SCU's port).
	SecurityMode	Gets the security mode used to initialize the network structure.
	SocketOptions	Gets or sets the DICOM Socket options.