dcmnet/include/dcmtk/dcmnet/dcmtrans.h

/*
 *
 *  Copyright (C) 1998-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: Marco Eichelberg
 *
 *  Purpose:
 *    classes: DcmTransportConnection, DcmTCPConnection
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:17:22 $
 *  CVS/RCS Revision: $Revision: 1.11 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef DCMTRANS_H
#define DCMTRANS_H

#include "dcmtk/config/osconfig.h"    /* make sure OS specific configuration is included first */
#include "dcmtk/ofstd/oftypes.h"     /* for OFBool */
#include "dcmtk/dcmnet/dcmlayer.h"    /* for DcmTransportLayerStatus */
#include "dcmtk/ofstd/ofstream.h"    /* for ostream */

#define INCLUDE_UNISTD
#include "dcmtk/ofstd/ofstdinc.h"

class DcmTransportConnection
{
public:

  DcmTransportConnection(int openSocket);

  virtual ~DcmTransportConnection();

  virtual DcmTransportLayerStatus serverSideHandshake() = 0;

  virtual DcmTransportLayerStatus clientSideHandshake() = 0;

  virtual DcmTransportLayerStatus renegotiate(const char *newSuite) = 0;

  virtual ssize_t read(void *buf, size_t nbyte) = 0;

  virtual ssize_t write(void *buf, size_t nbyte) = 0;

  virtual void close() = 0;

  virtual unsigned long getPeerCertificateLength() = 0;

  /* copies the peer certificate of a secure connection into a buffer
   * specified by the caller. If the buffer is too small to hold the
   * certificate, nothing is copied and zero is returned.
   * @param buf buffer into which the certificate is written
   * @param bufLen size of the buffer in bytes
   * @return number of bytes written, always less or equal bufLen.
   */
  virtual unsigned long getPeerCertificate(void *buf, unsigned long bufLen) = 0;

  virtual OFBool networkDataAvailable(int timeout) = 0;

  virtual OFBool isTransparentConnection() = 0;

  virtual OFString& dumpConnectionParameters(OFString& str) = 0;

  void dumpConnectionParameters(STD_NAMESPACE ostream& out);

  virtual const char *errorString(DcmTransportLayerStatus code) = 0;

  static OFBool selectReadableAssociation(DcmTransportConnection *connections[], int connCount, int timeout);

protected:

  int getSocket() { return theSocket; }

  void setSocket(int socket) { theSocket = socket; }

private:

  DcmTransportConnection(const DcmTransportConnection&);

  DcmTransportConnection& operator=(const DcmTransportConnection&);

  static OFBool safeSelectReadableAssociation(DcmTransportConnection *connections[], int connCount, int timeout);

  static OFBool fastSelectReadableAssociation(DcmTransportConnection *connections[], int connCount, int timeout);

  int theSocket;
};


class DcmTCPConnection: public DcmTransportConnection
{
public:

  DcmTCPConnection(int openSocket);

  virtual ~DcmTCPConnection();

  virtual DcmTransportLayerStatus serverSideHandshake();

  virtual DcmTransportLayerStatus clientSideHandshake();

  virtual DcmTransportLayerStatus renegotiate(const char *newSuite);

  virtual ssize_t read(void *buf, size_t nbyte);

  virtual ssize_t write(void *buf, size_t nbyte);

  virtual void close();

  virtual unsigned long getPeerCertificateLength();

  /* copies the peer certificate of a secure connection into a buffer
   * specified by the caller. If the buffer is too small to hold the
   * certificate, nothing is copied and zero is returned.
   * @param buf buffer into which the certificate is written
   * @param bufLen size of the buffer in bytes
   * @return number of bytes written, always less or equal bufLen.
   */
  virtual unsigned long getPeerCertificate(void *buf, unsigned long bufLen);

  virtual OFBool networkDataAvailable(int timeout);

  virtual OFBool isTransparentConnection();

  virtual OFString& dumpConnectionParameters(OFString& str);

  virtual const char *errorString(DcmTransportLayerStatus code);

private:

  DcmTCPConnection(const DcmTCPConnection&);

  DcmTCPConnection& operator=(const DcmTCPConnection&);

};

#endif

/*
 *  $Log: dcmtrans.h,v $
 *  Revision 1.11  2010-10-14 13:17:22  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.10  2009-11-18 11:53:58  uli
 *  Switched to logging mechanism provided by the "new" oflog module.
 *
 *  Revision 1.9  2009-01-29 11:39:44  joergr
 *  Fixed issue with missing invalidation of socket variable during close method.
 *  Please note that this is only required if the connection objects exists after
 *  the TCP/IP connection has been closed (which is currently not the case).
 *
 *  Revision 1.8  2006/08/15 16:04:29  meichel
 *  Updated the code in module dcmnet to correctly compile when
 *    all standard C++ classes remain in namespace std.
 *
 *  Revision 1.7  2005/12/08 16:02:18  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.6  2004/08/03 11:42:43  meichel
 *  Headers libc.h and unistd.h are now included via ofstdinc.h
 *
 *  Revision 1.5  2003/12/05 10:39:45  joergr
 *  Removed leading underscore characters from preprocessor symbols (reserved
 *  symbols).
 *
 *  Revision 1.4  2003/07/04 13:27:15  meichel
 *  Added include for ofstream.h, to make sure ofstream is correctly defined
 *
 *  Revision 1.3  2001/06/01 15:50:04  meichel
 *  Updated copyright header
 *
 *  Revision 1.2  2000/10/10 12:06:53  meichel
 *  Updated transport layer error codes and routines for printing
 *    connection parameters.
 *
 *  Revision 1.1  2000/08/10 14:50:53  meichel
 *  Added initial OpenSSL support.
 *
 *
 */

---

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