company logo

Client :: shutDown - Shut down client

Usually, the last client handle referring to the client will shut down the main client when being destructed. In some cases, e.g. when creating a client with a configuration or ini-file and using system services as data catalog or error logs, some system references are still active and referring to the main client. In order to guarantee that the main client is closed properly, one should call shutDown() before destructing the client. Make sure that there are no other references to the client in your application anymore.

Notes:

The function shuts down a client application but not the server. In order to shut down the server, shutDownServer() should be called.

Implementation details

Client  :: shutDown ( bool bCloseSystem )

The function will delete all resources associated with the client and close the client. When the client is the main client, which has been created automatically, the function will close the main client.

In order to close associated system resources opened for the main client, true has to be passed in bCloseSystem.

  • bCloseSystem - Close system

    Close will close system resources and forces to close all registered threads, when the client to be closed is the main client.