DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DVPSIPCMessage Class Reference

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

Public Member Functions

 DVPSIPCMessage ()
 default constructor
 
 DVPSIPCMessage (const DVPSIPCMessage &copy)
 copy constructor
 
virtual ~DVPSIPCMessage ()
 destructor
 
DVPSIPCMessageoperator= (const DVPSIPCMessage &)
 copy assignment operator
 
void setMessageType (Uint32 msgtype)
 sets the message type More...
 
Uint32 getMessageType ()
 returns the message type More...
 
void addStringToPayload (const char *str)
 adds a character string into the message payload. More...
 
void addIntToPayload (Uint32 i)
 adds an integer into the message payload. More...
 
OFBool extractStringFromPayload (OFString &str)
 extracts a string from the message payload and copies it into the given str object. More...
 
OFBool extractIntFromPayload (Uint32 &i)
 extracts an integer from the message payload. More...
 
void rewindPayload ()
 rewinds the read offset to the beginning of the message payload
 
void erasePayload ()
 removes all payload
 
OFBool send (DcmTransportConnection &connection)
 sends the current message over the given transport connection. More...
 
OFBool receive (DcmTransportConnection &connection)
 receives a messages from the given transport connection and stores it in the current object, replacing any existing payload. More...
 

Private Member Functions

void resizePayload (Uint32 i)
 resize payload if necessary such that at least i bytes can be written More...
 

Private Attributes

Uint32 messageType
 type of message
 
Uint32 payloadUsed
 number of bytes actually used in payload
 
Uint32 payloadAllocated
 number of bytes allocated in payload
 
Uint32 payloadReadOffset
 read offset into payload in bytes
 
unsigned char * payload
 pointer to raw payload data in big endian byte order
 

Detailed Description

class for IPC message exchange between different processes of the DICOMscope application

Member Function Documentation

void DVPSIPCMessage::addIntToPayload ( Uint32  i)

adds an integer into the message payload.

Parameters
valueto write
void DVPSIPCMessage::addStringToPayload ( const char *  str)

adds a character string into the message payload.

Parameters
strzero terminated string, may be NULL (in which case an empty string is added)
OFBool DVPSIPCMessage::extractIntFromPayload ( Uint32 &  i)

extracts an integer from the message payload.

Parameters
iinteger is written into this parameter
Returns
OFTrue if successful, OFFalse otherwise
OFBool DVPSIPCMessage::extractStringFromPayload ( OFString str)

extracts a string from the message payload and copies it into the given str object.

Parameters
strstring is written into this parameter
Returns
OFTrue if successful, OFFalse otherwise
Uint32 DVPSIPCMessage::getMessageType ( )
inline

returns the message type

Returns
message type
OFBool DVPSIPCMessage::receive ( DcmTransportConnection connection)

receives a messages from the given transport connection and stores it in the current object, replacing any existing payload.

Parameters
connectiontransport connection to be used
Returns
OFTrue if successful, OFFalse otherwise.
void DVPSIPCMessage::resizePayload ( Uint32  i)
private

resize payload if necessary such that at least i bytes can be written

Parameters
inumber of bytes required in buffer
OFBool DVPSIPCMessage::send ( DcmTransportConnection connection)

sends the current message over the given transport connection.

Parameters
connectiontransport connection to be used
Returns
OFTrue if successful, OFFalse otherwise.
void DVPSIPCMessage::setMessageType ( Uint32  msgtype)
inline

sets the message type

Parameters
msgtypenew message type

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


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8