QAbstractSocket Class Reference

QAbstractSocket Class Reference
Public Types | Signals | Public Member Functions | Protected Slots | Protected Member Functions

#include <qabstractsocket.h>

Class Description

Definition at line 64 of file qabstractsocket.h.

+ Inheritance diagram for QAbstractSocket:

Public Types

enum  SocketType { TcpSocket, UdpSocket, UnknownSocketType = -1 }
 
enum  NetworkLayerProtocol { IPv4Protocol, IPv6Protocol, UnknownNetworkLayerProtocol = -1 }
 
enum  SocketError {
  ConnectionRefusedError, RemoteHostClosedError, HostNotFoundError, SocketAccessError,
  SocketResourceError, SocketTimeoutError, DatagramTooLargeError, NetworkError,
  AddressInUseError, SocketAddressNotAvailableError, UnsupportedSocketOperationError, UnfinishedSocketOperationError,
  ProxyAuthenticationRequiredError, SslHandshakeFailedError, ProxyConnectionRefusedError, ProxyConnectionClosedError,
  ProxyConnectionTimeoutError, ProxyNotFoundError, ProxyProtocolError, UnknownSocketError = -1
}
 
enum  SocketState {
  UnconnectedState, HostLookupState, ConnectingState, ConnectedState,
  BoundState, ListeningState, ClosingState
}
 
enum  SocketOption { LowDelayOption, KeepAliveOption, MulticastTtlOption, MulticastLoopbackOption }
 
- Public Types inherited from QIODevice
enum  OpenModeFlag {
  NotOpen = 0x0000, ReadOnly = 0x0001, WriteOnly = 0x0002, ReadWrite = ReadOnly | WriteOnly,
  Append = 0x0004, Truncate = 0x0008, Text = 0x0010, Unbuffered = 0x0020
}
 

Signals

void hostFound ()
 
void connected ()
 
void disconnected ()
 
void stateChanged (QAbstractSocket::SocketState)
 
void error (QAbstractSocket::SocketError)
 
void proxyAuthenticationRequired (const QNetworkProxy &proxy, QAuthenticator *authenticator)
 
- Signals inherited from QIODevice
void readyRead ()
 
void bytesWritten (qint64 bytes)
 
void aboutToClose ()
 
void readChannelFinished ()
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 

Public Member Functions

 QAbstractSocket (SocketType socketType, QObject *parent)
 
virtual ~QAbstractSocket ()
 
void connectToHost (const QString &hostName, quint16 port, OpenMode mode=ReadWrite)
 
void connectToHost (const QHostAddress &address, quint16 port, OpenMode mode=ReadWrite)
 
void disconnectFromHost ()
 
bool isValid () const
 
qint64 bytesAvailable () const
 
qint64 bytesToWrite () const
 
bool canReadLine () const
 
quint16 localPort () const
 
QHostAddress localAddress () const
 
quint16 peerPort () const
 
QHostAddress peerAddress () const
 
QString peerName () const
 
qint64 readBufferSize () const
 
void setReadBufferSize (qint64 size)
 
void abort ()
 
int socketDescriptor () const
 
bool setSocketDescriptor (int socketDescriptor, SocketState state=ConnectedState, OpenMode openMode=ReadWrite)
 
void setSocketOption (QAbstractSocket::SocketOption option, const QVariant &value)
 
QVariant socketOption (QAbstractSocket::SocketOption option)
 
SocketType socketType () const
 
SocketState state () const
 
SocketError error () const
 
void close ()
 
bool isSequential () const
 
bool atEnd () const
 
bool flush ()
 
bool waitForConnected (int msecs=30000)
 
bool waitForReadyRead (int msecs=30000)
 
bool waitForBytesWritten (int msecs=30000)
 
bool waitForDisconnected (int msecs=30000)
 
void setProxy (const QNetworkProxy &networkProxy)
 
QNetworkProxy proxy () const
 
- Public Member Functions inherited from QIODevice
 QIODevice ()
 
 QIODevice (QObject *parent)
 
virtual ~QIODevice ()
 
OpenMode openMode () const
 
void setTextModeEnabled (bool enabled)
 
bool isTextModeEnabled () const
 
bool isOpen () const
 
bool isReadable () const
 
bool isWritable () const
 
virtual bool open (OpenMode mode)
 
virtual qint64 pos () const
 
virtual qint64 size () const
 
virtual bool seek (qint64 pos)
 
virtual bool reset ()
 
qint64 read (char *data, qint64 maxlen)
 
QByteArray read (qint64 maxlen)
 
QByteArray readAll ()
 
qint64 readLine (char *data, qint64 maxlen)
 
QByteArray readLine (qint64 maxlen=0)
 
qint64 write (const char *data, qint64 len)
 
qint64 write (const char *data)
 
qint64 write (const QByteArray &data)
 
qint64 peek (char *data, qint64 maxlen)
 
QByteArray peek (qint64 maxlen)
 
void ungetChar (char c)
 
bool putChar (char c)
 
bool getChar (char *c)
 
QString errorString () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=0)
 
virtual ~QObject ()
 
virtual bool event (QEvent *)
 
virtual bool eventFilter (QObject *, QEvent *)
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool b)
 
QThread * thread () const
 
void moveToThread (QThread *thread)
 
int startTimer (int interval)
 
void killTimer (int id)
 
template<typename T >
T findChild (const QString &aName=QString()) const
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
const QObjectList & children () const
 
void setParent (QObject *)
 
void installEventFilter (QObject *)
 
void removeEventFilter (QObject *)
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArray > dynamicPropertyNames () const
 
void setUserData (uint id, QObjectUserData *data)
 
QObjectUserData * userData (uint id) const
 
QObject * parent () const
 
bool inherits (const char *classname) const
 

Protected Slots

void connectToHostImplementation (const QString &hostName, quint16 port, OpenMode mode=ReadWrite)
 
void disconnectFromHostImplementation ()
 

Protected Member Functions

qint64 readData (char *data, qint64 maxlen)
 
qint64 readLineData (char *data, qint64 maxlen)
 
qint64 writeData (const char *data, qint64 len)
 
void setSocketState (SocketState state)
 
void setSocketError (SocketError socketError)
 
void setLocalPort (quint16 port)
 
void setLocalAddress (const QHostAddress &address)
 
void setPeerPort (quint16 port)
 
void setPeerAddress (const QHostAddress &address)
 
void setPeerName (const QString &name)
 
 QAbstractSocket (SocketType socketType, QAbstractSocketPrivate &dd, QObject *parent=0)
 
- Protected Member Functions inherited from QIODevice
 QIODevice (QIODevicePrivate &dd, QObject *parent=0)
 
void setOpenMode (OpenMode openMode)
 
void setErrorString (const QString &errorString)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
virtual void timerEvent (QTimerEvent *)
 
virtual void childEvent (QChildEvent *)
 
virtual void customEvent (QEvent *)
 
virtual void connectNotify (const char *signal)
 
virtual void disconnectNotify (const char *signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 
- Static Public Member Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Static Protected Attributes inherited from QObject
static const QMetaObject staticQtMetaObject
 
- Properties inherited from QObject
QString objectName
 

Member Enumeration Documentation

enum SocketType
Enumerator
TcpSocket 
UdpSocket 
UnknownSocketType 

Definition at line 69 of file qabstractsocket.h.

69  {
70  TcpSocket,
71  UdpSocket,
72  UnknownSocketType = -1
73  };
enum NetworkLayerProtocol
Enumerator
IPv4Protocol 
IPv6Protocol 
UnknownNetworkLayerProtocol 

Definition at line 74 of file qabstractsocket.h.

74  {
75  IPv4Protocol,
76  IPv6Protocol,
77  UnknownNetworkLayerProtocol = -1
78  };
enum SocketError
Enumerator
ConnectionRefusedError 
RemoteHostClosedError 
HostNotFoundError 
SocketAccessError 
SocketResourceError 
SocketTimeoutError 
DatagramTooLargeError 
NetworkError 
AddressInUseError 
SocketAddressNotAvailableError 
UnsupportedSocketOperationError 
UnfinishedSocketOperationError 
ProxyAuthenticationRequiredError 
SslHandshakeFailedError 
ProxyConnectionRefusedError 
ProxyConnectionClosedError 
ProxyConnectionTimeoutError 
ProxyNotFoundError 
ProxyProtocolError 
UnknownSocketError 

Definition at line 79 of file qabstractsocket.h.

79  {
80  ConnectionRefusedError,
81  RemoteHostClosedError,
82  HostNotFoundError,
83  SocketAccessError,
84  SocketResourceError,
85  SocketTimeoutError, /* 5 */
86  DatagramTooLargeError,
87  NetworkError,
88  AddressInUseError,
89  SocketAddressNotAvailableError,
90  UnsupportedSocketOperationError, /* 10 */
91  UnfinishedSocketOperationError,
92  ProxyAuthenticationRequiredError,
93  SslHandshakeFailedError,
94  ProxyConnectionRefusedError,
95  ProxyConnectionClosedError, /* 15 */
96  ProxyConnectionTimeoutError,
97  ProxyNotFoundError,
98  ProxyProtocolError,
99 
100  UnknownSocketError = -1
101  };
enum SocketState
Enumerator
UnconnectedState 
HostLookupState 
ConnectingState 
ConnectedState 
BoundState 
ListeningState 
ClosingState 

Definition at line 102 of file qabstractsocket.h.

102  {
103  UnconnectedState,
104  HostLookupState,
105  ConnectingState,
106  ConnectedState,
107  BoundState,
108  ListeningState,
109  ClosingState
110 #ifdef QT3_SUPPORT
111  ,
112  Idle = UnconnectedState,
113  HostLookup = HostLookupState,
114  Connecting = ConnectingState,
115  Connected = ConnectedState,
116  Closing = ClosingState,
117  Connection = ConnectedState
118 #endif
119  };
enum SocketOption
Enumerator
LowDelayOption 
KeepAliveOption 
MulticastTtlOption 
MulticastLoopbackOption 

Definition at line 120 of file qabstractsocket.h.

120  {
121  LowDelayOption, // TCP_NODELAY
122  KeepAliveOption, // SO_KEEPALIVE
123  MulticastTtlOption, // IP_MULTICAST_TTL
124  MulticastLoopbackOption // IP_MULTICAST_LOOPBACK
125  };

Constructor & Destructor Documentation

QAbstractSocket ( SocketType  socketType,
QObject *  parent 
)
virtual ~QAbstractSocket ( )
virtual
QAbstractSocket ( SocketType  socketType,
QAbstractSocketPrivate &  dd,
QObject *  parent = 0 
)
protected

Member Function Documentation

void connectToHost ( const QString &  hostName,
quint16  port,
OpenMode  mode = ReadWrite 
)
void connectToHost ( const QHostAddress &  address,
quint16  port,
OpenMode  mode = ReadWrite 
)
void disconnectFromHost ( )
bool isValid ( ) const
qint64 bytesAvailable ( ) const
virtual

Reimplemented from QIODevice.

Reimplemented in QSslSocket.

qint64 bytesToWrite ( ) const
virtual

Reimplemented from QIODevice.

Reimplemented in QSslSocket.

bool canReadLine ( ) const
virtual

Reimplemented from QIODevice.

Reimplemented in QSslSocket.

quint16 localPort ( ) const
QHostAddress localAddress ( ) const
quint16 peerPort ( ) const
QHostAddress peerAddress ( ) const
QString peerName ( ) const
qint64 readBufferSize ( ) const
void setReadBufferSize ( qint64  size)
void abort ( )
int socketDescriptor ( ) const
bool setSocketDescriptor ( int  socketDescriptor,
SocketState  state = ConnectedState,
OpenMode  openMode = ReadWrite 
)
void setSocketOption ( QAbstractSocket::SocketOption  option,
const QVariant &  value 
)
QVariant socketOption ( QAbstractSocket::SocketOption  option)
SocketType socketType ( ) const
SocketState state ( ) const
SocketError error ( ) const
void close ( )
virtual

Reimplemented from QIODevice.

Reimplemented in QSslSocket.

bool isSequential ( ) const
virtual

Reimplemented from QIODevice.

bool atEnd ( ) const
virtual

Reimplemented from QIODevice.

Reimplemented in QSslSocket.

bool flush ( )
bool waitForConnected ( int  msecs = 30000)
bool waitForReadyRead ( int  msecs = 30000)
virtual

Reimplemented from QIODevice.

Reimplemented in QSslSocket.

bool waitForBytesWritten ( int  msecs = 30000)
virtual

Reimplemented from QIODevice.

Reimplemented in QSslSocket.

bool waitForDisconnected ( int  msecs = 30000)
void setProxy ( const QNetworkProxy &  networkProxy)
QNetworkProxy proxy ( ) const
void hostFound ( )
signal
void connected ( )
signal
void disconnected ( )
signal
void stateChanged ( QAbstractSocket::SocketState  )
signal
void error ( QAbstractSocket::SocketError  )
signal
void proxyAuthenticationRequired ( const QNetworkProxy &  proxy,
QAuthenticator *  authenticator 
)
signal
void connectToHostImplementation ( const QString &  hostName,
quint16  port,
OpenMode  mode = ReadWrite 
)
protectedslot
void disconnectFromHostImplementation ( )
protectedslot
qint64 readData ( char *  data,
qint64  maxlen 
)
protectedvirtual

Implements QIODevice.

Reimplemented in QSslSocket.

qint64 readLineData ( char *  data,
qint64  maxlen 
)
protectedvirtual

Reimplemented from QIODevice.

qint64 writeData ( const char *  data,
qint64  len 
)
protectedvirtual

Implements QIODevice.

Reimplemented in QSslSocket.

void setSocketState ( SocketState  state)
protected
void setSocketError ( SocketError  socketError)
protected
void setLocalPort ( quint16  port)
protected
void setLocalAddress ( const QHostAddress &  address)
protected
void setPeerPort ( quint16  port)
protected
void setPeerAddress ( const QHostAddress &  address)
protected
void setPeerName ( const QString &  name)
protected
The documentation for this class was generated from the following file:
Please send us your comment about this page