VBoxGuestR3LibGuestCtrl.cpp revision 16db1eeb97dd76f4d94b4808171fb14461b135d2
/* $Id$ */
/** @file
* VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, guest control.
*/
/*
* Copyright (C) 2010-2013 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include "VBGLR3Internal.h"
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
using namespace guestControl;
/**
* Connects to the guest control service.
*
* @returns VBox status code
* @param puClientId Where to put The client ID on success. The client ID
* must be passed to all the other calls to the service.
*/
{
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
}
return rc;
}
/**
* Disconnect from the guest control service.
*
* @returns VBox status code.
* @param uClientId The client ID returned by VbglR3GuestCtrlConnect().
*/
{
if (RT_SUCCESS(rc))
return rc;
}
/**
* Waits until a new host message arrives.
* This will block until a message becomes available.
*
* @returns VBox status code.
* @param uClientId The client ID returned by VbglR3GuestCtrlConnect().
* @param puMsg Where to store the message id.
* @param puNumParms Where to store the number of parameters which will be received
* in a second call to the host.
*/
VBGLR3DECL(int) VbglR3GuestCtrlMsgWaitFor(uint32_t uClientId, uint32_t *puMsg, uint32_t *puNumParms)
{
if (RT_SUCCESS(rc))
{
if (RT_SUCCESS(rc))
if (RT_SUCCESS(rc))
/* Ok, so now we know what message type and how much parameters there are. */
}
return rc;
}
/**
* Asks the host guest control service to set a command filter to this
* client so that it only will receive certain commands in the future.
* The filter(s) are a bitmask for the context IDs, served from the host.
*
* @return IPRT status code.
* @param uClientId The client ID returned by VbglR3GuestCtrlConnect().
* @param uValue The value to filter messages for.
* @param uMaskAdd Filter mask to add.
* @param uMaskRemove Filter mask to remove.
*/
{
if (RT_SUCCESS(rc))
return rc;
}
/**
* Disables a previously set message filter.
*
* @return IPRT status code.
* @param uClientId The client ID returned by VbglR3GuestCtrlConnect().
*/
{
if (RT_SUCCESS(rc))
return rc;
}
/**
* Tells the host service to skip the current message returned by
* VbglR3GuestCtrlMsgWaitFor().
*
* @return IPRT status code.
* @param uClientId The client ID returned by VbglR3GuestCtrlConnect().
*/
{
the current assigned command. */
if (RT_SUCCESS(rc))
return rc;
}
/**
* Asks the host to cancel (release) all pending waits which were deferred.
*
* @returns VBox status code.
* @param uClientId The client ID returned by VbglR3GuestCtrlConnect().
*/
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
/**
* Retrieves the request to create a new guest session.
*
* @return IPRT status code.
* @param pCtx Host context.
** @todo Docs!
*/
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
if (puSessionID)
}
}
return rc;
}
/**
* Retrieves the request to terminate an existing guest session.
*
* @return IPRT status code.
* @param pCtx Host context.
** @todo Docs!
*/
VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puFlags, uint32_t *puSessionID)
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
if (puSessionID)
}
}
return rc;
}
/**
* Allocates and gets host data, based on the message id.
*
* This will block until data becomes available.
*
* @returns VBox status code.
** @todo Docs!
** @todo Move the parameters in an own struct!
*/
{
{
}
else
{
}
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
{
}
else
{
}
}
}
return rc;
}
/**
* Allocates and gets host data, based on the message id.
*
* This will block until data becomes available.
*
* @returns VBox status code.
** @todo Docs!
*/
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
/**
* Retrieves the input data from host which then gets sent to the
* started process.
*
* This will block until data becomes available.
*
* @returns VBox status code.
** @todo Docs!
*/
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
{
}
else
{
}
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
/**
* Callback for reporting a guest process status (along with some other stuff) to the host.
*
* @returns VBox status code.
** @todo Docs!
*/
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
/**
*
* @returns VBox status code.
** @todo Docs!
*/
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}
/**
* Callback for reporting back the input status of a guest process to the host.
*
* @returns VBox status code.
** @todo Docs!
*/
{
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc2))
}
return rc;
}