NDEVR
API Documentation
SocketConnectionFactory

A ConnectionFactory that enables the creation of a SocketConnection for interfacing with a QAbstractSocket for TCP and UDP connections. More...

Inheritance diagram for SocketConnectionFactory:
[legend]
Collaboration diagram for SocketConnectionFactory:
[legend]

Public Member Functions

virtual Buffer< ConnectionCategoryavailableConnectionCategories () override
 Returns the categories of connections this factory can produce.
virtual Buffer< ConnectionInfoavailableConnections (const ConnectionSearchParameters &params) override
 Enumerates available network connections matching the given search parameters.
virtual ConnectionBackendcreateConnection (const ConnectionInfo &request) override
 Creates a new SocketConnection backend for the given connection info.
virtual bool handlesType (const StringView &request) const override
 Checks whether this factory can create connections for the given type string.
Public Member Functions inherited from ConnectionFactory
virtual bool canConnectTo (const ConnectionInfo &request) const
 Checks whether this factory can establish a connection with the given info.

Additional Inherited Members

Static Public Member Functions inherited from ConnectionFactory
static Buffer< ConnectionCategoryAvailableConnectionCategories ()
 Returns all connection categories from all registered factories.
static Buffer< ConnectionInfoAvailableConnections (const ConnectionSearchParameters &params)
 Discovers available connections across all registered factories.
static ConnectionBackendCreateConnection (const ConnectionInfo &request)
 Creates a ConnectionBackend by searching all registered factories for one that handles the request.
static void RegisterConnectionFactory (ConnectionFactory *factory)
 Registers a ConnectionFactory so it can be used to create connections.
Static Protected Attributes inherited from ConnectionFactory
static Buffer< ConnectionFactory * > s_registered_factories
 All registered connection factories.

Detailed Description

A ConnectionFactory that enables the creation of a SocketConnection for interfacing with a QAbstractSocket for TCP and UDP connections.


Definition at line 139 of file SocketConnection.h.

Member Function Documentation

◆ availableConnectionCategories()

virtual Buffer< ConnectionCategory > SocketConnectionFactory::availableConnectionCategories ( )
overridevirtual

Returns the categories of connections this factory can produce.

Returns
A buffer of ConnectionCategory entries. Returns types for UDP, and TCP

Implements ConnectionFactory.

◆ availableConnections()

virtual Buffer< ConnectionInfo > SocketConnectionFactory::availableConnections ( const ConnectionSearchParameters & params)
overridevirtual

Enumerates available network connections matching the given search parameters.

Parameters
[in]paramsThe search parameters to filter available connections.
Returns
A buffer of matching ConnectionInfo entries.

Implements ConnectionFactory.

◆ createConnection()

virtual ConnectionBackend * SocketConnectionFactory::createConnection ( const ConnectionInfo & request)
overridevirtual

Creates a new SocketConnection backend for the given connection info.

Parameters
[in]requestThe connection parameters for the new connection.
Returns
A pointer to the newly created ConnectionBackend.

Implements ConnectionFactory.

◆ handlesType()

virtual bool SocketConnectionFactory::handlesType ( const StringView & request) const
overridevirtual

Checks whether this factory can create connections for the given type string.

Parameters
[in]requestThe connection type string to test.
Returns
True if this factory handles the specified type, false otherwise.

Implements ConnectionFactory.


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