dcmnet/include/dcmtk/dcmnet/scu.h

/*
 *
 *  Copyright (C) 2008-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module:  dcmnet
 *
 *  Author:  Michael Onken
 *
 *  Purpose: Base class for Service Class Users (SCUs)
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:17:22 $
 *  CVS/RCS Revision: $Revision: 1.13 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef SCU_H
#define SCU_H

#include "dcmtk/config/osconfig.h"  /* make sure OS specific configuration is included first */

#include "dcmtk/dcmdata/dctk.h"     /* Covers most common dcmdata classes */
#include "dcmtk/dcmnet/dcompat.h"
#include "dcmtk/dcmnet/dimse.h"     /* DIMSE network layer */
#include "dcmtk/dcmnet/dcasccff.h"  /* For reading a association config file */
#include "dcmtk/dcmnet/dcasccfg.h"  /* For holding association cfg file infos */

#ifdef WITH_ZLIB
#include <zlib.h>     /* for zlibVersion() */
#endif


enum DcmCloseAssociationType
{
  DCMSCU_RELEASE_ASSOCIATION,
  DCMSCU_ABORT_ASSOCIATION,
  DCMSCU_PEER_REQUESTED_RELEASE,
  DCMSCU_PEER_ABORTED_ASSOCIATION
};


class FINDResponse
{

public:

  FINDResponse();

  virtual ~FINDResponse();

  Uint16 m_messageIDRespondedTo;

   // Mandatory response field
  OFString m_affectedSOPClassUID;

  DcmDataset *m_dataset;

  Uint16 m_status;
};


class FINDResponses
{

public:
  FINDResponses();
  virtual ~FINDResponses();
  Uint32 numResults() const;
  void add(FINDResponse *rsp);
  OFListIterator(FINDResponse *) begin();
  OFListIterator(FINDResponse *) end();

private:
  OFList<FINDResponse *> m_responses;
};

class DcmSCU
{

public:

  DcmSCU();

  virtual ~DcmSCU();

  OFCondition addPresentationContext(const OFString &abstractSyntax,
                                     const OFList<OFString> &xferSyntaxes);

  virtual OFCondition initNetwork();

  virtual OFCondition negotiateAssociation();

  T_ASC_PresentationContextID findPresentationContextID(const OFString &abstractSyntax,
                                                        const OFString &transferSyntax);

  virtual OFCondition sendECHORequest(const T_ASC_PresentationContextID presID);

  virtual OFCondition sendSTORERequest(const T_ASC_PresentationContextID presID,
                                       const OFString &dicomFile,
                                       DcmDataset *dset,
                                       DcmDataset *&rspCommandSet,
                                       DcmDataset *&rspStatusDetail,
                                       Uint16 &rspStatusCode);

  virtual OFCondition sendFINDRequest(T_ASC_PresentationContextID presID,
                                      DcmDataset *queryKeys,
                                      FINDResponses *responses);

  virtual OFCondition handleFINDResponse(Uint16 presContextID,
                                         FINDResponse *response,
                                         OFBool &waitForNextResponse);

  virtual OFCondition sendCANCELRequest(Uint16 presContextID);

  virtual OFCondition sendACTIONRequest(const T_ASC_PresentationContextID presID,
                                        const OFString &sopInstanceUID,
                                        const Uint16 actionTypeID,
                                        DcmDataset *reqDataset,
                                        Uint16 &rspStatusCode);

  virtual OFCondition handleEVENTREPORTRequest(DcmDataset *&reqDataset,
                                               Uint16 &eventTypeID,
                                               const int timeout = 0);

  virtual void closeAssociation(const DcmCloseAssociationType closeType);

  /* Set methods */

  void setMaxReceivePDULength(const unsigned long maxRecPDU);

  void setDIMSEBlockingMode(const T_DIMSE_BlockingMode blockingMode);

  void setAETitle(const OFString &myAETtitle);

  void setPeerHostName(const OFString &peerHostName);

  void setPeerAETitle(const OFString &peerAETitle);

  void setPeerPort(const Uint16 peerPort);

  void setDIMSETimeout(const Uint32 dimseTimeout);

  void setACSETimeout(const Uint32 acseTimeout);

  void setAssocConfigFileAndProfile(const OFString &filename,
                                    const OFString &profile);

  void setVerbosePCMode(const OFBool mode);

  /* Get methods */

  OFBool isConnected() const;

  Uint32 getMaxReceivePDULength() const;

  T_DIMSE_BlockingMode getDIMSEBlockingMode() const;

  const OFString &getAETitle() const;

  const OFString &getPeerHostName() const;

  const OFString &getPeerAETitle() const;

  Uint16 getPeerPort() const;

  Uint32 getDIMSETimeout() const;

  Uint32 getACSETimeout() const;

  OFBool getVerbosePCMode() const;

  OFBool getTLSEnabled() const;

protected:

  OFCondition sendDIMSEMessage(const T_ASC_PresentationContextID presID,
                               T_DIMSE_Message *msg,
                               DcmDataset *dataObject,
                               DIMSE_ProgressCallback callback,
                               void *callbackContext,
                               DcmDataset **commandSet = NULL);

  OFCondition getDatasetInfo(DcmDataset *dataset,
                             OFString &sopClassUID,
                             OFString &sopInstanceUID,
                             E_TransferSyntax &transferSyntax);


  OFCondition useSecureConnection(DcmTransportLayer *tlayer);

  OFCondition receiveDIMSECommand(T_ASC_PresentationContextID *presID,
                                  T_DIMSE_Message *msg,
                                  DcmDataset **statusDetail,
                                  DcmDataset **commandSet = NULL,
                                  const Uint32 timeout = 0);

  OFCondition receiveDIMSEDataset(T_ASC_PresentationContextID *presID,
                                  DcmDataset **dataObject,
                                  DIMSE_ProgressCallback callback,
                                  void *callbackContext);

  void findPresentationContext(const T_ASC_PresentationContextID presID,
                               OFString &abstractSyntax,
                               OFString &transferSyntax);

  virtual Uint16 checkEVENTREPORTRequest(T_DIMSE_N_EventReportRQ &request,
                                         DcmDataset *reqDataset);

private:

  DcmSCU(const DcmSCU &src);

  DcmSCU &operator=(const DcmSCU &src);

  T_ASC_Association *m_assoc;

  T_ASC_Network *m_net;

  T_ASC_Parameters *m_params;

  OFString m_assocConfigFilename;

  OFString m_assocConfigProfile;

  struct DcmSCUPresContext {
    OFString abstractSyntaxName;
    OFList<OFString> transferSyntaxes;
  };

  OFList<DcmSCUPresContext> m_presContexts;

  OFString m_assocConfigFile;

  T_DIMSE_Message *m_openDIMSERequest;

  Uint32 m_maxReceivePDULength;

  T_DIMSE_BlockingMode m_blockMode;

  OFString m_ourAETitle;

  OFString m_peer;

  OFString m_peerAETitle;

  Uint16 m_peerPort;

  Uint32 m_dimseTimeout;

  Uint32 m_acseTimeout;

  OFBool m_verbosePCMode;

  Uint16 nextMessageID();

};

#endif // SCU_H


/*
** CVS Log
** $Log: scu.h,v $
** Revision 1.13  2010-10-14 13:17:22  joergr
** Updated copyright header. Added reference to COPYRIGHT file.
**
** Revision 1.12  2010-10-07 12:54:07  joergr
** Fixed minor Doxygen API documentation issues (added backslash in order to
** avoid that the short description ends at the first period).
**
** Revision 1.11  2010-06-24 09:21:54  joergr
** Revised comment to make clear that the parameter "presID" shall never be 0
** for the sendACTIONRequest() method.
**
** Revision 1.10  2010-06-22 15:45:27  joergr
** Introduced new enumeration type to be used for closeAssociation().
** Further code cleanup. Renamed some methods, variables, types and so on.
**
** Revision 1.9  2010-06-17 17:11:27  joergr
** Added preliminary support for N-EVENT-REPORT to DcmSCU. Some further code
** cleanups and enhancements. Renamed some methods. Revised documentation.
**
** Revision 1.8  2010-06-09 16:09:01  joergr
** Added preliminary support for N-ACTION to DcmSCU. Some further code cleanups
** and enhancements.
**
** Revision 1.7  2010-06-08 17:54:12  onken
** Added C-FIND functionality to DcmSCU. Some code cleanups. Fixed
** memory leak sometimes occuring during association configuration.
**
** Revision 1.6  2010-04-29 16:13:28  onken
** Made SCU class independent from dcmtls, i.e. outsourced TLS API. Added
** direct API support for sending C-STORE requests. Further API changes and
** some bugs fixed.
**
** Revision 1.5  2009-12-21 17:00:32  onken
** Fixed API documentation to keep doxygen quiet.
**
** Revision 1.4  2009-12-21 15:33:55  onken
** Added documentation and refactored / enhanced some code.
**
** Revision 1.3  2009-12-17 09:12:10  onken
** Fixed other scu and scp base class compile issues.
**
** Revision 1.2  2009-12-17 09:05:15  onken
** Fixed typo resulting in build failure.
**
** Revision 1.1  2009-12-17 09:02:44  onken
** Added base classes for SCU and SCP implementations.
**
** Revision 1.2  2009-12-02 14:26:05  uli
** Stop including dcdebug.h which was removed.
**
** Revision 1.1  2008-09-29 13:51:52  onken
** Initial checkin of module dcmppscu implementing an MPPS commandline client.
**
*/

---

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