KD SOAP API Documentation  2.2
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
KDSoapServer Class Referenceabstract

#include <KDSoapServer.h>

Inheritance diagram for KDSoapServer:
Inheritance graph
[legend]
Collaboration diagram for KDSoapServer:
Collaboration graph
[legend]

Public Types

enum  Feature { Public = 0 , Ssl = 1 , AuthRequired = 2 }
 
enum  LogLevel { LogNothing , LogFaults , LogEveryCall }
 

Public Slots

void resume ()
 
void suspend ()
 

Signals

void connectionRejected ()
 

Public Member Functions

 KDSoapServer (QObject *parent=0)
 
 ~KDSoapServer ()
 
void closeLogFile ()
 
virtual QObject * createServerObject ()=0
 
QString endPoint () const
 
Features features () const
 
void flushLogFile ()
 
QString logFileName () const
 
LogLevel logLevel () const
 
int maxConnections () const
 
int numConnectedSockets () const
 
QString path () const
 
void resetTotalConnectionCount ()
 
void setFeatures (Features features)
 
void setLogFileName (const QString &fileName)
 
void setLogLevel (LogLevel level)
 
void setMaxConnections (int sockets)
 
void setPath (const QString &path)
 
void setSslConfiguration (const QSslConfiguration &config)
 
void setThreadPool (KDSoapThreadPool *threadPool)
 
void setUse (KDSoapMessage::Use use)
 
void setWsdlFile (const QString &file, const QString &pathInUrl)
 
QSslConfiguration sslConfiguration () const
 
KDSoapThreadPoolthreadPool () const
 
int totalConnectionCount () const
 
KDSoapMessage::Use use () const
 
QString wsdlFile () const
 
QString wsdlPathInUrl () const
 

Static Public Member Functions

static bool setExpectedSocketCount (int sockets)
 

Protected Member Functions

void incomingConnection (qintptr socketDescriptor) override
 

Detailed Description

HTTP soap server.

Every instance of KDSoapServer represents one service, listening on one port. Call the listen() method from QTcpServer in order to start listening on a port.

KDSoapServer is a base class for your server, you must inherit from it and reimplement the method createServerObject().

Definition at line 29 of file KDSoapServer.h.

Member Enumeration Documentation

◆ Feature

Enumerator
Public 

HTTP with no ssl and no authentication needed (default)

Ssl 

HTTPS.

AuthRequired 

Requires authentication. Currently not implemented, patches welcome.

Definition at line 46 of file KDSoapServer.h.

◆ LogLevel

Enumerator
LogNothing 
LogFaults 
LogEveryCall 

Definition at line 124 of file KDSoapServer.h.

Constructor & Destructor Documentation

◆ KDSoapServer()

KDSoapServer::KDSoapServer ( QObject *  parent = 0)
explicit

Constructs a Soap Server.

By default it will not use threads to handle requests, see setThreadPool for that.

Definition at line 65 of file KDSoapServer.cpp.

◆ ~KDSoapServer()

KDSoapServer::~KDSoapServer ( )

Destructor. Deletes the server object factory as well.

Definition at line 73 of file KDSoapServer.cpp.

Member Function Documentation

◆ closeLogFile()

void KDSoapServer::closeLogFile ( )

Close the log file. This can be used to then rename it, in order to implement log file rotation.

Definition at line 214 of file KDSoapServer.cpp.

◆ connectionRejected

void KDSoapServer::connectionRejected ( )
signal

Emitted when the maximum number of connections has been reached, and a client connection was just rejected.

Referenced by incomingConnection().

◆ createServerObject()

virtual QObject* KDSoapServer::createServerObject ( )
pure virtual

Reimplement this method to create an application-specific server object to handle incoming requests. Important: the created object must derive from KDSoapServerObjectInterface and must use Q_INTERFACES(KDSoapServerObjectInterface) under the Q_OBJECT macro.

When using a thread pool, this method will be called from different threads. The server takes ownership of the created object.

◆ endPoint()

QString KDSoapServer::endPoint ( ) const

Returns the HTTP URL which can be used to access this server. For instance "http://127.0.0.1:8000/".

If the server is listening for connections yet, returns an empty string.

Definition at line 138 of file KDSoapServer.cpp.

References Ssl.

◆ features()

KDSoapServer::Features KDSoapServer::features ( ) const

Returns the features of the server that were enabled.

Definition at line 346 of file KDSoapServer.cpp.

Referenced by KDSoapSocketList::handleIncomingConnection(), and setFeatures().

◆ flushLogFile()

void KDSoapServer::flushLogFile ( )

Force flushing the log file to disk.

Definition at line 207 of file KDSoapServer.cpp.

◆ incomingConnection()

void KDSoapServer::incomingConnection ( qintptr  socketDescriptor)
overrideprotected

Definition at line 78 of file KDSoapServer.cpp.

References connectionRejected(), maxConnections(), and numConnectedSockets().

◆ logFileName()

QString KDSoapServer::logFileName ( ) const

Returns the name of the log file given to setLogFileName().

Definition at line 180 of file KDSoapServer.cpp.

◆ logLevel()

KDSoapServer::LogLevel KDSoapServer::logLevel ( ) const

Returns the level of logging set by setLogLevel.

Definition at line 168 of file KDSoapServer.cpp.

Referenced by KDSoapServerSocket::sendReply().

◆ maxConnections()

int KDSoapServer::maxConnections ( ) const

Returns the maximum of concurrent connections as set by setMaxConnections.

The special value -1 means unlimited.

Definition at line 334 of file KDSoapServer.cpp.

Referenced by incomingConnection().

◆ numConnectedSockets()

int KDSoapServer::numConnectedSockets ( ) const

Returns the number of connected sockets at this precise moment. This information can change at any time, and is therefore only useful for statistical purposes.

It will always be less than maxConnections(), if maxConnections was set.

Definition at line 97 of file KDSoapServer.cpp.

Referenced by incomingConnection().

◆ path()

QString KDSoapServer::path ( ) const

Returns the path set by setPath()

Definition at line 322 of file KDSoapServer.cpp.

Referenced by setPath().

◆ resetTotalConnectionCount()

void KDSoapServer::resetTotalConnectionCount ( )

Resets totalConnectionCount to 0.

Since
1.2

Definition at line 119 of file KDSoapServer.cpp.

◆ resume

void KDSoapServer::resume ( )
slot

Resume activity after suspend

Definition at line 285 of file KDSoapServer.cpp.

◆ setExpectedSocketCount()

bool KDSoapServer::setExpectedSocketCount ( int  sockets)
static

Sets the number of expected sockets (connections) in this process. This is necessary in order to increase system limits when a large number of clients is expected.

The special value -1 means "as many as possible in this non-root process". Only processes running as root can set the absolute maximum to an arbitrary value.

Definition at line 221 of file KDSoapServer.cpp.

◆ setFeatures()

void KDSoapServer::setFeatures ( Features  features)

Set all the features of the server that should be enabled. For instance, the use of SSL, or the use of authentication.

Definition at line 340 of file KDSoapServer.cpp.

References features().

◆ setLogFileName()

void KDSoapServer::setLogFileName ( const QString &  fileName)

Sets the name of the file where logging should go. The server always appends to this file, you should delete it or rename it first if you don't want an ever-growing log file.

Definition at line 174 of file KDSoapServer.cpp.

◆ setLogLevel()

void KDSoapServer::setLogLevel ( KDSoapServer::LogLevel  level)

Sets the level of logging to be used by this SOAP server:

  • LogNothing: no logging (the default).
  • LogFaults: log all faults.
  • LogEveryCall: log every call, successful or not.

Warning: enabling logging reduces performance severely. Not only because of the time spent logging, but also because the threads can only write one at a time to the file, to avoid mixed output.

Definition at line 162 of file KDSoapServer.cpp.

◆ setMaxConnections()

void KDSoapServer::setMaxConnections ( int  sockets)

Sets a maximum number of concurrent connections to this server. When this number is reached, connections are rejected, and the signal clientConnectionRejected is emitted for each rejected connection.

The special value -1 means unlimited.

Definition at line 328 of file KDSoapServer.cpp.

◆ setPath()

void KDSoapServer::setPath ( const QString &  path)

Sets the path that the server expects in client requests. By default the path is '/', but this can be changed here.

The path is returned in endPoint(), and is checked when handling incoming requests.

Definition at line 316 of file KDSoapServer.cpp.

References path().

◆ setSslConfiguration()

void KDSoapServer::setSslConfiguration ( const QSslConfiguration &  config)

Sets the ssl configuration to use for new server connections

Parameters
configssl configuration to use for new connections

Definition at line 358 of file KDSoapServer.cpp.

◆ setThreadPool()

void KDSoapServer::setThreadPool ( KDSoapThreadPool threadPool)

Sets the thread pool for this server. This is useful if you want to share a thread pool between multiple server instances, in order to ensure an overall maximum of threads, across multiple services. An existing thread pool will be removed, but not deleted. KDSoapServer does not take ownership of the thread pool.

Definition at line 128 of file KDSoapServer.cpp.

References threadPool().

◆ setUse()

void KDSoapServer::setUse ( KDSoapMessage::Use  use)

Define the way the message should be serialized: with or without type information. This value usually comes from the <binding> element in the WSDL service description. The default value is KDSoapMessage::LiteralUse.

See also
KDSoapMessage::Use

Definition at line 152 of file KDSoapServer.cpp.

References use().

◆ setWsdlFile()

void KDSoapServer::setWsdlFile ( const QString &  file,
const QString &  pathInUrl 
)

Sets the .wsdl file that users can download from the soap server.

Parameters
filerelative or absolute path to the .wsdl file (including the filename), on disk
pathInUrlthat clients can use in order to download the file: for instance "/files/myservice.wsdl" for "https://myserver.example.com/files/myservice.wsdl" as final URL.

Definition at line 297 of file KDSoapServer.cpp.

◆ sslConfiguration()

QSslConfiguration KDSoapServer::sslConfiguration ( ) const
Returns
the ssl configuration for this server

Definition at line 353 of file KDSoapServer.cpp.

Referenced by KDSoapSocketList::handleIncomingConnection().

◆ suspend

void KDSoapServer::suspend ( )
slot

Temporarily suspend (do not listen to incoming connections, and close all connected sockets after servicing current requests).

Definition at line 271 of file KDSoapServer.cpp.

◆ threadPool()

KDSoapThreadPool * KDSoapServer::threadPool ( ) const

Returns the thread pool for this server, or 0 if no thread pool was set.

Definition at line 133 of file KDSoapServer.cpp.

Referenced by setThreadPool().

◆ totalConnectionCount()

int KDSoapServer::totalConnectionCount ( ) const

Returns the number of sockets that have connected to the server since the last call to resetTotalConnectionCount().

Since
1.2

Definition at line 108 of file KDSoapServer.cpp.

◆ use()

KDSoapMessage::Use KDSoapServer::use ( ) const

Returns the value passed to setUse().

Definition at line 157 of file KDSoapServer.cpp.

Referenced by setUse().

◆ wsdlFile()

QString KDSoapServer::wsdlFile ( ) const
Returns
the path to the wsdl file on disk, as given to setWsdlFile

Definition at line 304 of file KDSoapServer.cpp.

◆ wsdlPathInUrl()

QString KDSoapServer::wsdlPathInUrl ( ) const
Returns
the path given to setWsdlFile

Definition at line 310 of file KDSoapServer.cpp.


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

© 2010-2024 Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
https://www.kdab.com/development-resources/qt-tools/kd-soap/
Generated by doxygen 1.9.1