plFileserverApp Class Reference

A stand-alone application for the plFileServer. More...

#include <Fileserve.h>

Inheritance diagram for plFileserverApp:

Public Types
using	SUPER = plApplication
Public Types inherited from plApplication
enum class	Execution { Continue , Quit }
	Defines the possible return values for the plApplication::Run() function. More...

Public Member Functions
virtual plResult	BeforeCoreSystemsStartup () override
	This function is called before any kind of engine initialization is done.
virtual void	AfterCoreSystemsStartup () override
	This function is called after basic engine initialization has been done.
virtual void	BeforeCoreSystemsShutdown () override
	This function is called after the application main loop has run for the last time, before engine deinitialization.
virtual plApplication::Execution	Run () override
	Main run function which is called periodically. This function must be overridden.
void	FileserverEventHandlerConsole (const plFileserverEvent &e)
void	FileserverEventHandler (const plFileserverEvent &e)
Public Member Functions inherited from plApplication
	plApplication (plStringView sAppName)
	Constructor.
virtual	~plApplication ()
	Virtual destructor.
void	SetApplicationName (plStringView sAppName)
	Changes the application name.
const plString &	GetApplicationName () const
	Returns the application name.
virtual void	BeforeHighLevelSystemsShutdown ()
	This function is called after the application main loop has run for the last time, before engine deinitialization.
virtual void	AfterHighLevelSystemsShutdown ()
	Called after plStartup::ShutdownHighLevelSystems() has been executed.
virtual void	AfterCoreSystemsShutdown ()
	This function is called after plStartup::ShutdownCoreSystems() has been called.
virtual void	BeforeEnterBackground ()
	This function is called when an application is moved to the background.
virtual void	BeforeEnterForeground ()
	This function is called whenever an application is resumed from background mode.
void	SetReturnCode (plInt32 iReturnCode)
	Sets the value that the application will return to the OS. You can call this function at any point during execution to update the return value of the application. Default is zero.
plInt32	GetReturnCode () const
	Returns the currently set value that the application will return to the OS.
virtual const char *	TranslateReturnCode () const
	If the return code is not zero, this function might be called to get a string to print the error code in human readable form.
void	SetCommandLineArguments (plUInt32 uiArgumentCount, const char **pArguments)
	Will set the command line arguments that were passed to the app by the OS. This is automatically called by PL_APPLICATION_ENTRY_POINT() and PL_CONSOLEAPP_ENTRY_POINT().
plUInt32	GetArgumentCount () const
	Returns the number of command line arguments that were passed to the application.
const char *	GetArgument (plUInt32 uiArgument) const
	Returns one of the command line arguments that was passed to the application.
const char **	GetArgumentsArray () const
	Returns the complete array of command line arguments that were passed to the application.
void	EnableMemoryLeakReporting (bool bEnable)
bool	IsMemoryLeakReportingEnabled () const
virtual void	RequestQuit ()
	Calling this function requests that the application quits after the current invocation of Run() finishes.
PL_ALWAYS_INLINE bool	WasQuitRequested () const
	Returns whether RequestQuit() was called.

Public Attributes
plUInt32	m_uiSleepCounter = 0
plUInt32	m_uiConnections = 0
plTime	m_CloseAppTimeout
plTime	m_TimeTillClosing

Additional Inherited Members
Static Public Member Functions inherited from plApplication
static plApplication *	GetApplicationInstance ()
	Returns the one instance of plApplication that is available.
Protected Attributes inherited from plApplication
bool	m_bWasQuitRequested = false

Detailed Description

A stand-alone application for the plFileServer.

If PL_USE_QT is defined, the GUI from the EditorPluginFileserve is used. Otherwise the server runs as a console application.

If the command line option "-fs_wait_timeout seconds" is specified, the server will wait for a limited time for any client to connect and close automatically, if no connection is established. Once a client connects, the timeout becomes irrelevant. If the command line option "-fs_close_timeout seconds" is specified, the application will automatically shut down when no client is connected anymore and a certain timeout is reached. Once a client connects, the timeout is reset. This timeout has no effect as long as no client has connected.

Member Function Documentation

AfterCoreSystemsStartup()

void plFileserverApp::AfterCoreSystemsStartup ( )

overridevirtual

This function is called after basic engine initialization has been done.

plApplication will automatically call plStartup::StartupCoreSystems() to initialize the application. This function can be overridden to do additional application specific initialization. To startup entire subsystems, you should however use the features provided by plStartup and plSubSystem.

Reimplemented from plApplication.

BeforeCoreSystemsShutdown()

void plFileserverApp::BeforeCoreSystemsShutdown ( )

overridevirtual

This function is called after the application main loop has run for the last time, before engine deinitialization.

Override this function to do application specific deinitialization that still requires a running engine. After this function returns plStartup::ShutdownCoreSystems() is called and thus everything, including allocators, is shut down. To shut down entire subsystems, you should, however, use the features provided by plStartup and plSubSystem.

Reimplemented from plApplication.

BeforeCoreSystemsStartup()

plResult plFileserverApp::BeforeCoreSystemsStartup ( )

overridevirtual

This function is called before any kind of engine initialization is done.

Override this function to be able to configure subsystems, before they are initialized. After this function returns, plStartup::StartupCoreSystems() is automatically called. If you need to set up custom allocators, this is the place to do this.

Reimplemented from plApplication.

Run()

plApplication::Execution plFileserverApp::Run ( )

overridevirtual

Main run function which is called periodically. This function must be overridden.

Return Execution::Quit when the application should quit. You may set a return code via SetReturnCode() beforehand.

Implements plApplication.

---

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

• Code/Tools/Fileserve/Fileserve.h
• Code/Tools/Fileserve/App.cpp
• Code/Tools/Fileserve/Console.cpp
• Code/Tools/Fileserve/Fileserve.cpp