KTcpSocket Class Reference

#include <ktcpsocket.h>

Inheritance diagram for KTcpSocket:

Public Types
enum	EncryptionMode { UnencryptedMode = 0, SslClientMode, SslServerMode }
enum	Error {   UnknownError = 0, ConnectionRefusedError, RemoteHostClosedError, HostNotFoundError,   SocketAccessError, SocketResourceError, SocketTimeoutError, NetworkError,   UnsupportedSocketOperationError, SslHandshakeFailedError }
enum	ProxyPolicy { AutoProxy = 0, ManualProxy }
enum	SslVersion {   UnknownSslVersion = 0x01, SslV2 = 0x02, SslV3 = 0x04, TlsV1 = 0x08,   SslV3_1 = 0x08, TlsV1SslV3 = 0x10, SecureProtocols = 0x20, AnySslVersion = SslV2 | SslV3 | TlsV1 }
enum	State {   UnconnectedState = 0, HostLookupState, ConnectingState, ConnectedState,   BoundState, ListeningState, ClosingState }

Public Slots
void	ignoreSslErrors ()
void	startClientEncryption ()

Signals
void	connected ()
void	disconnected ()
void	encrypted ()
void	encryptedBytesWritten (qint64 written)
void	encryptionModeChanged (EncryptionMode)
void	error (KTcpSocket::Error)
void	hostFound ()
void	proxyAuthenticationRequired (const QNetworkProxy &proxy, QAuthenticator *authenticator)
void	sslErrors (const QList< KSslError > &errors)
void	stateChanged (KTcpSocket::State)

Public Member Functions
	KTcpSocket (QObject *parent=0)
	~KTcpSocket ()
void	abort ()
void	addCaCertificate (const QSslCertificate &certificate)
void	addCaCertificates (const QList< QSslCertificate > &certificates)
SslVersion	advertisedSslVersion () const
virtual bool	atEnd () const
virtual qint64	bytesAvailable () const
virtual qint64	bytesToWrite () const
QList< QSslCertificate >	caCertificates () const
virtual bool	canReadLine () const
QList< KSslCipher >	ciphers () const
virtual void	close ()
void	connectToHost (const QString &hostName, quint16 port, ProxyPolicy policy=AutoProxy)
void	connectToHost (const QHostAddress &hostAddress, quint16 port, ProxyPolicy policy=AutoProxy)
void	connectToHost (const KUrl &url, ProxyPolicy policy=AutoProxy)
void	connectToHostEncrypted (const QString &hostName, quint16 port, OpenMode openMode=ReadWrite)
void	disconnectFromHost ()
EncryptionMode	encryptionMode () const
Error	error () const
bool	flush ()
virtual bool	isSequential () const
bool	isValid () const
QHostAddress	localAddress () const
QSslCertificate	localCertificate () const
SslVersion	negotiatedSslVersion () const
QString	negotiatedSslVersionName () const
virtual bool	open (QIODevice::OpenMode open)
QHostAddress	peerAddress () const
QList< QSslCertificate >	peerCertificateChain () const
QString	peerName () const
quint16	peerPort () const
KSslKey	privateKey () const
QNetworkProxy	proxy () const
qint64	readBufferSize () const
KSslCipher	sessionCipher () const
void	setAdvertisedSslVersion (SslVersion version)
void	setCaCertificates (const QList< QSslCertificate > &certificates)
void	setCiphers (const QList< KSslCipher > &ciphers)
void	setLocalCertificate (const QSslCertificate &certificate)
void	setLocalCertificate (const QString &fileName, QSsl::EncodingFormat format=QSsl::Pem)
void	setPrivateKey (const KSslKey &key)
void	setPrivateKey (const QString &fileName, KSslKey::Algorithm algorithm=KSslKey::Rsa, QSsl::EncodingFormat format=QSsl::Pem, const QByteArray &passPhrase=QByteArray())
void	setProxy (const QNetworkProxy &proxy)
void	setReadBufferSize (qint64 size)
void	setSocketOption (QAbstractSocket::SocketOption options, const QVariant &value)
void	setSslConfiguration (const QSslConfiguration &configuration)
void	setVerificationPeerName (const QString &hostName)
QVariant	socketOption (QAbstractSocket::SocketOption options) const
QSslConfiguration	sslConfiguration () const
QList< KSslError >	sslErrors () const
State	state () const
virtual bool	waitForBytesWritten (int msecs)
bool	waitForConnected (int msecs=30000)
bool	waitForDisconnected (int msecs=30000)
bool	waitForEncrypted (int msecs=30000)
virtual bool	waitForReadyRead (int msecs=30000)

Protected Member Functions
virtual qint64	readData (char *data, qint64 maxSize)
virtual qint64	writeData (const char *data, qint64 maxSize)

Detailed Description

Definition at line 144 of file ktcpsocket.h.

Member Enumeration Documentation

EncryptionMode

enum KTcpSocket::EncryptionMode

Enumerator
UnencryptedMode
SslClientMode
SslServerMode

Definition at line 213 of file ktcpsocket.h.

Error

enum KTcpSocket::Error

Enumerator
UnknownError
ConnectionRefusedError
RemoteHostClosedError
HostNotFoundError
SocketAccessError
SocketResourceError
SocketTimeoutError
NetworkError
UnsupportedSocketOperationError
SslHandshakeFailedError	Since 4.10.5

Definition at line 169 of file ktcpsocket.h.

ProxyPolicy

enum KTcpSocket::ProxyPolicy

Enumerator
AutoProxy	Use the proxy that KProtocolManager suggests for the connection parameters given.
ManualProxy	Use the proxy set by setProxy(), if any; otherwise use no proxy.

Definition at line 218 of file ktcpsocket.h.

SslVersion

enum KTcpSocket::SslVersion

Enumerator
UnknownSslVersion
SslV2
SslV3
TlsV1
SslV3_1
TlsV1SslV3
SecureProtocols
AnySslVersion

Definition at line 158 of file ktcpsocket.h.

State

enum KTcpSocket::State

Enumerator
UnconnectedState
HostLookupState
ConnectingState
ConnectedState
BoundState
ListeningState
ClosingState

Definition at line 148 of file ktcpsocket.h.

Constructor & Destructor Documentation

KTcpSocket()

KTcpSocket::KTcpSocket

(

QObject *

parent = 0

)

Definition at line 395 of file ktcpsocket.cpp.

~KTcpSocket()

KTcpSocket::~KTcpSocket

(

)

Definition at line 424 of file ktcpsocket.cpp.

Member Function Documentation

abort()

void KTcpSocket::abort

(

)

Definition at line 501 of file ktcpsocket.cpp.

addCaCertificate()

void KTcpSocket::addCaCertificate

(

const QSslCertificate &

certificate

)

Definition at line 657 of file ktcpsocket.cpp.

addCaCertificates()

void KTcpSocket::addCaCertificates

(

const QList< QSslCertificate > &

certificates

)

Definition at line 674 of file ktcpsocket.cpp.

advertisedSslVersion()

KTcpSocket::SslVersion KTcpSocket::advertisedSslVersion

(

)

const

Definition at line 857 of file ktcpsocket.cpp.

atEnd()

bool KTcpSocket::atEnd ( ) const

virtual

Definition at line 431 of file ktcpsocket.cpp.

bytesAvailable()

qint64 KTcpSocket::bytesAvailable ( ) const

virtual

Definition at line 437 of file ktcpsocket.cpp.

bytesToWrite()

qint64 KTcpSocket::bytesToWrite ( ) const

virtual

Definition at line 443 of file ktcpsocket.cpp.

caCertificates()

QList< QSslCertificate > KTcpSocket::caCertificates

(

)

const

Definition at line 681 of file ktcpsocket.cpp.

canReadLine()

bool KTcpSocket::canReadLine ( ) const

virtual

Definition at line 449 of file ktcpsocket.cpp.

ciphers()

QList< KSslCipher > KTcpSocket::ciphers

(

)

const

Definition at line 688 of file ktcpsocket.cpp.

close()

void KTcpSocket::close ( )

virtual

Definition at line 455 of file ktcpsocket.cpp.

connected

void KTcpSocket::connected ( )

signal

connectToHost() [1/3]

void KTcpSocket::connectToHost	(	const QString &	hostName,
		quint16	port,
		ProxyPolicy	policy = AutoProxy
	)

Definition at line 507 of file ktcpsocket.cpp.

connectToHost() [2/3]

void KTcpSocket::connectToHost	(	const QHostAddress &	hostAddress,
		quint16	port,
		ProxyPolicy	policy = AutoProxy
	)

Definition at line 523 of file ktcpsocket.cpp.

connectToHost() [3/3]

void KTcpSocket::connectToHost	(	const KUrl &	url,
		ProxyPolicy	policy = AutoProxy
	)

Take the hostname and port from url and connect to them.

The information from a full URL enables the most accurate choice of proxy in case of proxy rules that depend on high-level information like protocol or username.

See also

KProtocolManager::proxyForUrl()

Definition at line 533 of file ktcpsocket.cpp.

connectToHostEncrypted()

void KTcpSocket::connectToHostEncrypted	(	const QString &	hostName,
		quint16	port,
		OpenMode	openMode = ReadWrite
	)

Definition at line 694 of file ktcpsocket.cpp.

disconnected

void KTcpSocket::disconnected ( )

signal

disconnectFromHost()

void KTcpSocket::disconnectFromHost

(

)

Definition at line 543 of file ktcpsocket.cpp.

encrypted

void KTcpSocket::encrypted ( )

signal

encryptedBytesWritten

void KTcpSocket::encryptedBytesWritten ( qint64  written )

signal

Since

4.8.1 Forwarded from QSslSocket

encryptionMode()

KTcpSocket::EncryptionMode KTcpSocket::encryptionMode

(

)

const

Definition at line 802 of file ktcpsocket.cpp.

encryptionModeChanged

void KTcpSocket::encryptionModeChanged ( EncryptionMode  )

signal

error() [1/2]

KTcpSocket::Error KTcpSocket::error

(

)

const

Definition at line 550 of file ktcpsocket.cpp.

error [2/2]

void KTcpSocket::error ( KTcpSocket::Error  )

signal

flush()

bool KTcpSocket::flush

(

)

Definition at line 568 of file ktcpsocket.cpp.

hostFound

void KTcpSocket::hostFound ( )

signal

ignoreSslErrors

void KTcpSocket::ignoreSslErrors ( )

slot

Definition at line 828 of file ktcpsocket.cpp.

isSequential()

bool KTcpSocket::isSequential ( ) const

virtual

Definition at line 462 of file ktcpsocket.cpp.

isValid()

bool KTcpSocket::isValid

(

)

const

Definition at line 574 of file ktcpsocket.cpp.

localAddress()

QHostAddress KTcpSocket::localAddress

(

)

const

Definition at line 580 of file ktcpsocket.cpp.

localCertificate()

QSslCertificate KTcpSocket::localCertificate

(

)

const

Definition at line 703 of file ktcpsocket.cpp.

negotiatedSslVersion()

KTcpSocket::SslVersion KTcpSocket::negotiatedSslVersion

(

)

const

Definition at line 863 of file ktcpsocket.cpp.

negotiatedSslVersionName()

QString KTcpSocket::negotiatedSslVersionName

(

)

const

Definition at line 872 of file ktcpsocket.cpp.

open()

bool KTcpSocket::open ( QIODevice::OpenMode  open )

virtual

Definition at line 468 of file ktcpsocket.cpp.

peerAddress()

QHostAddress KTcpSocket::peerAddress

(

)

const

Definition at line 586 of file ktcpsocket.cpp.

peerCertificateChain()

QList< QSslCertificate > KTcpSocket::peerCertificateChain

(

)

const

Definition at line 709 of file ktcpsocket.cpp.

peerName()

QString KTcpSocket::peerName

(

)

const

Definition at line 592 of file ktcpsocket.cpp.

peerPort()

quint16 KTcpSocket::peerPort

(

)

const

Definition at line 598 of file ktcpsocket.cpp.

privateKey()

KSslKey KTcpSocket::privateKey

(

)

const

Definition at line 715 of file ktcpsocket.cpp.

proxy()

QNetworkProxy KTcpSocket::proxy

(

)

const

See also

: connectToHost()

Definition at line 605 of file ktcpsocket.cpp.

proxyAuthenticationRequired

void KTcpSocket::proxyAuthenticationRequired ( const QNetworkProxy &  proxy, QAuthenticator *  authenticator  )

signal

readBufferSize()

qint64 KTcpSocket::readBufferSize

(

)

const

Definition at line 611 of file ktcpsocket.cpp.

readData()

qint64 KTcpSocket::readData ( char *  data, qint64  maxSize  )

protectedvirtual

Definition at line 488 of file ktcpsocket.cpp.

sessionCipher()

KSslCipher KTcpSocket::sessionCipher

(

)

const

Definition at line 721 of file ktcpsocket.cpp.

setAdvertisedSslVersion()

void KTcpSocket::setAdvertisedSslVersion

(

KTcpSocket::SslVersion

version

)

Definition at line 851 of file ktcpsocket.cpp.

setCaCertificates()

void KTcpSocket::setCaCertificates

(

const QList< QSslCertificate > &

certificates

)

Definition at line 727 of file ktcpsocket.cpp.

setCiphers()

void KTcpSocket::setCiphers

(

const QList< KSslCipher > &

ciphers

)

Definition at line 734 of file ktcpsocket.cpp.

setLocalCertificate() [1/2]

void KTcpSocket::setLocalCertificate

(

const QSslCertificate &

certificate

)

Definition at line 745 of file ktcpsocket.cpp.

setLocalCertificate() [2/2]

void KTcpSocket::setLocalCertificate	(	const QString &	fileName,
		QSsl::EncodingFormat	format = QSsl::Pem
	)

Definition at line 751 of file ktcpsocket.cpp.

setPrivateKey() [1/2]

void KTcpSocket::setPrivateKey

(

const KSslKey &

key

)

Definition at line 767 of file ktcpsocket.cpp.

setPrivateKey() [2/2]

void KTcpSocket::setPrivateKey	(	const QString &	fileName,
		KSslKey::Algorithm	algorithm = KSslKey::Rsa,
		QSsl::EncodingFormat	format = QSsl::Pem,
		const QByteArray &	passPhrase = QByteArray()
	)

Definition at line 782 of file ktcpsocket.cpp.

setProxy()

void KTcpSocket::setProxy

(

const QNetworkProxy &

proxy

)

See also

: connectToHost()

Definition at line 618 of file ktcpsocket.cpp.

setReadBufferSize()

void KTcpSocket::setReadBufferSize

(

qint64

size

)

Definition at line 624 of file ktcpsocket.cpp.

setSocketOption()

void KTcpSocket::setSocketOption	(	QAbstractSocket::SocketOption	options,
		const QVariant &	value
	)

Sets the socket option to value.

See also

QAbstractSocket::setSocketOption

Since

4.5.0

Definition at line 812 of file ktcpsocket.cpp.

setSslConfiguration()

void KTcpSocket::setSslConfiguration

(

const QSslConfiguration &

configuration

)

Sets the socket's SSL configuration.

Since

4.8.4

Definition at line 822 of file ktcpsocket.cpp.

setVerificationPeerName()

void KTcpSocket::setVerificationPeerName

(

const QString &

hostName

)

Definition at line 757 of file ktcpsocket.cpp.

socketOption()

QVariant KTcpSocket::socketOption

(

QAbstractSocket::SocketOption

options

)

const

Returns the state of the socket option.

See also

QAbstractSocket::socketOption

Since

4.5.0

Definition at line 807 of file ktcpsocket.cpp.

sslConfiguration()

QSslConfiguration KTcpSocket::sslConfiguration

(

)

const

Returns the socket's SSL configuration.

Since

4.8.4

Definition at line 817 of file ktcpsocket.cpp.

sslErrors() [1/2]

QList< KSslError > KTcpSocket::sslErrors

(

)

const

Definition at line 556 of file ktcpsocket.cpp.

sslErrors [2/2]

void KTcpSocket::sslErrors ( const QList< KSslError > &  errors )

signal

startClientEncryption

void KTcpSocket::startClientEncryption ( )

slot

Definition at line 835 of file ktcpsocket.cpp.

state()

KTcpSocket::State KTcpSocket::state

(

)

const

Definition at line 630 of file ktcpsocket.cpp.

stateChanged

void KTcpSocket::stateChanged ( KTcpSocket::State  )

signal

waitForBytesWritten()

bool KTcpSocket::waitForBytesWritten ( int  msecs )

virtual

Definition at line 476 of file ktcpsocket.cpp.

waitForConnected()

bool KTcpSocket::waitForConnected

(

int

msecs = 30000

)

Definition at line 636 of file ktcpsocket.cpp.

waitForDisconnected()

bool KTcpSocket::waitForDisconnected

(

int

msecs = 30000

)

Definition at line 646 of file ktcpsocket.cpp.

waitForEncrypted()

bool KTcpSocket::waitForEncrypted

(

int

msecs = 30000

)

Definition at line 796 of file ktcpsocket.cpp.

waitForReadyRead()

bool KTcpSocket::waitForReadyRead ( int  msecs = 30000 )

virtual

Definition at line 482 of file ktcpsocket.cpp.

writeData()

qint64 KTcpSocket::writeData ( const char *  data, qint64  maxSize  )

protectedvirtual

Definition at line 494 of file ktcpsocket.cpp.

---

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

• ktcpsocket.h
• ktcpsocket.cpp