aiomgr.h revision 527eff46676ca64c098dc7d1bf0857408c3a6f82
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * IPRT - Async I/O manager.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Copyright (C) 2013 Oracle Corporation
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * available from http://www.virtualbox.org. This file is free software;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * you can redistribute it and/or modify it under the terms of the GNU
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * General Public License (GPL) as published by the Free Software
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * The contents of this file may alternatively be used under the terms
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * of the Common Development and Distribution License Version 1.0
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * VirtualBox OSE distribution, in which case the provisions of the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * CDDL are applicable instead of those of the GPL.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * You may elect to license modified versions of this file under the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * terms and conditions of either the GPL or the CDDL or both.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Completion callback.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns nothing.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param hAioMgrFile File handle the completed request was for.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param rcReq Status code of the completed request.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pvUser Opaque user data given when the request was initiated.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsynctypedef DECLCALLBACK(void) FNRTAIOMGRREQCOMPLETE(RTAIOMGRFILE hAioMgrFile, int rcReq, void *pvUser);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/** Pointer to a completion callback. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsynctypedef FNRTAIOMGRREQCOMPLETE *PFNRTAIOMGRREQCOMPLETE;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Create a new async I/O manager.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns IPRT statuse code.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param phAioMgr Where to store the new async I/O manager handle on success.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param cReqsMax Maximum number of async I/O requests expected.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Use UINT32_MAX to make it grow dynamically when required.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncRTDECL(int) RTAioMgrCreate(PRTAIOMGR phAioMgr, uint32_t cReqsMax);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Retain a async I/O manager handle.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns New reference count on success, UINT32_MAX on failure.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param hAioMgr The async I/O manager to retain.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Releases a async I/O manager handle.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param hAioMgr The async I/O manager to release.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Assign a given file handle to the given async I/O manager.