/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#ifndef _OD_ASYNC_OPEN_FILE_REQUEST__INCLUDED_
#define _OD_ASYNC_OPEN_FILE_REQUEST__INCLUDED_

#include "OdAsyncBaseRequest.h"

#include "TD_PackPush.h"

/**
  <group OdAsyncIO_Classes>
  \details
  This class is a special data structure to represent open file request.
*/
class OdAsyncOpenFileRequest : public OdAsyncBaseRequest
{
public:

  /** \details
    Constructor for the OdAsyncOpenFileRequest class.
  */
  OdAsyncOpenFileRequest()
    : m_accessMode(Oda::kFileRead), m_shareMode(Oda::kShareDenyNo), m_creationDisposition(Oda::kOpenExisting)
  {
  }
  
  /** File name to open.*/
  OdString                     m_filename;

  /** File access mode.*/
  Oda::FileAccessMode          m_accessMode;

  /** File share mode.*/
  Oda::FileShareMode           m_shareMode;

  /** File creation disposition.*/
  Oda::FileCreationDisposition m_creationDisposition;

  /** Pointer to pre-opened file stream that user should set if open request performed only to get a file descriptor for async I/O operations.*/
  OdStreamBufPtr               m_pFileStream;
};

#include "TD_PackPop.h"

#endif