DVPSIPCClient Class Reference

a client for IPC message exchange between different processes of the DICOMscope application More...

List of all members.

Public Member Functions
	DVPSIPCClient (Uint32 clientType, const char *txt, int thePort, OFBool keepOpen)
	constructor
virtual	~DVPSIPCClient ()
	destructor
void	notifyApplicationTerminates (Uint32 status)
	sends ApplicationTerminates notification to server.
void	notifyReceivedUnencryptedDICOMConnection (Uint32 status, const char *txt)
	sends ReceivedUnencryptedDICOMConnection notification to server.
void	notifyReceivedEncryptedDICOMConnection (Uint32 status, const char *txt)
	sends ReceivedEncryptedDICOMConnection notification to server.
void	notifyConnectionClosed (Uint32 status)
	sends ConnectionClosed notification to server.
void	notifyConnectionAborted (Uint32 status, const char *txt)
	sends ConnectionAborted notification to server.
void	notifyRequestedUnencryptedDICOMConnection (Uint32 status, const char *txt)
	sends RequestedUnencryptedDICOMConnection notification to server.
void	notifyRequestedEncryptedDICOMConnection (Uint32 status, const char *txt)
	sends RequestedEncryptedDICOMConnection notification to server.
void	notifyReceivedDICOMObject (Uint32 status, const char *txt)
	sends ReceivedDICOMObject notification to server.
void	notifySentDICOMObject (Uint32 status, const char *txt)
	sends SentDICOMObject notification to server.
OFBool	isServerActive ()
	checks whether the message server has been found active upon creation of this object.
Private Member Functions
	DVPSIPCClient (const DVPSIPCClient &copy)
	private undefined copy constructor
DVPSIPCClient &	operator= (const DVPSIPCClient &)
	private undefined copy assignment operator
void	requestConnection ()
	request connection to server, store in 'connection' if successful.
OFBool	performTransaction (DVPSIPCMessage &msg)
	perform message transaction with server.
Private Attributes
int	port
	TCP/IP port number on which the server is listening.
OFBool	serverActive
	true if the first connection attempt has succeeded, false otherwise
Uint32	applicationID
	application ID assigned by the server
OFBool	keepConnectionOpen
	flag indicating whether we want to keep the connection open
DcmTransportConnection *	connection
	current transport connection

---

Detailed Description

a client for IPC message exchange between different processes of the DICOMscope application

---

Constructor & Destructor Documentation

DVPSIPCClient::DVPSIPCClient	(	Uint32	clientType,
		const char *	txt,
		int	thePort,
		OFBool	keepOpen
	)

constructor

Parameters:

clientType	type of client application, see constants defined in DVPSIPCMessage
txt	textual description of client application
thePort	TCP/IP port on which the server is listening
keepOpen	flag indicating whether the connection should be kept open all the time or should be opened/closed for each transaction.

---

Member Function Documentation

OFBool DVPSIPCClient::isServerActive

(

)

[inline]

checks whether the message server has been found active upon creation of this object.

Returns:

OFTrue if server is active, OFFalse otherwise.

void DVPSIPCClient::notifyApplicationTerminates

(

Uint32

status

)

sends ApplicationTerminates notification to server.

Parameters:

Uint32

message status, see constants defined in DVPSIPCMessage

void DVPSIPCClient::notifyConnectionAborted	(	Uint32	status,
		const char *	txt
	)

sends ConnectionAborted notification to server.

Parameters:

Uint32	message status, see constants defined in DVPSIPCMessage
txt	textual description of notification for server

void DVPSIPCClient::notifyConnectionClosed

(

Uint32

status

)

sends ConnectionClosed notification to server.

Parameters:

Uint32

message status, see constants defined in DVPSIPCMessage

void DVPSIPCClient::notifyReceivedDICOMObject	(	Uint32	status,
		const char *	txt
	)

sends ReceivedDICOMObject notification to server.

Parameters:

Uint32	message status, see constants defined in DVPSIPCMessage
txt	textual description of DICOM object

void DVPSIPCClient::notifyReceivedEncryptedDICOMConnection	(	Uint32	status,
		const char *	txt
	)

sends ReceivedEncryptedDICOMConnection notification to server.

Parameters:

Uint32	message status, see constants defined in DVPSIPCMessage
txt	textual description of notification for server

void DVPSIPCClient::notifyReceivedUnencryptedDICOMConnection	(	Uint32	status,
		const char *	txt
	)

sends ReceivedUnencryptedDICOMConnection notification to server.

Parameters:

Uint32	message status, see constants defined in DVPSIPCMessage
txt	textual description of notification for server

void DVPSIPCClient::notifyRequestedEncryptedDICOMConnection	(	Uint32	status,
		const char *	txt
	)

sends RequestedEncryptedDICOMConnection notification to server.

Parameters:

Uint32	message status, see constants defined in DVPSIPCMessage
txt	textual description of notification for server

void DVPSIPCClient::notifyRequestedUnencryptedDICOMConnection	(	Uint32	status,
		const char *	txt
	)

sends RequestedUnencryptedDICOMConnection notification to server.

Parameters:

Uint32	message status, see constants defined in DVPSIPCMessage
txt	textual description of notification for server

void DVPSIPCClient::notifySentDICOMObject	(	Uint32	status,
		const char *	txt
	)

sends SentDICOMObject notification to server.

Parameters:

Uint32	message status, see constants defined in DVPSIPCMessage
txt	textual description of DICOM object

OFBool DVPSIPCClient::performTransaction

(

DVPSIPCMessage &

msg

)

[private]

perform message transaction with server.

If serverActive is false, no connection attempt is performed.

Parameters:

msg	contains message to be sent, overwritten with message received from server if successful

Returns:

OFTrue if successful, OFFalse otherwise

---

The documentation for this class was generated from the following file:

• dcmpstat/include/dcmtk/dcmpstat/dvpsmsg.h