QSslSocket

#include <QtNetwork/QSslSocket>

More information will be added here shortly. For now, you'll find more extensive information about this class in the Qt reference for QSslSocket

Overview

Inheritance

QIODevice
	QAbstractSocket
		QTcpSocket
			QSslSocket

Public Types Index

enum OpenModeFlag

NotOpen 0x0000, ReadOnly 0x0001, WriteOnly 0x0002, ReadWrite ReadOnly | WriteOnly, Append 0x0004, Truncate 0x0008, Text 0x0010, Unbuffered 0x0020

enum SocketError

ConnectionRefusedError, RemoteHostClosedError, HostNotFoundError, SocketAccessError, SocketResourceError, SocketTimeoutError, DatagramTooLargeError, NetworkError, AddressInUseError, SocketAddressNotAvailableError, UnsupportedSocketOperationError, UnfinishedSocketOperationError, ProxyAuthenticationRequiredError, SslHandshakeFailedError, ProxyConnectionRefusedError, ProxyConnectionClosedError, ProxyConnectionTimeoutError, ProxyNotFoundError, ProxyProtocolError, UnknownSocketError -1

enum SocketOption

LowDelayOption, KeepAliveOption, MulticastTtlOption, MulticastLoopbackOption

enum SocketState

UnconnectedState, HostLookupState, ConnectingState, ConnectedState, BoundState, ListeningState, ClosingState

enum SocketType

TcpSocket, UdpSocket, UnknownSocketType -1

Public Functions Index

	QSslSocket (QObject *parent=0)
	~QSslSocket ()
void	abort ()
void	addCaCertificate (const QSslCertificate &certificate)
bool	addCaCertificates (const QString &path, QSsl::EncodingFormat format=QSsl::Pem, QRegExp::PatternSyntax syntax=QRegExp::FixedString)
void	addCaCertificates (const QList< QSslCertificate > &certificates)
virtual bool	atEnd () const
virtual qint64	bytesAvailable () const
virtual qint64	bytesToWrite () const
QList< QSslCertificate >	caCertificates () const
virtual bool	canReadLine () const
QList< QSslCipher >	ciphers () const
virtual void	close ()
void	connectToHostEncrypted (const QString &hostName, quint16 port, OpenMode mode=ReadWrite)
void	connectToHostEncrypted (const QString &hostName, quint16 port, const QString &sslPeerName, OpenMode mode=ReadWrite)
qint64	encryptedBytesAvailable () const
qint64	encryptedBytesToWrite () const
bool	flush ()
void	ignoreSslErrors (const QList< QSslError > &errors)
bool	isEncrypted () const
QSslCertificate	localCertificate () const
SslMode	mode () const
QSslCertificate	peerCertificate () const
QList< QSslCertificate >	peerCertificateChain () const
int	peerVerifyDepth () const
QSslSocket::PeerVerifyMode	peerVerifyMode () const
QString	peerVerifyName () const
QSslKey	privateKey () const
QSsl::SslProtocol	protocol () const
QSslCipher	sessionCipher () const
void	setCaCertificates (const QList< QSslCertificate > &certificates)
void	setCiphers (const QList< QSslCipher > &ciphers)
void	setCiphers (const QString &ciphers)
void	setLocalCertificate (const QSslCertificate &certificate)
void	setLocalCertificate (const QString &fileName, QSsl::EncodingFormat format=QSsl::Pem)
void	setPeerVerifyDepth (int depth)
void	setPeerVerifyMode (QSslSocket::PeerVerifyMode mode)
void	setPeerVerifyName (const QString &hostName)
void	setPrivateKey (const QSslKey &key)
void	setPrivateKey (const QString &fileName, QSsl::KeyAlgorithm algorithm=QSsl::Rsa, QSsl::EncodingFormat format=QSsl::Pem, const QByteArray &passPhrase=QByteArray())
void	setProtocol (QSsl::SslProtocol protocol)
void	setReadBufferSize (qint64 size)
bool	setSocketDescriptor (int socketDescriptor, SocketState state=ConnectedState, OpenMode openMode=ReadWrite)
void	setSocketOption (QAbstractSocket::SocketOption option, const QVariant &value)
void	setSslConfiguration (const QSslConfiguration &config)
QVariant	socketOption (QAbstractSocket::SocketOption option)
QSslConfiguration	sslConfiguration () const
QList< QSslError >	sslErrors () const
virtual bool	waitForBytesWritten (int msecs=30000)
bool	waitForConnected (int msecs=30000)
bool	waitForDisconnected (int msecs=30000)
bool	waitForEncrypted (int msecs=30000)
virtual bool	waitForReadyRead (int msecs=30000)
void	connectToHost (const QString &hostName, quint16 port, OpenMode mode=ReadWrite)
void	connectToHost (const QHostAddress &address, quint16 port, OpenMode mode=ReadWrite)
void	disconnectFromHost ()
SocketError	error () const
QString	errorString () const
bool	getChar (char *c)
bool	isOpen () const
bool	isReadable () const
virtual bool	isSequential () const
bool	isTextModeEnabled () const
bool	isValid () const
bool	isWritable () const
QHostAddress	localAddress () const
quint16	localPort () const
virtual bool	open (OpenMode mode)
OpenMode	openMode () const
qint64	peek (char *data, qint64 maxlen)
QByteArray	peek (qint64 maxlen)
QHostAddress	peerAddress () const
QString	peerName () const
quint16	peerPort () const
virtual qint64	pos () const
QNetworkProxy	proxy () const
bool	putChar (char c)
	QAbstractSocket (SocketType socketType, QObject *parent)
	QIODevice ()
	QIODevice (QObject *parent)
	QTcpSocket (QObject *parent=0)
qint64	read (char *data, qint64 maxlen)
QByteArray	read (qint64 maxlen)
QByteArray	readAll ()
qint64	readBufferSize () const
qint64	readLine (char *data, qint64 maxlen)
QByteArray	readLine (qint64 maxlen=0)
virtual bool	reset ()
virtual bool	seek (qint64 pos)
void	setProxy (const QNetworkProxy &networkProxy)
void	setTextModeEnabled (bool enabled)
virtual qint64	size () const
int	socketDescriptor () const
SocketType	socketType () const
SocketState	state () const
void	ungetChar (char c)
qint64	write (const char *data, qint64 len)
qint64	write (const char *data)
qint64	write (const QByteArray &data)

Static Public Functions Index

void	addDefaultCaCertificate (const QSslCertificate &certificate)
bool	addDefaultCaCertificates (const QString &path, QSsl::EncodingFormat format=QSsl::Pem, QRegExp::PatternSyntax syntax=QRegExp::FixedString)
void	addDefaultCaCertificates (const QList< QSslCertificate > &certificates)
QList< QSslCertificate >	defaultCaCertificates ()
QList< QSslCipher >	defaultCiphers ()
void	setDefaultCaCertificates (const QList< QSslCertificate > &certificates)
void	setDefaultCiphers (const QList< QSslCipher > &ciphers)
QList< QSslCipher >	supportedCiphers ()
bool	supportsSsl ()
QList< QSslCertificate >	systemCaCertificates ()

Protected Functions Index

virtual qint64	readData (char *data, qint64 maxlen)
virtual qint64	writeData (const char *data, qint64 len)
	QAbstractSocket (SocketType socketType, QAbstractSocketPrivate &dd, QObject *parent=0)
	QIODevice (QIODevicePrivate &dd, QObject *parent=0)
	QTcpSocket (QTcpSocketPrivate &dd, QObject *parent=0)
virtual qint64	readLineData (char *data, qint64 maxlen)
void	setErrorString (const QString &errorString)
void	setLocalAddress (const QHostAddress &address)
void	setLocalPort (quint16 port)
void	setOpenMode (OpenMode openMode)
void	setPeerAddress (const QHostAddress &address)
void	setPeerName (const QString &name)
void	setPeerPort (quint16 port)
void	setSocketError (SocketError socketError)
void	setSocketState (SocketState state)

Public Slots Index

void	ignoreSslErrors ()
void	startClientEncryption ()
void	startServerEncryption ()

Signals Index

void	encrypted ()
void	encryptedBytesWritten (qint64 totalBytes)
void	modeChanged (QSslSocket::SslMode newMode)
void	peerVerifyError (const QSslError &error)
void	sslErrors (const QList< QSslError > &errors)
void	aboutToClose ()
void	bytesWritten (qint64 bytes)
void	connected ()
void	disconnected ()
void	error (QAbstractSocket::SocketError)
void	hostFound ()
void	proxyAuthenticationRequired (const QNetworkProxy &proxy, QAuthenticator *authenticator)
void	readChannelFinished ()
void	readyRead ()
void	stateChanged (QAbstractSocket::SocketState)

Public Types

PeerVerifyMode

VerifyNone
QueryPeer
VerifyPeer
AutoVerifyPeer

SslMode

UnencryptedMode
SslClientMode
SslServerMode

NetworkLayerProtocol

IPv4Protocol
IPv6Protocol
UnknownNetworkLayerProtocol -1

OpenModeFlag

NotOpen 0x0000
ReadOnly 0x0001
WriteOnly 0x0002
ReadWrite ReadOnly | WriteOnly
Append 0x0004
Truncate 0x0008
Text 0x0010
Unbuffered 0x0020

SocketError

ConnectionRefusedError
RemoteHostClosedError
HostNotFoundError
SocketAccessError
SocketResourceError
SocketTimeoutError
DatagramTooLargeError
NetworkError
AddressInUseError
SocketAddressNotAvailableError
UnsupportedSocketOperationError
UnfinishedSocketOperationError
ProxyAuthenticationRequiredError
SslHandshakeFailedError
ProxyConnectionRefusedError
ProxyConnectionClosedError
ProxyConnectionTimeoutError
ProxyNotFoundError
ProxyProtocolError
UnknownSocketError -1

SocketOption

LowDelayOption
KeepAliveOption
MulticastTtlOption
MulticastLoopbackOption

SocketState

UnconnectedState
HostLookupState
ConnectingState
ConnectedState
BoundState
ListeningState
ClosingState

SocketType

TcpSocket
UdpSocket
UnknownSocketType -1

Public Functions

QSslSocket (
QObject *parent)

~QSslSocket ()

Destructor.

void abort ()

void addCaCertificate (
const QSslCertificate &certificate)

bool addCaCertificates (
const QString &path,
QSsl::EncodingFormatformat,
QRegExp::PatternSyntaxsyntax )

void addCaCertificates (
const QList< QSslCertificate > &certificates)

virtual bool atEnd ()

virtual qint64 bytesAvailable ()

virtual qint64 bytesToWrite ()

QList< QSslCertificate > caCertificates ()

virtual bool canReadLine ()

QList< QSslCipher > ciphers ()

virtual void close ()

void connectToHostEncrypted (
const QString &hostName,
quint16port,
OpenModemode )

void connectToHostEncrypted (
const QString &hostName,
quint16port,
const QString &sslPeerName,
OpenModemode )

qint64 encryptedBytesAvailable ()

qint64 encryptedBytesToWrite ()

bool flush ()

void ignoreSslErrors (
const QList< QSslError > &errors)

bool isEncrypted ()

QSslCertificate localCertificate ()

SslMode mode ()

QSslCertificate peerCertificate ()

QList< QSslCertificate > peerCertificateChain ()

int peerVerifyDepth ()

QSslSocket::PeerVerifyMode peerVerifyMode ()

QString peerVerifyName ()

QSslKey privateKey ()

QSsl::SslProtocol protocol ()

QSslCipher sessionCipher ()

void setCaCertificates (
const QList< QSslCertificate > &certificates)

void setCiphers (
const QList< QSslCipher > &ciphers)

void setCiphers (
const QString &ciphers)

void setLocalCertificate (
const QSslCertificate &certificate)

void setLocalCertificate (
const QString &fileName,
QSsl::EncodingFormatformat )

void setPeerVerifyDepth (
intdepth)

void setPeerVerifyMode (
QSslSocket::PeerVerifyModemode)

void setPeerVerifyName (
const QString &hostName)

void setPrivateKey (
const QSslKey &key)

void setPrivateKey (
const QString &fileName,
QSsl::KeyAlgorithmalgorithm,
QSsl::EncodingFormatformat,
const QByteArray &passPhrase )

void setProtocol (
QSsl::SslProtocolprotocol)

void setReadBufferSize (
qint64size)

bool setSocketDescriptor (
intsocketDescriptor,
SocketStatestate,
OpenModeopenMode )

void setSocketOption (
QAbstractSocket::SocketOptionoption,
const QVariant &value )

void setSslConfiguration (
const QSslConfiguration &config)

QVariant socketOption (
QAbstractSocket::SocketOptionoption)

QSslConfiguration sslConfiguration ()

QList< QSslError > sslErrors ()

virtual bool waitForBytesWritten (
intmsecs)

bool waitForConnected (
intmsecs)

bool waitForDisconnected (
intmsecs)

bool waitForEncrypted (
intmsecs)

virtual bool waitForReadyRead (
intmsecs)

void connectToHost (
const QString &hostName,
quint16port,
OpenModemode )

void connectToHost (
const QHostAddress &address,
quint16port,
OpenModemode )

void disconnectFromHost ()

SocketError error ()

QString errorString ()

bool getChar (
char *c)

bool isOpen ()

bool isReadable ()

virtual bool isSequential ()

bool isTextModeEnabled ()

bool isValid ()

bool isWritable ()

QHostAddress localAddress ()

quint16 localPort ()

virtual bool open (
OpenModemode)

OpenMode openMode ()

qint64 peek (
char *data,
qint64maxlen )

QByteArray peek (
qint64maxlen)

QHostAddress peerAddress ()

QString peerName ()

quint16 peerPort ()

virtual qint64 pos ()

QNetworkProxy proxy ()

bool putChar (
charc)

QAbstractSocket (
SocketTypesocketType,
QObject *parent )

QIODevice ()

QIODevice (
QObject *parent)

QTcpSocket (
QObject *parent)

qint64 read (
char *data,
qint64maxlen )

QByteArray read (
qint64maxlen)

QByteArray readAll ()

qint64 readBufferSize ()

qint64 readLine (
char *data,
qint64maxlen )

QByteArray readLine (
qint64maxlen)

virtual bool reset ()

virtual bool seek (
qint64pos)

void setProxy (
const QNetworkProxy &networkProxy)

void setTextModeEnabled (
boolenabled)

virtual qint64 size ()

int socketDescriptor ()

SocketType socketType ()

SocketState state ()

void ungetChar (
charc)

qint64 write (
const char *data,
qint64len )

qint64 write (
const char *data)

qint64 write (
const QByteArray &data)

Static Public Functions

void addDefaultCaCertificate (
const QSslCertificate &certificate)

bool addDefaultCaCertificates (
const QString &path,
QSsl::EncodingFormatformat,
QRegExp::PatternSyntaxsyntax )

void addDefaultCaCertificates (
const QList< QSslCertificate > &certificates)

QList< QSslCertificate > defaultCaCertificates ()

QList< QSslCipher > defaultCiphers ()

void setDefaultCaCertificates (
const QList< QSslCertificate > &certificates)

void setDefaultCiphers (
const QList< QSslCipher > &ciphers)

QList< QSslCipher > supportedCiphers ()

bool supportsSsl ()

QList< QSslCertificate > systemCaCertificates ()

Protected Functions

virtual qint64 readData (
char *data,
qint64maxlen )

virtual qint64 writeData (
const char *data,
qint64len )

QAbstractSocket (
SocketTypesocketType,
QAbstractSocketPrivate &dd,
QObject *parent )

QIODevice (
QIODevicePrivate &dd,
QObject *parent )

QTcpSocket (
QTcpSocketPrivate &dd,
QObject *parent )

virtual qint64 readLineData (
char *data,
qint64maxlen )

void setErrorString (
const QString &errorString)

void setLocalAddress (
const QHostAddress &address)

void setLocalPort (
quint16port)

void setOpenMode (
OpenModeopenMode)

void setPeerAddress (
const QHostAddress &address)

void setPeerName (
const QString &name)

void setPeerPort (
quint16port)

void setSocketError (
SocketErrorsocketError)

void setSocketState (
SocketStatestate)

Public Slots

void ignoreSslErrors ()

void startClientEncryption ()

void startServerEncryption ()

Signals

void encrypted ()

void encryptedBytesWritten (
qint64totalBytes)

void modeChanged (
QSslSocket::SslModenewMode)

void peerVerifyError (
const QSslError &error)

void sslErrors (
const QList< QSslError > &errors)

void aboutToClose ()

void bytesWritten (
qint64bytes)

void connected ()

void disconnected ()

void error (
QAbstractSocket::SocketError)

void hostFound ()

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

void readChannelFinished ()

void readyRead ()

void stateChanged (
QAbstractSocket::SocketState)

The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.

Documentation sources may be obtained from www.qt-project.org.

Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. Privacy Policy