/*

    File:       DataQueueUserClient.h

    Author:     MK

    Copyright:  © Copyright 2001 Apple Computer, Inc. All rights reserved.

    Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple Computer, Inc.

                        ("Apple") in consideration of your agreement to the following terms, and your

                        use, installation, modification or redistribution of this Apple software

                        constitutes acceptance of these terms.  If you do not agree with these terms,

                        please do not use, install, modify or redistribute this Apple software.

                        In consideration of your agreement to abide by the following terms, and subject

                        to these terms, Apple grants you a personal, non-exclusive license, under AppleÕs

                        copyrights in this original Apple software (the "Apple Software"), to use,

                        reproduce, modify and redistribute the Apple Software, with or without

                        modifications, in source and/or binary forms; provided that if you redistribute

                        the Apple Software in its entirety and without modifications, you must retain

                        this notice and the following text and disclaimers in all such redistributions of

                        the Apple Software.  Neither the name, trademarks, service marks or logos of

                        Apple Computer, Inc. may be used to endorse or promote products derived from the

                        Apple Software without specific prior written permission from Apple.  Except as

                        expressly stated in this notice, no other rights or licenses, express or implied,

                        are granted by Apple herein, including but not limited to any patent rights that

                        may be infringed by your derivative works or by other works in which the Apple

                        Software may be incorporated.

                        The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO

                        WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED

                        WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR

                        PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN

                        COMBINATION WITH YOUR PRODUCTS.

                        IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR

                        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE

                        GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

                        ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION

                        OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT

                        (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN

                        ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    Change History (most recent first):

                1.0d1

*/

#include <IOKit/IOService.h>

#include <IOKit/IOUserClient.h>

#include <IOKit/IOTimerEventSource.h>

#include <IOKit/IODataQueue.h>

class com_apple_dts_SimpleDataQueue;

class com_apple_dts_DataQueueUserClient : public IOUserClient

{

    OSDeclareDefaultStructors(com_apple_dts_DataQueueUserClient)

 private:

    task_t              fTask;

    com_apple_dts_SimpleDataQueue   *fProvider;

    IODataQueue             *fDataQueue;

    IOMemoryDescriptor          *fMemoryToShare;

    IOWorkLoop              *myWorkLoop;

    IOTimerEventSource          *myTimer;

public:

    static void myTimeoutHandler(OSObject *owner, IOTimerEventSource *sender);

    bool myAddTimerToWorkLoop();

    void myRemoveTimerFromWorkLoop();

    // IOKit methods

    virtual bool initWithTask(task_t owningTask, void *security_id, UInt32 type);

    virtual void stop(IOService * provider);

    virtual bool start( IOService * provider );

    virtual IOReturn message( UInt32 type, IOService * provider,  void * argument = 0 );

    virtual IOReturn registerNotificationPort( mach_port_t, UInt32, UInt32 );

    virtual IOReturn clientMemoryForType( UInt32 type, IOOptionBits * options, IOMemoryDescriptor ** memory );

    virtual bool finalize(IOOptionBits options);

    virtual IOReturn clientClose( void );

    virtual IOReturn clientDied( void );

    virtual bool terminate( IOOptionBits options = 0 );

};