Workspace 6.21.5
Signals | Public Member Functions | Protected Slots | Protected Attributes | List of all members
Socket Class Reference

#include <Workspace/DataExecution/Execution/socket.h>

Inheritance diagram for Socket:
[legend]

Signals

void connected ()
 
void disconnected ()
 
void error (QAbstractSocket::SocketError)
 
void stateChanged (QAbstractSocket::SocketState)
 

Public Member Functions

 Socket (QObject *parent=nullptr)
 
 ~Socket () override
 
virtual qint64 bytesAvailable () const
 
void close ()
 
virtual void connectToHost (const QString &host, quint16 port, bool makeSecure)
 
QAbstractSocket::SocketError error () const
 
QString errorString () const
 
QTcpSocket & getSocket ()
 
QHostAddress localAddress () const
 
quint16 localPort () const
 
 operator QIODevice & ()
 
 operator QTcpSocket & ()
 
QHostAddress peerAddress () const
 
quint16 peerPort () const
 
bool setSocketDescriptor (int socketDescriptor, QAbstractSocket::SocketState socketState=QAbstractSocket::ConnectedState, QIODevice::OpenMode openMode=QIODevice::ReadWrite)
 
QAbstractSocket::SocketState state () const
 

Protected Slots

virtual void onConnected ()
 
virtual void onDisconnected ()
 
virtual void onError (QAbstractSocket::SocketError)
 

Protected Attributes

QTcpSocket * socket_
 

Detailed Description

Provides a wrapper around a network socket.

Constructor & Destructor Documentation

◆ Socket()

Socket ( QObject *  parent = nullptr)

Constructs a socket.

Parameters
parentThe parent to be passed to the QObject constructor.

◆ ~Socket()

~Socket ( )
override

Member Function Documentation

◆ bytesAvailable()

qint64 bytesAvailable ( ) const
virtual

Returns the bytes available for reading on the socket.

◆ close()

void close ( )

Closes the socket.

◆ connected

void connected ( )
signal

◆ connectToHost()

void connectToHost ( const QString &  host,
quint16  port,
bool  makeSecure 
)
virtual

Connects the socket to the provided host and port. If makeSecure is set to true and OpenSSL support is enabled then the socket will attempt to make a secure connection to the provided host.

◆ disconnected

void disconnected ( )
signal

◆ error() [1/2]

QAbstractSocket::SocketError error ( ) const

Returns the last error reported against the socket.

◆ error [2/2]

void error ( QAbstractSocket::SocketError  )
signal

◆ errorString()

QString errorString ( ) const

◆ getSocket()

QTcpSocket & getSocket ( )

Explicitly return the QTcpSocket interface.

◆ localAddress()

QHostAddress localAddress ( ) const

◆ localPort()

quint16 localPort ( ) const

◆ onConnected

void onConnected ( )
protectedvirtualslot

This slot is onvoked when the wrapped socket has connected.

◆ onDisconnected

void onDisconnected ( )
protectedvirtualslot

This slot is onvoked when the wrapped socket has disconnected.

◆ onError

void onError ( QAbstractSocket::SocketError  socketError)
protectedvirtualslot

This slot is onvoked when the wrapped socket has errorred.

◆ operator QIODevice &()

operator QIODevice & ( )

Provides a convenient operator to enable the socket to be passed to methods requiring a reference to a QIODevice.

◆ operator QTcpSocket &()

operator QTcpSocket & ( )

Provides a convenient operator to enable the socket to be passed to methods requiring a reference to a QTcpSocket.

◆ peerAddress()

QHostAddress peerAddress ( ) const

◆ peerPort()

quint16 peerPort ( ) const

◆ setSocketDescriptor()

bool setSocketDescriptor ( int  socketDescriptor,
QAbstractSocket::SocketState  socketState = QAbstractSocket::ConnectedState,
QIODevice::OpenMode  openMode = QIODevice::ReadWrite 
)

Initialises the internal socket with the provided descriptor.

◆ state()

QAbstractSocket::SocketState state ( ) const

Returns the socket's state.

◆ stateChanged

void stateChanged ( QAbstractSocket::SocketState  )
signal

Member Data Documentation

◆ socket_

QTcpSocket* socket_
protected