DCMTK Version 3.6.8
OFFIS DICOM Toolkit
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
DcmTransportConnection Class Referenceabstract

this class represents a TCP/IP based transport connection which can be a transparent TCP/IP socket communication or a secure transport protocol such as TLS. More...

+ Inheritance diagram for DcmTransportConnection:

Public Member Functions

 DcmTransportConnection (DcmNativeSocketType openSocket)
 constructor. More...
 
virtual ~DcmTransportConnection ()
 destructor
 
virtual OFCondition serverSideHandshake ()=0
 performs server side handshake on established socket. More...
 
virtual OFCondition clientSideHandshake ()=0
 performs client side handshake on established socket. More...
 
virtual OFCondition renegotiate (const char *newSuite)=0
 performs a re-negotiation of the connection with different connection parameters. More...
 
virtual ssize_t read (void *buf, size_t nbyte)=0
 attempts to read nbyte bytes from the transport connection and writes them into the given buffer. More...
 
virtual ssize_t write (void *buf, size_t nbyte)=0
 attempts to write nbyte bytes from the given buffer to the transport connection. More...
 
virtual void close ()=0
 Closes the transport connection. More...
 
virtual void closeTransportConnection ()=0
 Closes the transport connection directly. More...
 
virtual unsigned long getPeerCertificateLength ()=0
 returns the size in bytes of the peer certificate of a secure connection. More...
 
virtual OFBool networkDataAvailable (int timeout)=0
 checks if data is available to be read on the transport connection. More...
 
virtual OFBool isTransparentConnection ()=0
 returns OFTrue if this connection is a transparent TCP connection, OFFalse if the connection is a secure connection.
 
virtual OFStringdumpConnectionParameters (OFString &str)=0
 dump the characteristics of the current connection More...
 
OFdeprecated void dumpConnectionParameters (STD_NAMESPACE ostream &out)
 prints the characteristics of the current connection on the given output stream. More...
 

Static Public Member Functions

static OFBool selectReadableAssociation (DcmTransportConnection *connections[], int connCount, int timeout)
 indicates which of the specified transport connections is ready for reading. More...
 

Protected Member Functions

DcmNativeSocketType getSocket ()
 returns the socket file descriptor managed by this object. More...
 
void setSocket (DcmNativeSocketType socket)
 set the socket file descriptor managed by this object. More...
 

Private Member Functions

 DcmTransportConnection (const DcmTransportConnection &)
 private undefined copy constructor
 
DcmTransportConnectionoperator= (const DcmTransportConnection &)
 private undefined assignment operator
 

Static Private Member Functions

static OFBool safeSelectReadableAssociation (DcmTransportConnection *connections[], int connCount, int timeout)
 indicates which of the specified transport connections is ready for reading. More...
 
static OFBool fastSelectReadableAssociation (DcmTransportConnection *connections[], int connCount, int timeout)
 indicates which of the specified transport connections is ready for reading. More...
 

Private Attributes

DcmNativeSocketType theSocket
 the socket file descriptor/handle used by the transport connection.
 

Detailed Description

this class represents a TCP/IP based transport connection which can be a transparent TCP/IP socket communication or a secure transport protocol such as TLS.

Constructor & Destructor Documentation

◆ DcmTransportConnection()

DcmTransportConnection::DcmTransportConnection ( DcmNativeSocketType  openSocket)

constructor.

Parameters
openSocketTCP/IP socket to be used for the transport connection. the connection must already be established on socket level. This object takes over control of the socket.

Member Function Documentation

◆ clientSideHandshake()

virtual OFCondition DcmTransportConnection::clientSideHandshake ( )
pure virtual

performs client side handshake on established socket.

This function is used to establish a secure transport connection over the established TCP connection. Abstract method.

Returns
EC_Normal if successful, an error code otherwise.

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ close()

virtual void DcmTransportConnection::close ( )
pure virtual

Closes the transport connection.

If a secure connection is used, a closure alert is sent before the connection is closed. Abstract method.

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ closeTransportConnection()

virtual void DcmTransportConnection::closeTransportConnection ( )
pure virtual

Closes the transport connection directly.

If a secure connection is used, a closure alert is NOT sent before the connection is closed. Abstract method.

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ dumpConnectionParameters() [1/2]

virtual OFString & DcmTransportConnection::dumpConnectionParameters ( OFString str)
pure virtual

dump the characteristics of the current connection

Parameters
strthe string to dump into
Returns
reference to string

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ dumpConnectionParameters() [2/2]

OFdeprecated void DcmTransportConnection::dumpConnectionParameters ( STD_NAMESPACE ostream &  out)

prints the characteristics of the current connection on the given output stream.

Parameters
outoutput stream
Deprecated:
Please use the other dumpConnectionParameters() function instead!

◆ fastSelectReadableAssociation()

static OFBool DcmTransportConnection::fastSelectReadableAssociation ( DcmTransportConnection connections[],
int  connCount,
int  timeout 
)
staticprivate

indicates which of the specified transport connections is ready for reading.

If none of the specified transport connections is ready for reading, this method blocks up to the specified timeout interval or until one of the connections becomes readable, whatever occurs first. This method uses the poll() or select() system call. It may only be used with an array of transparent TCP transport connections. This precondition must be assured by the caller.

Parameters
connectionslist of transport connections. May contain NULL entries. Upon successful return of this method, all transport connections which are not ready for reading are set to NULL in this array.
connCountnumber of entries in connections array.
timeoutnumber of seconds for timeout. If timeout is 0, this method does not block.
Returns
OFTrue if one or more connections are readable upon return from this method, OFFalse if no connection is ready for reading.

◆ getPeerCertificateLength()

virtual unsigned long DcmTransportConnection::getPeerCertificateLength ( )
pure virtual

returns the size in bytes of the peer certificate of a secure connection.

May return 0 if connection is transparent TCP/IP.

Returns
peer certificate length in bytes

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ getSocket()

DcmNativeSocketType DcmTransportConnection::getSocket ( )
inlineprotected

returns the socket file descriptor managed by this object.

Returns
socket file descriptor

◆ networkDataAvailable()

virtual OFBool DcmTransportConnection::networkDataAvailable ( int  timeout)
pure virtual

checks if data is available to be read on the transport connection.

Abstract method.

Parameters
timeoutmaximum number of seconds to wait if no data is available. If this parameter is 0, the function does not block.
Returns
OFTrue if data is available, OFFalse otherwise.

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ read()

virtual ssize_t DcmTransportConnection::read ( void *  buf,
size_t  nbyte 
)
pure virtual

attempts to read nbyte bytes from the transport connection and writes them into the given buffer.

Abstract method.

Parameters
bufbuffer
nbytenumber of bytes to read
Returns
number of bytes read, negative number if unsuccessful.

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ renegotiate()

virtual OFCondition DcmTransportConnection::renegotiate ( const char *  newSuite)
pure virtual

performs a re-negotiation of the connection with different connection parameters.

Used to change the parameters of the secure transport connection. Abstract method.

Parameters
newSuitestring identifying the ciphersuite to be negotiated.
Returns
EC_Normal if successful, an error code otherwise.

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ safeSelectReadableAssociation()

static OFBool DcmTransportConnection::safeSelectReadableAssociation ( DcmTransportConnection connections[],
int  connCount,
int  timeout 
)
staticprivate

indicates which of the specified transport connections is ready for reading.

If none of the specified transport connections is ready for reading, this method blocks up to the specified timeout interval or until one of the connections becomes readable, whatever occurs first. This method uses a safe approach that also works with secure transport connections, but which may be slower than a select() system call and consumes slightly more computation time.

Parameters
connectionslist of transport connections. May contain NULL entries. Upon successful return of this method, all transport connections which are not ready for reading are set to NULL in this array.
connCountnumber of entries in connections array.
timeoutnumber of seconds for timeout. If timeout is 0, this method does not block.
Returns
OFTrue if one or more connections are readable upon return from this method, OFFalse if no connection is ready for reading.

◆ selectReadableAssociation()

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

indicates which of the specified transport connections is ready for reading.

If none of the specified transport connections is ready for reading, this method blocks up to the specified timeout interval or until one of the connections becomes readable, whatever occurs first.

Parameters
connectionslist of transport connections. May contain NULL entries. Upon successful return of this method, all transport connections which are not ready for reading are set to NULL in this array.
connCountnumber of entries in connections array.
timeoutnumber of seconds for timeout. If timeout is 0, this method does not block.
Returns
OFTrue if one or more connections are readable upon return from this method, OFFalse if no connection is ready for reading.

◆ serverSideHandshake()

virtual OFCondition DcmTransportConnection::serverSideHandshake ( )
pure virtual

performs server side handshake on established socket.

This function is used to establish a secure transport connection over the established TCP connection. Abstract method.

Returns
EC_Normal if successful, an error code otherwise.

Implemented in DcmTCPConnection, and DcmTLSConnection.

◆ setSocket()

void DcmTransportConnection::setSocket ( DcmNativeSocketType  socket)
inlineprotected

set the socket file descriptor managed by this object.

Parameters
socketfile descriptor

◆ write()

virtual ssize_t DcmTransportConnection::write ( void *  buf,
size_t  nbyte 
)
pure virtual

attempts to write nbyte bytes from the given buffer to the transport connection.

Abstract method.

Parameters
bufbuffer
nbytenumber of bytes to write
Returns
number of bytes written, negative number if unsuccessful.

Implemented in DcmTCPConnection, and DcmTLSConnection.


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


Generated on Tue Dec 19 2023 for DCMTK Version 3.6.8 by Doxygen 1.9.4