KIO::TCPSlaveBase Class Reference
There are two classes that specifies the protocol between application (job) and kioslave. More...
#include <tcpslavebase.h>
Inheritance diagram for KIO::TCPSlaveBase:

Protected Methods | |
KDE_DEPRECATED ssize_t | Write (const void *data, ssize_t len) |
KDE_DEPRECATED ssize_t | Read (void *data, ssize_t len) |
KDE_DEPRECATED ssize_t | ReadLine (char *data, ssize_t len) |
KDE_DEPRECATED unsigned short int | GetPort (unsigned short int p) |
KDE_DEPRECATED bool | ConnectToHost (const QString &host, unsigned int port, bool sendError) |
KDE_DEPRECATED void | CloseDescriptor () |
KDE_DEPRECATED bool | AtEOF () |
KDE_DEPRECATED bool | InitializeSSL () |
KDE_DEPRECATED void | CleanSSL () |
ssize_t | write (const void *data, ssize_t len) |
ssize_t | read (void *data, ssize_t len) |
ssize_t | readLine (char *data, ssize_t len) |
void | setBlockSize (int sz) |
unsigned short int | port (unsigned short int _port) |
bool | connectToHost (const QString &host, unsigned int port, bool sendError=true) |
bool | usingSSL () const |
bool | usingTLS () const |
bool | usingTLS () |
bool | canUseTLS () |
int | startTLS () |
void | stopTLS () |
void | closeDescriptor () |
bool | atEnd () |
void | setSSLMetaData () |
bool | initializeSSL () |
void | cleanSSL () |
bool | isConnectionValid () |
int | connectResult () |
bool | waitForResponse (int t) |
void | setBlockConnection (bool b) |
void | setConnectTimeout (int t) |
bool | isSSLTunnelEnabled () |
void | setEnableSSLTunnel (bool enable) |
void | setRealHost (const QString &realHost) |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
There are two classes that specifies the protocol between application (job) and kioslave.SlaveInterface is the class to use on the application end, SlaveBase is the one to use on the slave end.
Slave implementations should simply inherit SlaveBase
A call to foo() results in a call to slotFoo() on the other end.
Definition at line 49 of file tcpslavebase.h.
Member Function Documentation
|
Definition at line 67 of file tcpslavebase.h. References KIO::SlaveBase::data(), and write(). |
|
Definition at line 72 of file tcpslavebase.h. References KIO::SlaveBase::data(), and read(). |
|
Definition at line 77 of file tcpslavebase.h. References KIO::SlaveBase::data(), and readLine(). |
|
Definition at line 82 of file tcpslavebase.h. References port(). |
|
Definition at line 87 of file tcpslavebase.h. References connectToHost(), and port(). |
|
Definition at line 93 of file tcpslavebase.h. References closeDescriptor(). |
|
Definition at line 98 of file tcpslavebase.h. References atEnd(). |
|
Definition at line 103 of file tcpslavebase.h. References initializeSSL(). |
|
Definition at line 108 of file tcpslavebase.h. References cleanSSL(). |
|
This function acts like standard write function call except it is also capable of making SSL or SOCKS connections.
Definition at line 148 of file tcpslavebase.cpp. References KIO::SlaveBase::data(), KSocks::self(), and KSocks::write(). Referenced by Write(). |
|
This function acts like standard read function call except it is also capable of deciphering SSL data as well as handling data over SOCKSified connections.
Definition at line 159 of file tcpslavebase.cpp. References KIO::SlaveBase::data(), KSocks::read(), and KSocks::self(). Referenced by Read(). |
|
Same as above except it reads data one line at a time.
Definition at line 180 of file tcpslavebase.cpp. References KIO::SlaveBase::data(), KSocks::read(), and KSocks::self(). Referenced by ReadLine(). |
|
Sets the maximum size of blocks read in during calls to readLine(). This allows a slave to optimize for the protocol which it implements. Ideally this should be (common_line_length+1) or so. Making this too large will have adverse effects on performance. Initial/default value is 256(bytes) Definition at line 171 of file tcpslavebase.cpp. |
|
Determines the appropriate port to use. This functions attempts to discover the appropriate port.
Definition at line 268 of file tcpslavebase.cpp. Referenced by ConnectToHost(), connectToHost(), and GetPort(). |
|
Performs the initial TCP connection stuff and/or SSL handshaking as necessary. Please note that unlike its deprecated counterpart, this function allows you to disable any error message from being sent back to the calling application! You can then use the connectResult() function to determine the result of the request for connection.
Definition at line 286 of file tcpslavebase.cpp. References KExtendedSocket::blockingMode(), closeDescriptor(), KExtendedSocket::connect(), KIO::SlaveBase::error(), KExtendedSocket::fd(), KIO::SlaveBase::messageBox(), KIO::SlaveBase::metaData(), KSocketAddress::nodeName(), KExtendedSocket::peerAddress(), port(), KExtendedSocket::release(), KExtendedSocket::setAddress(), KExtendedSocket::setBlockingMode(), KIO::SlaveBase::setMetaData(), KExtendedSocket::setTimeout(), and KSSLSettings::warnOnLeave(). Referenced by ConnectToHost(). |
|
Are we using SSL?
Definition at line 187 of file tcpslavebase.h. |
|
Are we using TLS?
Definition at line 722 of file tcpslavebase.cpp. |
|
Definition at line 728 of file tcpslavebase.cpp. |
|
Can we use TLS?
Definition at line 490 of file tcpslavebase.cpp. References KSSL::doesSSLWork(), and KSSLSettings::tlsv1(). |
|
Start using TLS on the connection.
Definition at line 417 of file tcpslavebase.cpp. References KSSL::doesSSLWork(), KSSLSession::fromString(), KIO::SlaveBase::hasMetaData(), KIO::SlaveBase::metaData(), and KIO::SlaveBase::setMetaData(). |
|
Stop using TLS on the connection.
Definition at line 472 of file tcpslavebase.cpp. References KIO::SlaveBase::setMetaData(). Referenced by closeDescriptor(). |
|
Closes the current file descriptor. Call this function to properly close up the socket since it also takes care to prroperly close the stdio fstream stuff, as well as sets the socket back to -1 Definition at line 372 of file tcpslavebase.cpp. References stopTLS(). Referenced by CloseDescriptor(), and connectToHost(). |
|
Returns true when end of data is reached.
Definition at line 412 of file tcpslavebase.cpp. Referenced by AtEOF(). |
|
Call this if you use persistent connections and want all the metadata restored. This is particularly important for SSL sessions since the app needs to know the state of connection, certificates, etc. Definition at line 482 of file tcpslavebase.cpp. |
|
Initializs all SSL variables.
Definition at line 390 of file tcpslavebase.cpp. References KSSL::doesSSLWork(). Referenced by InitializeSSL(). |
|
Cleans up all SSL settings.
Definition at line 401 of file tcpslavebase.cpp. Referenced by CleanSSL(). |
|
Determines whether or not we are still connected to the remote machine. This method may fail to detect a closed SSL connection.
return Definition at line 1115 of file tcpslavebase.cpp. References KSocks::recv(), KSocks::select(), KSocks::self(), and KIO::SlaveBase::wasKilled(). |
|
Returns the status of the connection.
This function allows you to invoke ConnectToHost with the
Definition at line 1205 of file tcpslavebase.cpp. |
|
Wait for some type of activity on the socket for the period specified by
Definition at line 1160 of file tcpslavebase.cpp. References KSocks::select(), KSocks::self(), and KIO::SlaveBase::wasKilled(). |
|
Sets the mode of the connection to blocking or non-blocking.
Be sure to call this function before calling connectToHost. Otherwise, this setting will not have any effect until the next
Definition at line 1210 of file tcpslavebase.cpp. |
|
Sets how long to wait for orignally connecting to the requested before timinig out.
Be sure to call this function before calling ConnectToHost, otherwise the setting will not take effect until the next call to
Definition at line 1215 of file tcpslavebase.cpp. |
|
Returns true if SSL tunneling is enabled.
Definition at line 1220 of file tcpslavebase.cpp. |
|
Set up SSL tunneling mode.
Calling this function with a Note that once you have successfully "tunneled" through the proxy server you must call this function with its argument set to false to properly connect to the SSL site.
Definition at line 1225 of file tcpslavebase.cpp. |
|
Sets up the the real hostname for an SSL connection that goes through a proxy server. This function is essential in making sure that the real hostname is used for validating certificates from SSL sites!
Definition at line 1230 of file tcpslavebase.cpp. |
The documentation for this class was generated from the following files: