ezEngine  Milestone 9
ezFileserverApp Class Reference

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

#include <Main.h>

Inheritance diagram for ezFileserverApp:

Public Types

typedef ezApplication SUPER
 
- Public Types inherited from ezApplication
enum  ApplicationExecution { Continue, Quit }
 Defines the possible return values for the ezApplication::Run() function. More...
 

Public Member Functions

virtual void BeforeCoreSystemsStartup () override
 This function is called before any kind of engine initialization is done. More...
 
virtual void AfterCoreSystemsStartup () override
 This function is called after basic engine initialization has been done. More...
 
virtual void BeforeCoreSystemsShutdown () override
 This function is called after the application main loop has run for the last time, before engine deinitialization. More...
 
virtual ezApplication::ApplicationExecution Run () override
 Main run function which is called periodically. This function must be overridden. More...
 
void FileserverEventHandlerConsole (const ezFileserverEvent &e)
 
void FileserverEventHandler (const ezFileserverEvent &e)
 
- Public Member Functions inherited from ezApplication
 ezApplication (const char *szAppName)
 Constructor.
 
virtual ~ezApplication ()
 Virtual destructor.
 
void SetApplicationName (const char *szAppName)
 Changes the application name.
 
const ezStringGetApplicationName () 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. More...
 
virtual void AfterHighLevelSystemsShutdown ()
 Called after ezStartup::ShutdownHighLevelSystems() has been executed.
 
virtual void AfterCoreSystemsShutdown ()
 This function is called after ezStartup::ShutdownCoreSystems() has been called. More...
 
virtual void BeforeEnterBackground ()
 This function is called when an application is moved to the background. More...
 
virtual void BeforeEnterForeground ()
 This function is called whenever an application is resumed from background mode. More...
 
void SetReturnCode (ezInt32 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.
 
ezInt32 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 (ezUInt32 uiArgumentCount, const char **ppArguments)
 Will set the command line arguments that were passed to the app by the OS. This is automatically called by EZ_APPLICATION_ENTRY_POINT() and EZ_CONSOLEAPP_ENTRY_POINT().
 
ezUInt32 GetArgumentCount () const
 Returns the number of command lien arguments that were passed to the application. More...
 
const char * GetArgument (ezUInt32 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
 

Public Attributes

ezUInt32 m_uiSleepCounter = 0
 
ezUInt32 m_uiConnections = 0
 
ezTime m_CloseAppTimeout
 
ezTime m_TimeTillClosing
 

Additional Inherited Members

- Static Public Member Functions inherited from ezApplication
static ezApplicationGetApplicationInstance ()
 Returns the one instance of ezApplication that is available.
 

Detailed Description

A stand-alone application for the ezFileServer.

If EZ_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 ezFileserverApp::AfterCoreSystemsStartup ( )
overridevirtual

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

ezApplication will automatically call ezStartup::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 ezStartup and ezSubSystem.

Reimplemented from ezApplication.

◆ BeforeCoreSystemsShutdown()

void ezFileserverApp::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 ezStartup::ShutdownCoreSystems() is called and thus everything, including allocators, is shut down. To shut down entire subsystems, you should, however, use the features provided by ezStartup and ezSubSystem.

Reimplemented from ezApplication.

◆ BeforeCoreSystemsStartup()

void ezFileserverApp::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, ezStartup::StartupCoreSystems() is automatically called. If you need to set up custom allocators, this is the place to do this.

Reimplemented from ezApplication.

◆ Run()

ezApplication::ApplicationExecution ezFileserverApp::Run ( )
overridevirtual

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

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

Implements ezApplication.


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