mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-13 18:27:35 +00:00
12ca859e67
Differential Revision: https://phabricator.services.mozilla.com/D69127 --HG-- extra : moz-landing-system : lando
102 lines
2.9 KiB
C++
102 lines
2.9 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
* vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_storage_mozStorageAsyncStatement_h_
|
|
#define mozilla_storage_mozStorageAsyncStatement_h_
|
|
|
|
#include "nsString.h"
|
|
|
|
#include "nsTArray.h"
|
|
|
|
#include "mozStorageBindingParamsArray.h"
|
|
#include "mozStorageStatementData.h"
|
|
#include "mozIStorageAsyncStatement.h"
|
|
#include "StorageBaseStatementInternal.h"
|
|
#include "mozilla/Attributes.h"
|
|
|
|
namespace mozilla {
|
|
namespace storage {
|
|
|
|
class AsyncStatementJSHelper;
|
|
class AsyncStatementParamsHolder;
|
|
class Connection;
|
|
|
|
class AsyncStatement final : public mozIStorageAsyncStatement,
|
|
public StorageBaseStatementInternal {
|
|
public:
|
|
NS_DECL_THREADSAFE_ISUPPORTS
|
|
NS_DECL_MOZISTORAGEASYNCSTATEMENT
|
|
NS_DECL_MOZISTORAGEBASESTATEMENT
|
|
NS_DECL_MOZISTORAGEBINDINGPARAMS
|
|
NS_DECL_STORAGEBASESTATEMENTINTERNAL
|
|
|
|
AsyncStatement();
|
|
|
|
/**
|
|
* Initializes the object on aDBConnection by preparing the SQL statement
|
|
* given by aSQLStatement.
|
|
*
|
|
* @param aDBConnection
|
|
* The Connection object this statement is associated with.
|
|
* @param aNativeConnection
|
|
* The native Sqlite connection this statement is associated with.
|
|
* @param aSQLStatement
|
|
* The SQL statement to prepare that this object will represent.
|
|
*/
|
|
nsresult initialize(Connection* aDBConnection, sqlite3* aNativeConnection,
|
|
const nsACString& aSQLStatement);
|
|
|
|
/**
|
|
* Obtains and transfers ownership of the array of parameters that are bound
|
|
* to this statment. This can be null.
|
|
*/
|
|
inline already_AddRefed<BindingParamsArray> bindingParamsArray() {
|
|
return mParamsArray.forget();
|
|
}
|
|
|
|
private:
|
|
~AsyncStatement();
|
|
|
|
/**
|
|
* @return a pointer to the BindingParams object to use with our Bind*
|
|
* method.
|
|
*/
|
|
mozIStorageBindingParams* getParams();
|
|
|
|
/**
|
|
* The SQL string as passed by the user. We store it because we create the
|
|
* async statement on-demand on the async thread.
|
|
*/
|
|
nsCString mSQLString;
|
|
|
|
/**
|
|
* Holds the array of parameters to bind to this statement when we execute
|
|
* it asynchronously.
|
|
*/
|
|
RefPtr<BindingParamsArray> mParamsArray;
|
|
|
|
/**
|
|
* Caches the JS 'params' helper for this statement.
|
|
*/
|
|
nsMainThreadPtrHandle<AsyncStatementParamsHolder> mStatementParamsHolder;
|
|
|
|
/**
|
|
* Have we been explicitly finalized by the user?
|
|
*/
|
|
bool mFinalized;
|
|
|
|
/**
|
|
* Required for access to private mStatementParamsHolder field by
|
|
* AsyncStatementJSHelper::getParams.
|
|
*/
|
|
friend class AsyncStatementJSHelper;
|
|
};
|
|
|
|
} // namespace storage
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_storage_mozStorageAsyncStatement_h_
|