QofSession Struct Reference

Public Member Functions
	QofSessionImpl (QofBook *book=nullptr) noexcept
void	begin (const char *new_uri, SessionOpenMode mode) noexcept
	Begin this session. More...
void	swap_books (QofSessionImpl &) noexcept
	Swap books with another session.
void	ensure_all_data_loaded () noexcept
void	load (QofPercentageFunc) noexcept
void	save (QofPercentageFunc) noexcept
void	safe_save (QofPercentageFunc) noexcept
bool	save_in_progress () const noexcept
bool	export_session (QofSessionImpl &real_session, QofPercentageFunc) noexcept
bool	events_pending () const noexcept
bool	process_events () const noexcept
void	clear_error () noexcept
QofBackendError	pop_error () noexcept
std::string const &	get_uri () const noexcept
	We return by reference so that a pointer to the data of the string lives long enough to make it back to C code.
QofBackendError	get_error () noexcept
	Returns and clears the local cached error. More...
const std::string &	get_error_message () const noexcept
QofBook *	get_book () const noexcept
QofBackend *	get_backend () const noexcept
const std::string &	get_file_path () const noexcept
bool	is_saving () const noexcept
void	end () noexcept
	Terminates the current backend.
void	destroy_backend () noexcept

Friends
void	qof_session_load_backend (QofSession *, const char *)
char const *	qof_session_get_uri (QofSession *)
void	qof_session_set_uri (QofSession *, char const *)

Detailed Description

Definition at line 37 of file qofsession.hpp.

Member Function Documentation

begin()

void QofSession::begin ( const char *  new_uri, SessionOpenMode  mode  )

noexcept

Begin this session.

Definition at line 251 of file qofsession.cpp.

{


    ENTER (" sess=%p mode=%d, URI=%s", this, mode, new_uri);
    clear_error ();
    /* Check to see if this session is already open */
    if (m_uri.size ())
    {
        if (ERR_BACKEND_NO_ERR != get_error ())
            push_error (ERR_BACKEND_LOCKED, {});
        LEAVE("push error book is already open ");
        return;
    }

    /* seriously invalid */
    if (!new_uri)
    {
        if (ERR_BACKEND_NO_ERR != get_error ())
            push_error (ERR_BACKEND_BAD_URL, {});
        LEAVE("push error missing new_uri");
        return;
    }

    char * scheme {g_uri_parse_scheme (new_uri)};
    char * filename {nullptr};
    if (g_strcmp0 (scheme, "file") == 0)
        filename = gnc_uri_get_path(new_uri);
    else if (!scheme)
        filename = g_strdup (new_uri);

    if (filename && g_file_test (filename, G_FILE_TEST_IS_DIR))
    {
        if (ERR_BACKEND_NO_ERR == get_error ())
            push_error (ERR_BACKEND_BAD_URL, {});
        g_free (filename);
        g_free (scheme);
        LEAVE("Can't open a directory");
        return;
    }
    /* destroy the old backend */
    destroy_backend ();
    /* Store the session URL  */
    m_uri = new_uri;
    m_creating = mode == SESSION_NEW_STORE || mode == SESSION_NEW_OVERWRITE;
    if (filename)
        load_backend ("file");
    else                       /* access method found, load appropriate backend */
        load_backend (scheme);
    g_free (filename);
    g_free (scheme);

    /* No backend was found. That's bad. */
    if (m_backend == nullptr)
    {
        m_uri = {};
        if (ERR_BACKEND_NO_ERR == get_error ())
            push_error (ERR_BACKEND_BAD_URL, {});
        LEAVE (" BAD: no backend: sess=%p book-id=%s",
               this,  new_uri);
        return;
    }

    /* If there's a begin method, call that. */
    m_backend->session_begin(this, m_uri.c_str(), mode);
    PINFO ("Done running session_begin on backend");
    QofBackendError const err {m_backend->get_error()};
    auto msg (m_backend->get_message());
    if (err != ERR_BACKEND_NO_ERR)
    {
        m_uri = {};
        push_error (err, msg);
        LEAVE (" backend error %d %s", err, msg.empty() ? "(null)" : msg.c_str());
        return;
    }
    if (!msg.empty())
    {
        PWARN("%s", msg.c_str());
    }

    LEAVE (" sess=%p book-id=%s", this,  new_uri);
}

get_error()

QofBackendError QofSession::get_error ( )

noexcept

Returns and clears the local cached error.

If there is no local error, we check for an error in the backend.

Definition at line 372 of file qofsession.cpp.

{
    /* if we have a local error, return that. */
    if (m_last_err != ERR_BACKEND_NO_ERR)
        return m_last_err;
    auto qof_be = qof_book_get_backend (m_book);
    if (qof_be == nullptr) return ERR_BACKEND_NO_ERR;

    m_last_err = qof_be->get_error();
    return m_last_err;
}

---

The documentation for this struct was generated from the following files:

• qofsession.hpp
• qofsession.cpp