SerialPortConnectionFactory

A ConnectionFactory that enables the creation of a SerialPortConnection for interfacing with a QSerialPort. More...

Inheritance diagram for SerialPortConnectionFactory:

Collaboration diagram for SerialPortConnectionFactory:

Public Member Functions
virtual Buffer< ConnectionCategory >	availableConnectionCategories () override
	Returns the connection categories supported by this factory.
virtual Buffer< ConnectionInfo >	availableConnections (const ConnectionSearchParameters &params) override
	Returns connection information for all available serial port connections.
virtual Buffer< QSerialPortInfo >	availablePortInfo ()
	Returns information about all available serial ports on the system.
virtual ConnectionBackend *	createConnection (const ConnectionInfo &request) override
	Creates a new SerialPortConnection backend for the given connection information.
virtual bool	handlesType (const StringView &request) const override
	Checks whether this factory handles the given connection 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< ConnectionCategory >	AvailableConnectionCategories ()
	Returns all connection categories from all registered factories.
static Buffer< ConnectionInfo >	AvailableConnections (const ConnectionSearchParameters &params)
	Discovers available connections across all registered factories.
static ConnectionBackend *	CreateConnection (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 SerialPortConnection for interfacing with a QSerialPort.

---

Definition at line 141 of file SerialPortConnection.h.

Member Function Documentation

availableConnectionCategories()

virtual Buffer< ConnectionCategory > SerialPortConnectionFactory::availableConnectionCategories ( )

overridevirtual

Returns the connection categories supported by this factory.

Returns

A buffer of ConnectionCategory values.

Implements ConnectionFactory.

availableConnections()

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

overridevirtual

Returns connection information for all available serial port connections.

Parameters

[in]

params

The search parameters to filter available connections.

Returns

A buffer of ConnectionInfo objects for each matching serial port.

Implements ConnectionFactory.

availablePortInfo()

virtual Buffer< QSerialPortInfo > SerialPortConnectionFactory::availablePortInfo ( )

virtual

Returns information about all available serial ports on the system.

Returns

A buffer of QSerialPortInfo objects describing each available port.

createConnection()

virtual ConnectionBackend * SerialPortConnectionFactory::createConnection ( const ConnectionInfo & request )

overridevirtual

Creates a new SerialPortConnection backend for the given connection information.

Parameters

[in]

request

The connection information describing the desired serial port.

Returns

A new SerialPortConnection instance. Caller takes ownership.

Implements ConnectionFactory.

handlesType()

virtual bool SerialPortConnectionFactory::handlesType ( const StringView & request ) const

overridevirtual

Checks whether this factory handles the given connection type string.

Parameters

[in]

request

The connection type identifier to check.

Returns

True if this factory can create connections for the specified type.

Implements ConnectionFactory.

---

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

• NDEVRSerialPort/Headers/SerialPortConnection.h