Stormancer::IPlugin Class Referenceabstract

Inherited by Stormancer::RpcPlugin, and Stormancer::SingleServicePlugin< T, options >.

Public Member Functions

virtual PluginDescription getDescription ()=0
 
virtual void registerClientDependencies (ContainerBuilder &clientBuilder)
 
virtual void clientCreated (std::shared_ptr< IClient > client)
 
virtual void clientDisconnecting (std::shared_ptr< IClient > client)
 
virtual void registerSceneDependencies (ContainerBuilder &sceneBuilder, std::shared_ptr< Scene > scene)
 
virtual void networkAccessRequested (std::shared_ptr< IClient > client)
 
virtual void transportConnecting (std::shared_ptr< IClient > client, std::shared_ptr< ITransport > transport)
 
virtual void transportStarted (std::shared_ptr< ITransport > transport)
 
virtual void packetReceived (std::shared_ptr< Packet< IConnection >> packet)
 
virtual void sceneCreated (std::shared_ptr< Scene > scene)
 
virtual void sceneConnecting (std::shared_ptr< Scene > scene)
 
virtual void sceneConnected (std::shared_ptr< Scene > scene)
 
virtual void sceneDisconnecting (std::shared_ptr< Scene > scene)
 
virtual void sceneDisconnected (std::shared_ptr< Scene > scene)
 Called when the client has disconnected from a scene (deprecated) More...
 
virtual void sceneDisconnected (std::shared_ptr< Scene >, std::string reason)
 Called when the client has disconnected from a scene (obsolete) More...
 
virtual pplx::task< void > onGetSceneInfo (std::shared_ptr< IClient > client, const SceneAddress &address, const Federation &federation)
 This method is executed before a call to getSceneEndpoint(). More...
 
virtual pplx::task< void > onConfigurationSet (std::shared_ptr< IClient > client, std::shared_ptr< Configuration > config)
 

Public Attributes

std::weak_ptr< Configurationconfiguration
 

Member Function Documentation

◆ onGetSceneInfo()

virtual pplx::task<void> Stormancer::IPlugin::onGetSceneInfo ( std::shared_ptr< IClient client,
const SceneAddress address,
const Federation federation 
)
virtual

This method is executed before a call to getSceneEndpoint().

Parameters
clientThe stormancer client
addressAddress of the scene
federationFederation hosting the scene
Returns
An asynchronous task

◆ sceneDisconnected() [1/2]

virtual void Stormancer::IPlugin::sceneDisconnected ( std::shared_ptr< Scene scene)
virtual

Called when the client has disconnected from a scene (deprecated)

Parameters
scene


◆ sceneDisconnected() [2/2]

virtual void Stormancer::IPlugin::sceneDisconnected ( std::shared_ptr< Scene ,
std::string  reason 
)
virtual

Called when the client has disconnected from a scene (obsolete)

Parameters
scene
reason

The documentation for this class was generated from the following file:
  • stormancer/stormancer-sources/include/public/stormancer/IPlugin.h