VBoxClient.h revision 3f69769f2d22bf0277c2d17c8e7d10b147f5823f
/** @file
*
* VirtualBox additions user session daemon.
*/
/*
* Copyright (C) 2006-2011 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef ___vboxclient_vboxclient_h
# define ___vboxclient_vboxclient_h
/** Exit with a fatal error. */
#define VBClFatalError(format) \
do { \
} while(0)
/** Exit with a fatal error. */
extern void vbclFatalError(char *pszMessage);
/** Call clean-up for the current service and exit. */
extern void VBClCleanUp();
/** A simple interface describing a service. VBoxClient will run exactly one
* service per invocation. */
struct VBCLSERVICE
{
/** Get the services default path to pidfile, relative to $HOME */
/** @todo Should this also have a component relative to the X server number?
*/
const char *(*getPidFilePath)(void);
/** Special initialisation, if needed. @a pause and @a resume are
* guaranteed not to be called until after this returns. */
/** Run the service main loop */
/** Pause the service loop. This must be safe to call on a different thread
* and potentially before @a run is or after it exits.
* This is called by the VT monitoring thread to allow the service to disable
* itself when the X server is switched out. If the monitoring functionality
* is available then @a pause or @a resume will be called as soon as it starts
* up. */
/** Resume after pausing. The same applies here as for @a pause. */
/** Clean up any global resources before we shut down hard. The last calls
* to @a pause and @a resume are guaranteed to finish before this is called.
*/
};
/** Default handler for various struct VBCLSERVICE member functions. */
{
return VINF_SUCCESS;
}
/** Default handler for the struct VBCLSERVICE clean-up member function.
* Usually used because the service is cleaned up automatically when the user
{
}
extern struct VBCLSERVICE **VBClGetClipboardService();
extern struct VBCLSERVICE **VBClGetSeamlessService();
extern struct VBCLSERVICE **VBClGetDisplayService();
extern struct VBCLSERVICE **VBClGetHostVersionService();
#ifdef VBOX_WITH_DRAG_AND_DROP
extern struct VBCLSERVICE **VBClGetDragAndDropService();
#endif /* VBOX_WITH_DRAG_AND_DROP */
#endif /* !___vboxclient_vboxclient_h */