dcmnet/include/dcmtk/dcmnet/scp.h

/*
 *
 *  Copyright (C) 2009-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: General SCP class that can be used to implement derived SCP
 *           applications.
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:17:22 $
 *  CVS/RCS Revision: $Revision: 1.9 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef SCP_H
#define SCP_H

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

#include "dcmtk/oflog/oflog.h"
#include "dcmtk/dcmdata/dctk.h"     /* Covers most common dcmdata classes */
#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

#ifdef WITH_OPENSSL
#include "dcmtk/dcmtls/tlstrans.h"
#include "dcmtk/dcmtls/tlslayer.h"
#endif


struct DcmProcessSlotType
{
  DIC_NODENAME peerName;
  DIC_AE callingAETitle;
  DIC_AE calledAETitle;
  int processId;
  time_t startTime;
  OFBool hasStorageAbility;
};

enum DcmSCPActionType
{
  DCMSCP_ACTION_UNDEFINED,
  DCMSCP_ACTION_REFUSE_ASSOCIATION
};

enum DcmRefuseReasonType
{
  DCMSCP_TOO_MANY_ASSOCIATIONS,
  DCMSCP_CANNOT_FORK,
  DCMSCP_BAD_APPLICATION_CONTEXT_NAME,
  DCMSCP_BAD_APPLICATION_ENTITY_SERVICE,
  DCMSCP_FORCED,
  DCMSCP_NO_IMPLEMENTATION_CLASS_UID,
  DCMSCP_NO_PRESENTATION_CONTEXTS,
  DCMSCP_INTERNAL_ERROR
};

struct DcmPresentationContextInfo
{
  Uint8 presentationContextID;
  OFString abstractSyntax;
  Uint8 proposedSCRole;
  Uint8 acceptedSCRole;
  OFString acceptedTransferSyntax;
  // Fields "reserved" and "result" not included from DUL_PRESENTATIONCONTEXT
};


class DcmSCP
{

public:

  DcmSCP();

  virtual ~DcmSCP();

#ifdef _WIN32

  OFCondition markAsForkedChild();
#endif

  virtual OFCondition listen();


  /* ************************************************************* */
  /*             Set methods for configuring SCP behaviour         */
  /* ************************************************************* */

  virtual OFCondition addPresentationContext(const OFString &abstractSyntax,
                                             const OFList<OFString> xferSyntaxes,
                                             const T_ASC_SC_ROLE role = ASC_SC_ROLE_DEFAULT,
                                             const OFString &profile = "DEFAULT");

  void setPort(const Uint16 port);

  void setAETitle(const OFString &aetitle);

  void setRespondWithCalledAETitle(const OFBool useCalled);

  virtual OFCondition loadAssociationCfgFile(const OFString &assocFile);

  virtual OFCondition setAndCheckAssociationProfile(const OFString &profileName);

  void forceAssociationRefuse(const OFBool doRefuse);

  void setMaxReceivePDULength(const Uint32 maxRecPDU);

  OFCondition enableMultiProcessMode(int argc = 0,
                                     char *argv[] = NULL);

  void setMaxAssociations(const Uint16 maxAssocs);

  void setDIMSEBlockingMode(const T_DIMSE_BlockingMode blockingMode);

  void setDIMSETimeout(const Uint32 dimseTimeout);

  void setACSETimeout(const Uint32 acseTimeout);

  void setVerbosePCMode(const OFBool mode);

  /* Get methods for SCP settings */

  Uint16 getPort() const;

  const OFString &getAETitle() const;

  OFBool getRespondWithCalledAETitle() const;

  OFBool getRefuseAssociation() const;

  Uint32 getMaxReceivePDULength() const;

  OFBool getSingleProcess() const;

  Uint16 getMaxAssociations() const;

  T_DIMSE_BlockingMode getDIMSEBlockingMode() const;

  Uint32 getDIMSETimeout() const;

  Uint32 getACSETimeout() const;

  OFBool getVerbosePCMode() const;

  /* Get information about current association */

  OFBool isConnected() const;

  Uint16 numAssociations() const;

  OFString getCalledAETitle() const;

  OFString getPeerAETitle() const;

  OFString getPeerIP() const;

  Uint32 getPeerMaxPDULength() const;


protected:

  /* ***********************************************************************
   *  Functions particularly interesting for overwriting in derived classes
   * ***********************************************************************
   */

  virtual OFCondition handleIncomingCommand(T_DIMSE_Message *incomingMsg,
                                            const DcmPresentationContextInfo &presContextInfo);

  virtual void notifyAssociationRequest(const T_ASC_Parameters &params,
                                        DcmSCPActionType &desiredAction);

  virtual void notifyAssociationAcknowledge();

  virtual void notifyReleaseRequest();

  virtual void notifyAbortRequest();

  virtual void notifyAssociationTermination();

  virtual void notifyDIMSEError(const OFCondition &cond);

  virtual OFBool stopAfterCurrentAssociation();

  virtual OFCondition sendSTOREResponse(T_ASC_PresentationContextID presID,
                                        T_DIMSE_C_StoreRQ &reqMessage,
                                        T_DIMSE_C_StoreRSP &rspMessage,
                                        DcmDataset *statusDetail);

  virtual OFCondition handleECHORequest(T_DIMSE_C_EchoRQ &reqMessage,
                                        T_ASC_PresentationContextID presID);

  virtual OFCondition handleEVENTREPORTRequest(T_DIMSE_N_EventReportRQ &reqMessage,
                                               T_ASC_PresentationContextID presID,
                                               DcmDataset *&reqDataset,
                                               Uint16 &eventTypeID);

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

  virtual OFBool calledAETitleAccepted(const OFString &callingAE,
                                       const OFString &calledAE);


  /* *********************************************************************
   *  Further functions and member variables
   * *********************************************************************
   */

  virtual OFCondition waitForAssociation(T_ASC_Network *network);

  virtual void cleanChildren();

  virtual OFCondition negotiateAssociation();

  virtual void addProcessToTable(int pid);

  virtual void removeProcessFromTable(int pid);

  virtual void refuseAssociation(DcmRefuseReasonType reason);

  virtual void handleAssociation();

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

  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);

private:

  DcmSCP(const DcmSCP &src);

  DcmSCP &operator=(const DcmSCP &src);

  T_ASC_Association *m_assoc;

  DcmAssociationConfiguration *m_assocConfig;

  OFString m_assocCfgProfileName;

  Uint16 m_port;

  OFString m_aetitle;

  OFBool m_refuseAssociation;

  Uint32 m_maxReceivePDULength;

  OFBool m_singleProcess;

  OFBool m_forkedChild;

#ifdef _WIN32
  int m_cmd_argc;

  char **m_cmd_argv;
#endif

  Uint16 m_maxAssociations;

  T_DIMSE_BlockingMode m_blockMode;

  Uint32 m_dimseTimeout;

  Uint32 m_acseTimeout;

  OFBool m_verbosePCMode;

  OFList<DcmProcessSlotType *> m_processTable;

  OFBool m_respondWithCalledAETitle;

  void dropAndDestroyAssociation();

};

#endif // SCP_H


/*
 *  CVS/RCS Log:
 *  $Log: scp.h,v $
 *  Revision 1.9  2010-10-14 13:17:22  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.8  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.7  2010-06-22 15:44:55  joergr
 *  Added support for handling N-EVENT-REPORT request.
 *  Added support for stopping after the current association is finished.
 *  Further code cleanup. Renamed some methods, variables, types and so on.
 *
 *  Revision 1.6  2010-06-18 14:50:33  joergr
 *  Added support for the SCP/SCU role selection negotiation.
 *
 *  Revision 1.5  2010-06-17 17:06:30  joergr
 *  Aligned SCP class with existing SCU class. Some further code cleanups.
 *  Changed default profile from "Default" to "DEFAULT". Revised documentation.
 *
 *  Revision 1.4  2010-04-29 16:14:59  onken
 *  Added function for responding to storage requests to SCP class.
 *
 *  Revision 1.3  2009-12-21 17:00:32  onken
 *  Fixed API documentation to keep doxygen quiet.
 *
 *  Revision 1.1  2009-12-17 09:02:43  onken
 *  Added base classes for SCU and SCP implementations.
 *
 */

---

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