DVPSIPCMessage Class Reference

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

List of all members.

Public Member Functions

 DVPSIPCMessage ()
 default constructor
 DVPSIPCMessage (const DVPSIPCMessage &copy)
 copy constructor
virtual ~DVPSIPCMessage ()
 destructor
DVPSIPCMessage & operator= (const DVPSIPCMessage &)
 copy assignment operator
void setMessageType (Uint32 msgtype)
 sets the message type
Uint32 getMessageType ()
 returns the message type
void addStringToPayload (const char *str)
 adds a character string into the message payload.
void addIntToPayload (Uint32 i)
 adds an integer into the message payload.
OFBool extractStringFromPayload (OFString &str)
 extracts a string from the message payload and copies it into the given str object.
OFBool extractIntFromPayload (Uint32 &i)
 extracts an integer from the message payload.
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.
OFBool receive (DcmTransportConnection &connection)
 receives a messages from the given transport connection and stores it in the current object, replacing any existing payload.

Static Public Attributes

static const Uint32 OK
static const Uint32 requestApplicationID
static const Uint32 assignApplicationID
static const Uint32 applicationTerminates
static const Uint32 receivedUnencryptedDICOMConnection
static const Uint32 receivedEncryptedDICOMConnection
static const Uint32 connectionClosed
static const Uint32 connectionAborted
static const Uint32 requestedUnencryptedDICOMConnection
static const Uint32 requestedEncryptedDICOMConnection
static const Uint32 receivedDICOMObject
static const Uint32 sentDICOMObject
static const Uint32 statusOK
static const Uint32 statusWarning
static const Uint32 statusError
static const Uint32 clientOther
static const Uint32 clientStoreSCP
static const Uint32 clientStoreSCU
static const Uint32 clientPrintSCP
static const Uint32 clientPrintSCU
static const Uint32 clientQRSCP

Private Member Functions

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

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

Definition at line 42 of file dvpsmsg.h.

Member Function Documentation

void DVPSIPCMessage::setMessageType ( Uint32  msgtype  )  [inline]

sets the message type

Parameters:
msgtype new message type

Definition at line 61 of file dvpsmsg.h.

References messageType.

Uint32 DVPSIPCMessage::getMessageType (  )  [inline]

returns the message type

Returns:
message type

Definition at line 66 of file dvpsmsg.h.

References messageType.

void DVPSIPCMessage::addStringToPayload ( const char *  str  ) 

adds a character string into the message payload.

Parameters:
str zero terminated string, may be NULL (in which case an empty string is added)

void DVPSIPCMessage::addIntToPayload ( Uint32  i  ) 

adds an integer into the message payload.

Parameters:
value to write

OFBool DVPSIPCMessage::extractStringFromPayload ( OFString &  str  ) 

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

Parameters:
str string is written into this parameter
Returns:
OFTrue if successful, OFFalse otherwise

OFBool DVPSIPCMessage::extractIntFromPayload ( Uint32 &  i  ) 

extracts an integer from the message payload.

Parameters:
i integer is written into this parameter
Returns:
OFTrue if successful, OFFalse otherwise

OFBool DVPSIPCMessage::send ( DcmTransportConnection &  connection  ) 

sends the current message over the given transport connection.

Parameters:
connection transport connection to be used
Returns:
OFTrue if successful, OFFalse otherwise.

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:
connection transport 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:
i number of bytes required in buffer

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

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1