Server
API Reference Guide
Product Documentation:

Visualization Server
Documentation Home
List of all members | Public Member Functions | Static Public Member Functions
IlsMvServerFactory Class Reference

This class is a factory class used to create instances of the class IlsMvServer. More...

#include <ilserver/mvserver.h>

Public Member Functions

 IlsMvServerFactory ()
 Constructor. More...
 
virtual ~IlsMvServerFactory ()
 Destructor. More...
 
virtual IlsMvServernewInstance (int threadMode)
 Called by the server on the class singleton to create an instance of IlsMvServer. More...
 

Static Public Member Functions

static IlsMvServerFactoryGetSingleton ()
 Returns a reference to the server factory. More...
 
static IlsMvServerFactoryGetSingletonPtr ()
 Returns a pointer to the class singleton. More...
 
static IlsMvServerFactorySetSingleton (IlsMvServerFactory *s)
 Declares the object pointed to by s as the server factory singleton. More...
 

Detailed Description

This class is a factory class used to create instances of the class IlsMvServer.

Library: mvserver

By subclassing IlsMvServerFactory and overriding the function newInstance(), you can create your own subtype of IlsMvServer.

See also
IlsMvServer.

Constructor & Destructor Documentation

◆ IlsMvServerFactory()

IlsMvServerFactory::IlsMvServerFactory ( )

Constructor.

This constructor is called either by the constructor of a derived class or by the GetSingleton() function.

◆ ~IlsMvServerFactory()

virtual IlsMvServerFactory::~IlsMvServerFactory ( )
virtual

Destructor.

The singleton is automatically deleted at process exit.

Member Function Documentation

◆ GetSingleton()

static IlsMvServerFactory& IlsMvServerFactory::GetSingleton ( )
static

Returns a reference to the server factory.

If no factory has been declared yet (see the function SetSingleton()), an instance of IlsMvServerFactory is automatically created, declared as the class singleton using the SetSingleton() function, and returned as the result of the function.

Returns
a reference to the server factory

◆ GetSingletonPtr()

static IlsMvServerFactory* IlsMvServerFactory::GetSingletonPtr ( )
static

Returns a pointer to the class singleton.

Returns
a pointer to the class singleton. If no singleton has been declared yet, it returns the null pointer.

◆ newInstance()

virtual IlsMvServer* IlsMvServerFactory::newInstance ( int  threadMode)
virtual

Called by the server on the class singleton to create an instance of IlsMvServer.

You must override it if you want Rogue Wave Server to create instances of a specific derived class.

Parameters
threadModespecifies the execution mode of the server. Refer to the protected IlsMvServer constructor for details about the various server execution modes.
Returns
a pointer to the new instance.

◆ SetSingleton()

static IlsMvServerFactory* IlsMvServerFactory::SetSingleton ( IlsMvServerFactory s)
static

Declares the object pointed to by s as the server factory singleton.

If s is null, it means that there is no longer a server factory singleton. Either the address of the previous current server factory or, by default, the null pointer is returned as the result of the function.

Parameters
sthe new factory singleton.
Returns
the previous factory singleton