dvpsmsg.h

/*
 *
 *  Copyright (C) 1998-2005, OFFIS
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
 *  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
 *  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
 *  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
 *  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Module: dcmpstat
 *
 *  Author: Marco Eichelberg
 *
 *  Purpose:
 *    classes: DVPSIPCMessage
 *
 *  Last Update:      $Author: meichel $
 *  Update Date:      $Date: 2005/12/08 16:03:52 $
 *  CVS/RCS Revision: $Revision: 1.5 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef __DVPSMSG_H__
#define __DVPSMSG_H__

#include "dcmtk/config/osconfig.h"    /* make sure OS specific configuration is included first */
#include "dcmtk/dcmdata/dctypes.h"     /* for Uint32 */
#include "dcmtk/ofstd/ofstring.h"   /* for class OFString */

class DcmTransportConnection;

class DVPSIPCMessage
{
public:

  DVPSIPCMessage();
  
  DVPSIPCMessage(const DVPSIPCMessage& copy);

  virtual ~DVPSIPCMessage();

  DVPSIPCMessage& operator=(const DVPSIPCMessage&);

  void setMessageType(Uint32 msgtype) { messageType = msgtype; }
  
  Uint32 getMessageType() { return messageType; }

  void addStringToPayload(const char *str);

  void addIntToPayload(Uint32 i);

  OFBool extractStringFromPayload(OFString& str);

  OFBool extractIntFromPayload(Uint32& i);

  void rewindPayload();  
  
  void erasePayload();

  OFBool send(DcmTransportConnection &connection);

  OFBool receive(DcmTransportConnection &connection);

 
  // constants for message type
  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;

  // message status constants
  static const Uint32 statusOK;      // OK
  static const Uint32 statusWarning; // warning
  static const Uint32 statusError;   // error

  // client type constants
  static const Uint32 clientOther;    // client is of unspecified type
  static const Uint32 clientStoreSCP; // client is Store SCP
  static const Uint32 clientStoreSCU; // client is Store SCU
  static const Uint32 clientPrintSCP; // client is Print SCP
  static const Uint32 clientPrintSCU; // client is Print SCU
  static const Uint32 clientQRSCP;    // client is Query/Retrieve (Find/Move/Get) SCP
  
private:

  void resizePayload(Uint32 i);
  
  Uint32 messageType;

  Uint32 payloadUsed;

  Uint32 payloadAllocated;

  Uint32 payloadReadOffset;

  unsigned char *payload;
};


class DVPSIPCClient
{
public:

  DVPSIPCClient(Uint32 clientType, const char *txt, int thePort, OFBool keepOpen);
  
  virtual ~DVPSIPCClient();

  void notifyApplicationTerminates(Uint32 status);

  void notifyReceivedUnencryptedDICOMConnection(Uint32 status, const char *txt);

  void notifyReceivedEncryptedDICOMConnection(Uint32 status, const char *txt);

  void notifyConnectionClosed(Uint32 status);

  void notifyConnectionAborted(Uint32 status, const char *txt);

  void notifyRequestedUnencryptedDICOMConnection(Uint32 status, const char *txt);

  void notifyRequestedEncryptedDICOMConnection(Uint32 status, const char *txt);

  void notifyReceivedDICOMObject(Uint32 status, const char *txt);

  void notifySentDICOMObject(Uint32 status, const char *txt);

  OFBool isServerActive() { return serverActive; }

private:

  DVPSIPCClient(const DVPSIPCClient& copy);

  DVPSIPCClient& operator=(const DVPSIPCClient&);

  void requestConnection();

  OFBool performTransaction(DVPSIPCMessage& msg);
  
  int port;
  
  OFBool serverActive;
  
  Uint32 applicationID;

  OFBool keepConnectionOpen;
  
  DcmTransportConnection *connection;
};


#endif

/*
 *  $Log: dvpsmsg.h,v $
 *  Revision 1.5  2005/12/08 16:03:52  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.4  2003/07/04 13:27:38  meichel
 *  Replaced forward declarations for OFString with explicit includes,
 *    needed when compiling with HAVE_STD_STRING
 *
 *  Revision 1.3  2001/06/01 15:50:18  meichel
 *  Updated copyright header
 *
 *  Revision 1.2  2000/11/08 18:38:15  meichel
 *  Updated dcmpstat IPC protocol for additional message parameters
 *
 *  Revision 1.1  2000/10/10 12:24:36  meichel
 *  Added extensions for IPC message communication
 *
 *
 */

---

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5