AbstractSocket Class Reference

Abstract base class for network sockets. More...

#include <abstractsocket.h>

Inheritance diagram for AbstractSocket:

Collaboration diagram for AbstractSocket:

Public Types
enum	SocketType { TcpSocketType , UdpSocketType , RawSocketType }
	The type of socket. More...
enum	SocketState {   Unconnected , Connecting , Connected , Bound ,   Closing , Listening }
	The current state of the socket. More...
Public Types inherited from IODevice
enum	OpenMode {   NotOpen = 0x00 , ReadOnly = 0x01 , WriteOnly = 0x02 , ReadWrite = ReadOnly | WriteOnly ,   Append = 0x04 | WriteOnly }
	Mode flags controlling how a device is opened. More...
Public Types inherited from ObjectBase
using	SlotVariantFunc = std::function< void(const VariantList &)>
	Function type for invoking a slot with a list of Variants.

Public Member Functions
	AbstractSocket (SocketType type, ObjectBase *parent=nullptr)
	Constructs an AbstractSocket.
virtual	~AbstractSocket ()
	Destructor. Closes the socket if open.
SocketType	socketType () const
	Returns the socket type.
SocketState	state () const
	Returns the current socket state.
Error	bind (const SocketAddress &address)
	Binds the socket to a local address.
Error	connectToHost (const SocketAddress &address)
	Initiates a connection to a remote host.
void	disconnectFromHost ()
	Disconnects from the remote host.
SocketAddress	localAddress () const
	Returns the local address the socket is bound to.
SocketAddress	peerAddress () const
	Returns the address of the connected peer.
Error	waitForConnected (unsigned int timeoutMs=0)
	Blocks until the socket is connected or timeout.
int	socketDescriptor () const
	Returns the raw socket file descriptor.
void	setSocketDescriptor (int fd)
	Adopts an existing file descriptor as the socket.
Error	setSocketOption (int level, int option, int value)
	Sets a raw socket option via setsockopt().
Result< int >	socketOption (int level, int option) const
	Gets a raw socket option via getsockopt().
bool	isSequential () const override
	Returns true — sockets are sequential (non-seekable).
	PROMEKI_SIGNAL (connected)
	Emitted when a connection is established.
	PROMEKI_SIGNAL (disconnected)
	Emitted when the socket is disconnected.
	PROMEKI_SIGNAL (stateChanged, SocketState)
	Emitted when the socket state changes.
Public Member Functions inherited from IODevice
	IODevice (ObjectBase *parent=nullptr)
	Constructs an IODevice.
virtual	~IODevice ()
	Destructor.
virtual Error	open (OpenMode mode)=0
	Opens the device with the specified mode.
virtual Error	close ()=0
	Closes the device.
virtual bool	isOpen () const =0
	Returns true if the device is open.
virtual int64_t	read (void *data, int64_t maxSize)=0
	Reads up to maxSize bytes into data.
virtual int64_t	write (const void *data, int64_t maxSize)=0
	Writes up to maxSize bytes from data.
virtual void	flush ()
	Flushes any buffered output data to the underlying device.
virtual int64_t	bytesAvailable () const
	Returns the number of bytes available for reading.
virtual bool	waitForReadyRead (unsigned int timeoutMs=0)
	Waits until data is available for reading or timeout.
virtual bool	waitForBytesWritten (unsigned int timeoutMs=0)
	Waits until all pending data has been written or timeout.
virtual Error	seek (int64_t pos)
	Seeks to the given byte offset from the beginning.
virtual int64_t	pos () const
	Returns the current read/write position.
virtual Result< int64_t >	size () const
	Returns the total size of the device in bytes.
virtual bool	atEnd () const
	Returns true if the current position is at the end.
OpenMode	openMode () const
	Returns the current open mode.
bool	isReadable () const
	Returns true if the device is readable.
bool	isWritable () const
	Returns true if the device is writable.
Error	error () const
	Returns the current error state.
void	clearError ()
	Clears the error state to Ok.
	PROMEKI_SIGNAL (readyRead)
	Emitted when data is available for reading.
	PROMEKI_SIGNAL (bytesWritten, int64_t)
	Emitted when bytes have been written.
	PROMEKI_SIGNAL (errorOccurred, Error)
	Emitted when an error occurs.
	PROMEKI_SIGNAL (aboutToClose)
	Emitted just before the device is closed.
Public Member Functions inherited from ObjectBase
	ObjectBase (ObjectBase *p=nullptr)
	Default ObjectBase constructor.
virtual	~ObjectBase ()
	Destructor. Emits aboutToDestroy, detaches from parent, and destroys children.
ObjectBase *	parent () const
	Returns the parent object, if one. nullptr if none.
void	setParent (ObjectBase *p)
	Sets the parent of this object. If the object already has a parent, it will be removed as a child from the old parent and added as a child to the new one.
const ObjectBaseList &	childList () const
	Returns a list of children of this object.
template<typename... Args>
int	registerSlot (Slot< Args... > *slot)
	Registers a slot with this object and assigns it an ID.
EventLoop *	eventLoop () const
	Returns the EventLoop this object is affiliated with.
void	moveToThread (EventLoop *loop)
	Changes the EventLoop affinity of this object.
int	startTimer (unsigned int intervalMs, bool singleShot=false)
	Starts a timer on this object's EventLoop.
void	stopTimer (int timerId)
	Stops a timer previously started with startTimer().
template<typename... Args>
PROMEKI_NAMESPACE_BEGIN void	connect (Signal< Args... > *signal, Slot< Args... > *slot)

Protected Member Functions
Error	createSocket (int domain, int type, int protocol=0)
	Creates the underlying socket descriptor.
void	closeSocket ()
	Closes the socket descriptor.
Error	setNonBlocking (bool enable)
	Sets the socket to non-blocking mode.
void	updateLocalAddress ()
	Updates the local address from the socket descriptor.
void	setState (SocketState state)
	Sets the socket state and emits stateChanged.
Protected Member Functions inherited from IODevice
void	setOpenMode (OpenMode mode)
	Sets the open mode.
void	setError (const Error &err)
	Sets the error state and emits errorOccurred.
Protected Member Functions inherited from ObjectBase
ObjectBase *	signalSender ()
	Returns the ObjectBase that emitted the signal currently being handled.
virtual void	event (Event *e)
	Called by EventLoop to deliver events to this object.
virtual void	timerEvent (TimerEvent *e)
	Called when a timer fires for this object.

Protected Attributes
int	_fd = -1
	Socket file descriptor.
SocketState	_state = Unconnected
	Current socket state.
SocketType	_type
	Socket type.
SocketAddress	_localAddress
	Local bound address.
SocketAddress	_peerAddress
	Connected peer address.

Additional Inherited Members
Static Public Member Functions inherited from ObjectBase
static const MetaInfo &	metaInfo ()
	Returns the MetaInfo for the ObjectBase class.
template<typename... Args>
static void	connect (Signal< Args... > *signal, Slot< Args... > *slot)
	connects a signal and slot together. This function assumes both the signal and slot exist in a ObjectBase or derived object
Public Attributes inherited from ObjectBase
Signal< ObjectBase * >	aboutToDestroySignal = Signal< ObjectBase * >(this, aboutToDestroySignalName)
Static Public Attributes inherited from ObjectBase
static constexpr const char *	aboutToDestroySignalName = PROMEKI_STRINGIFY( aboutToDestroy ) "(" PROMEKI_STRINGIFY_ARGS( ObjectBase * ) ")"
static SignalMeta	aboutToDestroySignalMeta = SignalMeta(metaInfo(), aboutToDestroySignalName)

Detailed Description

Abstract base class for network sockets.

AbstractSocket derives from IODevice and provides the common interface for TCP, UDP, and raw sockets. It manages socket state, local and peer addresses, and raw socket descriptor lifecycle.

Subclasses implement open(), close(), read(), and write() for their specific protocol. The socket descriptor is created by open() and closed by close().

This class must only be used from the thread that created it (or moved to via moveToThread()).

Example

UdpSocket sock;
Error err = sock.open(IODevice::ReadWrite);
err = sock.bind(SocketAddress::any(5004));

Member Enumeration Documentation

SocketState

enum AbstractSocket::SocketState

The current state of the socket.

Enumerator
Unconnected	Socket is not connected or bound.
Connecting	A non-blocking connect is in progress.
Connected	Socket is connected to a peer.
Bound	Socket is bound to a local address.
Closing	Socket is being closed.
Listening	Socket is listening for incoming connections (TCP server).

SocketType

enum AbstractSocket::SocketType

The type of socket.

Enumerator
TcpSocketType	Stream-oriented TCP socket.
UdpSocketType	Datagram-oriented UDP socket.
RawSocketType	Raw Ethernet frame socket.

Constructor & Destructor Documentation

AbstractSocket()

AbstractSocket::AbstractSocket	(	SocketType	type,
		ObjectBase *	parent = nullptr
	)

Constructs an AbstractSocket.

Parameters

type	The socket type.
parent	The parent object, or nullptr.

Member Function Documentation

bind()

Error AbstractSocket::bind

(

const SocketAddress &

address

)

Binds the socket to a local address.

The socket must be open before calling bind().

Parameters

address

The local address and port to bind to.

Returns

Error::Ok on success, or an error on failure.

closeSocket()

void AbstractSocket::closeSocket ( )

protected

Closes the socket descriptor.

Subclasses should call this from their close() override.

connectToHost()

Error AbstractSocket::connectToHost

(

const SocketAddress &

address

)

Initiates a connection to a remote host.

For TCP sockets this performs the three-way handshake. For UDP sockets this sets the default destination for write() calls.

Parameters

address

The remote address and port.

Returns

Error::Ok on success, or an error on failure.

createSocket()

Error AbstractSocket::createSocket ( int  domain, int  type, int  protocol = 0  )

protected

Creates the underlying socket descriptor.

Parameters

domain	The address family (AF_INET, AF_INET6, AF_PACKET).
type	The socket type (SOCK_STREAM, SOCK_DGRAM, SOCK_RAW).
protocol	The protocol (0 for default).

Returns

Error::Ok on success, or an error on failure.

disconnectFromHost()

void AbstractSocket::disconnectFromHost

(

)

Disconnects from the remote host.

For TCP sockets this performs a graceful close. For UDP sockets this removes the default destination.

isSequential()

bool AbstractSocket::isSequential ( ) const

inlineoverridevirtual

Returns true — sockets are sequential (non-seekable).

Returns

Always true.

Reimplemented from IODevice.

PROMEKI_SIGNAL() [1/3]

AbstractSocket::PROMEKI_SIGNAL

(

connected

)

Emitted when a connection is established.

Signal:

PROMEKI_SIGNAL() [2/3]

AbstractSocket::PROMEKI_SIGNAL

(

disconnected

)

Emitted when the socket is disconnected.

Signal:

PROMEKI_SIGNAL() [3/3]

AbstractSocket::PROMEKI_SIGNAL	(	stateChanged	,
		SocketState
	)

Emitted when the socket state changes.

Signal:

setNonBlocking()

Error AbstractSocket::setNonBlocking ( bool  enable )

protected

Sets the socket to non-blocking mode.

Parameters

enable

True for non-blocking, false for blocking.

Returns

Error::Ok on success, or an error on failure.

setSocketDescriptor()

void AbstractSocket::setSocketDescriptor

(

int

fd

)

Adopts an existing file descriptor as the socket.

The socket takes ownership of the descriptor. The caller must not close it after this call.

Parameters

fd	The file descriptor to adopt.

setSocketOption()

Error AbstractSocket::setSocketOption	(	int	level,
		int	option,
		int	value
	)

Sets a raw socket option via setsockopt().

Parameters

level	The protocol level (e.g. SOL_SOCKET, IPPROTO_IP).
option	The option name.
value	The option value.

Returns

Error::Ok on success, or an error on failure.

setState()

void AbstractSocket::setState ( SocketState  state )

protected

Sets the socket state and emits stateChanged.

Parameters

state

The new state.

socketDescriptor()

int AbstractSocket::socketDescriptor ( ) const

inline

Returns the raw socket file descriptor.

Returns

The file descriptor, or -1 if no socket is open.

socketOption()

Result< int > AbstractSocket::socketOption	(	int	level,
		int	option
	)		const

Gets a raw socket option via getsockopt().

Parameters

level	The protocol level.
option	The option name.

Returns

A Result containing the option value, or an error.

updateLocalAddress()

void AbstractSocket::updateLocalAddress ( )

protected

Updates the local address from the socket descriptor.

Calls getsockname() and stores the result. Called after bind() to capture the assigned port when binding to port 0.

waitForConnected()

Error AbstractSocket::waitForConnected

(

unsigned int

timeoutMs = 0

)

Blocks until the socket is connected or timeout.

Parameters

timeoutMs

Timeout in milliseconds (0 = wait forever).

Returns

Error::Ok if connected, Error::Timeout on timeout.

---

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

• include/promeki/network/abstractsocket.h