SocketIOConnectionFactory

A ConnectionBackend that allows the software to interface with SocketIO for communicating with across networks. More...

Inheritance diagram for SocketIOConnectionFactory:

Collaboration diagram for SocketIOConnectionFactory:

Public Member Functions
virtual Buffer< ConnectionCategory >	availableConnectionCategories () override
	Gets the categories of connections this factory provides.
virtual Buffer< ConnectionInfo >	availableConnections (const ConnectionSearchParameters &params) override
	Enumerates available SocketIO connections matching the search parameters.
virtual ConnectionBackend *	createConnection (const ConnectionInfo &request) override
	Creates a new SocketIODriver connection backend.
virtual bool	handlesType (const StringView &request) const override
	Checks whether this factory handles the given connection type.
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 ConnectionBackend that allows the software to interface with SocketIO for communicating with across networks.

---

---

A ConnectionFactory that enables the creation of a SocketIODriver for interfacing with a SocketIO

Definition at line 120 of file SocketIODriver.h.

Member Function Documentation

availableConnectionCategories()

virtual Buffer< ConnectionCategory > SocketIOConnectionFactory::availableConnectionCategories ( )

overridevirtual

Gets the categories of connections this factory provides.

Returns

A buffer of ConnectionCategory objects.

Implements ConnectionFactory.

availableConnections()

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

overridevirtual

Enumerates available SocketIO connections matching the search parameters.

Parameters

[in]

params

The search parameters to filter connections.

Returns

A buffer of available ConnectionInfo objects.

Implements ConnectionFactory.

createConnection()

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

overridevirtual

Creates a new SocketIODriver connection backend.

Parameters

[in]

request

The connection parameters.

Returns

A pointer to the newly created ConnectionBackend.

Implements ConnectionFactory.

handlesType()

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

overridevirtual

Checks whether this factory handles the given connection type.

Parameters

[in]

request

The connection type identifier string.

Returns

True if this factory can handle the type.

Implements ConnectionFactory.

---

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

• SocketIO/Headers/SocketIODriver.h