USBProxyService.h revision 0c04bf3d366953a24840080b5f7be34d9406a7dc
/** @file
*
* VBox frontends: Basic Frontend (BFE):
* Declaration of USBProxyService and USBProxyServiceLinux classes
*/
/*
* Copyright (C) 2006-2007 innotek GmbH
*
* 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 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.
*
* If you received this file as part of a commercial VirtualBox
* distribution, then only the terms of your commercial VirtualBox
* license agreement apply instead of the previous paragraph.
*/
#ifndef ____H_USBPROXYSERVICE
#define ____H_USBPROXYSERVICE
#ifndef VBOXBFE_WITH_USB
# error "misconfiguration VBOXBFE_WITH_USB isn't defined and USBProxyService.h was included."
#endif
#include "HostUSBImpl.h"
#include "HostUSBDeviceImpl.h"
/**
* Base class for the USB Proxy service.
*/
{
/**
* A VM is trying to capture a device, do necessary preperations.
*
* @returns VBox status code.
* @param pDevice The device in question.
*/
/**
* The device is to be held so that the host OS will not start using it.
*
* @returns VBox status code.
* @param pDevice The device in question.
*/
/**
* A VM is releasing a device back to the host.
*
* @returns VBox status code.
* @param pDevice The device in question.
*/
/**
* A VM is releasing a device back to be held or assigned to another VM.
* A port reset should be performed.
*
* @returns VBox status code.
* @param pDevice The device in question.
*/
/**
* Query if the service is active and working.
*
* @returns true if the service is up running.
* @returns false if the service isn't running.
*/
bool isActive (void);
/**
* Get last error.
* Can be used to check why the proxy !isActive() upon construction.
*
* @returns VBox status code.
*/
int getLastError (void);
/**
* Calculate the hash of the serial string.
*
* 64bit FNV1a, chosen because it is designed to hash in to a power of two
* space, and is much quicker and simpler than, say, a half MD4.
*
* @returns the hash.
* @param aSerial The serial string.
*/
/**
* Starts the service.
*
* @returns VBox status.
*/
int start (void);
/**
* Stops the service.
*
* @returns VBox status.
*/
int stop (void);
/**
* Wait for a change in the USB devices attached to the host.
*
* @returns VBox status (ignored).
* @param aMillies Number of milliseconds to wait.
*/
/**
* Interrupt any wait() call in progress.
*
* @returns VBox status.
*/
virtual int interruptWait (void);
/**
* Get a list of USB device currently attached to the host.
*
* @returns Pointer to a list of USB devices.
* The list nodes are freed individually by calling freeDevice().
*/
/**
* Free one USB device returned by getDevice().
*
* @param pDevice Pointer to the device.
*/
/**
* Process any relevant changes in the attached USB devices.
*/
void processChanges (void);
/**
* The service thread created by start().
*
* @param Thread The thread handle.
* @param pvUser Pointer to the USBProxyService instance.
*/
/** Pointer to the HostUSB object. */
/** Thread handle of the service thread. */
/** Flag which stop() sets to cause serviceThread to return. */
bool volatile mTerminate;
/** List of smart HostUSBDevice pointers. */
/** List of the known USB devices. */
/** VBox status code of the last failure.
* (Only used by start(), stop() and the child constructors.) */
int mLastError;
};
#if defined(RT_OS_LINUX) || defined(__L4__)
#include <stdio.h>
/**
* The Linux hosted USB Proxy Service.
*/
{
virtual int interruptWait (void);
/** Stream for mFile. */
/** Pipe used to interrupt wait(), the read end. */
/** Pipe used to interrupt wait(), the write end. */
/** The root of usbfs. */
};
#endif /* RT_OS_LINUX */
#ifdef RT_OS_WINDOWS
/**
*/
{
virtual int interruptWait (void);
};
#endif
#endif /* !____H_USBPROXYSERVICE */